From 18c5a534ccb215bbdc27951c0962fd284bce51ed Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 4 May 2026 12:54:33 +0000 Subject: [PATCH] chore: update API specs and SDK examples --- .../examples/storage/create-file.md | 2 +- .../account/create-anonymous-session.md | 2 +- .../account/create-email-password-session.md | 2 +- .../examples/account/create-email-token.md | 2 +- .../account/create-email-verification.md | 2 +- .../examples/account/create-jwt.md | 2 +- .../account/create-magic-url-token.md | 2 +- .../account/create-mfa-authenticator.md | 2 +- .../examples/account/create-mfa-challenge.md | 2 +- .../account/create-mfa-recovery-codes.md | 2 +- .../account/create-o-auth-2-session.md | 2 +- .../examples/account/create-o-auth-2-token.md | 2 +- .../examples/account/create-phone-token.md | 2 +- .../account/create-phone-verification.md | 2 +- .../examples/account/create-push-target.md | 2 +- .../examples/account/create-recovery.md | 2 +- .../examples/account/create-session.md | 2 +- .../examples/account/create-verification.md | 2 +- .../client-rest/examples/account/create.md | 2 +- .../examples/account/delete-identity.md | 2 +- .../account/delete-mfa-authenticator.md | 2 +- .../examples/account/delete-push-target.md | 2 +- .../examples/account/delete-session.md | 2 +- .../examples/account/delete-sessions.md | 2 +- .../account/get-mfa-recovery-codes.md | 2 +- .../client-rest/examples/account/get-prefs.md | 2 +- .../examples/account/get-session.md | 2 +- .../1.9.x/client-rest/examples/account/get.md | 2 +- .../examples/account/list-identities.md | 2 +- .../client-rest/examples/account/list-logs.md | 2 +- .../examples/account/list-mfa-factors.md | 2 +- .../examples/account/list-sessions.md | 2 +- .../account/update-email-verification.md | 2 +- .../examples/account/update-email.md | 2 +- .../account/update-magic-url-session.md | 2 +- .../account/update-mfa-authenticator.md | 2 +- .../examples/account/update-mfa-challenge.md | 2 +- .../account/update-mfa-recovery-codes.md | 2 +- .../examples/account/update-mfa.md | 2 +- .../examples/account/update-name.md | 2 +- .../examples/account/update-password.md | 2 +- .../examples/account/update-phone-session.md | 2 +- .../account/update-phone-verification.md | 2 +- .../examples/account/update-phone.md | 2 +- .../examples/account/update-prefs.md | 2 +- .../examples/account/update-push-target.md | 2 +- .../examples/account/update-recovery.md | 2 +- .../examples/account/update-session.md | 2 +- .../examples/account/update-status.md | 2 +- .../examples/account/update-verification.md | 2 +- .../examples/avatars/get-browser.md | 2 +- .../examples/avatars/get-credit-card.md | 2 +- .../examples/avatars/get-favicon.md | 2 +- .../client-rest/examples/avatars/get-flag.md | 2 +- .../client-rest/examples/avatars/get-image.md | 2 +- .../examples/avatars/get-initials.md | 2 +- .../client-rest/examples/avatars/get-qr.md | 2 +- .../examples/avatars/get-screenshot.md | 2 +- .../examples/databases/create-document.md | 2 +- .../examples/databases/create-operations.md | 2 +- .../examples/databases/create-transaction.md | 2 +- .../databases/decrement-document-attribute.md | 2 +- .../examples/databases/delete-document.md | 2 +- .../examples/databases/delete-transaction.md | 2 +- .../examples/databases/get-document.md | 2 +- .../examples/databases/get-transaction.md | 2 +- .../databases/increment-document-attribute.md | 2 +- .../examples/databases/list-documents.md | 2 +- .../examples/databases/list-transactions.md | 2 +- .../examples/databases/update-document.md | 2 +- .../examples/databases/update-transaction.md | 2 +- .../examples/databases/upsert-document.md | 2 +- .../examples/functions/create-execution.md | 2 +- .../examples/functions/get-execution.md | 2 +- .../examples/functions/list-executions.md | 2 +- .../client-rest/examples/graphql/mutation.md | 2 +- .../client-rest/examples/graphql/query.md | 2 +- .../1.9.x/client-rest/examples/locale/get.md | 2 +- .../client-rest/examples/locale/list-codes.md | 2 +- .../examples/locale/list-continents.md | 2 +- .../examples/locale/list-countries-eu.md | 2 +- .../examples/locale/list-countries-phones.md | 2 +- .../examples/locale/list-countries.md | 2 +- .../examples/locale/list-currencies.md | 2 +- .../examples/locale/list-languages.md | 2 +- .../examples/messaging/create-subscriber.md | 2 +- .../examples/messaging/delete-subscriber.md | 2 +- .../examples/storage/create-file.md | 2 +- .../examples/storage/delete-file.md | 2 +- .../examples/storage/get-file-download.md | 2 +- .../examples/storage/get-file-preview.md | 2 +- .../examples/storage/get-file-view.md | 2 +- .../client-rest/examples/storage/get-file.md | 2 +- .../examples/storage/list-files.md | 2 +- .../examples/storage/update-file.md | 2 +- .../examples/tablesdb/create-operations.md | 2 +- .../examples/tablesdb/create-row.md | 2 +- .../examples/tablesdb/create-transaction.md | 2 +- .../examples/tablesdb/decrement-row-column.md | 2 +- .../examples/tablesdb/delete-row.md | 2 +- .../examples/tablesdb/delete-transaction.md | 2 +- .../client-rest/examples/tablesdb/get-row.md | 2 +- .../examples/tablesdb/get-transaction.md | 2 +- .../examples/tablesdb/increment-row-column.md | 2 +- .../examples/tablesdb/list-rows.md | 2 +- .../examples/tablesdb/list-transactions.md | 2 +- .../examples/tablesdb/update-row.md | 2 +- .../examples/tablesdb/update-transaction.md | 2 +- .../examples/tablesdb/upsert-row.md | 2 +- .../examples/teams/create-membership.md | 2 +- .../client-rest/examples/teams/create.md | 2 +- .../examples/teams/delete-membership.md | 2 +- .../client-rest/examples/teams/delete.md | 2 +- .../examples/teams/get-membership.md | 2 +- .../client-rest/examples/teams/get-prefs.md | 2 +- .../1.9.x/client-rest/examples/teams/get.md | 2 +- .../examples/teams/list-memberships.md | 2 +- .../1.9.x/client-rest/examples/teams/list.md | 2 +- .../teams/update-membership-status.md | 2 +- .../examples/teams/update-membership.md | 2 +- .../client-rest/examples/teams/update-name.md | 2 +- .../examples/teams/update-prefs.md | 2 +- .../examples/account/list-identities.md | 3 +- .../console-cli/examples/account/list-logs.md | 3 +- .../examples/backups/list-archives.md | 3 +- .../examples/backups/list-policies.md | 3 +- .../examples/backups/list-restorations.md | 3 +- .../examples/databases/delete-documents.md | 3 +- .../examples/databases/list-attributes.md | 3 +- .../databases/list-collection-logs.md | 3 +- .../examples/databases/list-collections.md | 3 +- .../examples/databases/list-document-logs.md | 3 +- .../examples/databases/list-documents.md | 3 +- .../examples/databases/list-indexes.md | 3 +- .../examples/databases/list-logs.md | 3 +- .../examples/databases/list-transactions.md | 3 +- .../console-cli/examples/databases/list.md | 3 +- .../examples/databases/update-documents.md | 3 +- .../examples/functions/list-deployments.md | 3 +- .../examples/functions/list-executions.md | 3 +- .../console-cli/examples/functions/list.md | 3 +- .../examples/manager/create-block.md | 5 + .../examples/manager/delete-block.md | 5 + .../examples/manager/list-blocks.md | 4 + .../examples/manager/update-user-status.md | 4 + .../examples/messaging/list-message-logs.md | 3 +- .../examples/messaging/list-messages.md | 3 +- .../examples/messaging/list-provider-logs.md | 3 +- .../examples/messaging/list-providers.md | 3 +- .../messaging/list-subscriber-logs.md | 3 +- .../examples/messaging/list-subscribers.md | 3 +- .../examples/messaging/list-targets.md | 3 +- .../examples/messaging/list-topic-logs.md | 3 +- .../examples/messaging/list-topics.md | 3 +- .../examples/migrations/create-csv-export.md | 3 +- .../examples/migrations/create-json-export.md | 3 +- .../console-cli/examples/migrations/list.md | 3 +- .../organizations/create-plan-estimation.md | 5 + .../organizations/list-aggregations.md | 3 +- .../examples/organizations/list-credits.md | 3 +- .../examples/organizations/list.md | 3 +- .../examples/project/create-ephemeral-key.md | 5 + .../examples/project/create-mock-phone.md | 5 + .../examples/project/delete-mock-phone.md | 4 + .../console-cli/examples/project/delete.md | 3 + .../examples/project/get-mock-phone.md | 4 + .../examples/project/get-o-auth-2-provider.md | 4 + .../examples/project/get-policy.md | 4 + .../examples/project/list-email-templates.md | 4 + .../console-cli/examples/project/list-keys.md | 3 +- .../examples/project/list-mock-phones.md | 4 + .../project/list-o-auth-2-providers.md | 3 + .../examples/project/list-platforms.md | 3 +- .../examples/project/list-policies.md | 4 + .../examples/project/list-variables.md | 3 +- .../examples/project/update-auth-method.md | 5 + .../examples/project/update-mock-phone.md | 5 + .../project/update-o-auth-2-amazon.md | 3 + .../examples/project/update-o-auth-2-apple.md | 3 + .../project/update-o-auth-2-auth-0.md | 3 + .../project/update-o-auth-2-authentik.md | 3 + .../project/update-o-auth-2-autodesk.md | 3 + .../project/update-o-auth-2-bitbucket.md | 3 + .../examples/project/update-o-auth-2-bitly.md | 3 + .../examples/project/update-o-auth-2-box.md | 3 + .../project/update-o-auth-2-dailymotion.md | 3 + .../project/update-o-auth-2-discord.md | 3 + .../project/update-o-auth-2-disqus.md | 3 + .../project/update-o-auth-2-dropbox.md | 3 + .../examples/project/update-o-auth-2-etsy.md | 3 + .../project/update-o-auth-2-facebook.md | 3 + .../examples/project/update-o-auth-2-figma.md | 3 + .../project/update-o-auth-2-fusion-auth.md | 3 + .../project/update-o-auth-2-git-hub.md | 3 + .../project/update-o-auth-2-gitlab.md | 3 + .../project/update-o-auth-2-google.md | 3 + .../project/update-o-auth-2-keycloak.md | 3 + .../examples/project/update-o-auth-2-kick.md | 3 + .../project/update-o-auth-2-linkedin.md | 3 + .../project/update-o-auth-2-microsoft.md | 3 + .../project/update-o-auth-2-notion.md | 3 + .../examples/project/update-o-auth-2-oidc.md | 3 + .../examples/project/update-o-auth-2-okta.md | 3 + .../project/update-o-auth-2-paypal-sandbox.md | 3 + .../project/update-o-auth-2-paypal.md | 3 + .../examples/project/update-o-auth-2-podio.md | 3 + .../project/update-o-auth-2-salesforce.md | 3 + .../examples/project/update-o-auth-2-slack.md | 3 + .../project/update-o-auth-2-spotify.md | 3 + .../project/update-o-auth-2-stripe.md | 3 + .../update-o-auth-2-tradeshift-sandbox.md | 3 + .../project/update-o-auth-2-tradeshift.md | 3 + .../project/update-o-auth-2-twitch.md | 3 + .../project/update-o-auth-2-word-press.md | 3 + .../examples/project/update-o-auth-2-yahoo.md | 3 + .../project/update-o-auth-2-yandex.md | 3 + .../examples/project/update-o-auth-2-zoho.md | 3 + .../examples/project/update-o-auth-2-zoom.md | 3 + .../examples/project/update-o-auth-2x.md | 3 + .../examples/projects/list-dev-keys.md | 3 +- .../examples/projects/list-schedules.md | 3 +- .../console-cli/examples/projects/list.md | 3 +- .../console-cli/examples/proxy/list-rules.md | 3 +- .../examples/sites/list-deployments.md | 3 +- .../console-cli/examples/sites/list-logs.md | 3 +- .../1.9.x/console-cli/examples/sites/list.md | 3 +- .../examples/storage/list-buckets.md | 3 +- .../examples/storage/list-files.md | 3 +- .../examples/tablesdb/delete-rows.md | 3 +- .../examples/tablesdb/list-columns.md | 3 +- .../examples/tablesdb/list-indexes.md | 3 +- .../examples/tablesdb/list-row-logs.md | 3 +- .../examples/tablesdb/list-rows.md | 3 +- .../examples/tablesdb/list-table-logs.md | 3 +- .../examples/tablesdb/list-tables.md | 3 +- .../examples/tablesdb/list-transactions.md | 3 +- .../console-cli/examples/tablesdb/list.md | 3 +- .../examples/tablesdb/update-rows.md | 3 +- .../console-cli/examples/teams/list-logs.md | 3 +- .../examples/teams/list-memberships.md | 3 +- .../1.9.x/console-cli/examples/teams/list.md | 3 +- .../1.9.x/console-cli/examples/tokens/list.md | 3 +- .../examples/users/list-identities.md | 3 +- .../console-cli/examples/users/list-logs.md | 3 +- .../examples/users/list-memberships.md | 3 +- .../examples/users/list-targets.md | 3 +- .../1.9.x/console-cli/examples/users/list.md | 3 +- .../examples/vcs/list-installations.md | 3 +- .../examples/vcs/list-repositories.md | 3 +- .../console-cli/examples/webhooks/list.md | 3 +- .../console/list-o-auth-2-providers.md | 13 + .../examples/console/list-project-scopes.md | 13 + .../examples/domains/update-purchase.md | 2 +- .../examples/domains/update-transfer-in.md | 2 +- .../console-web/examples/functions/create.md | 2 +- .../console-web/examples/functions/update.md | 2 +- .../examples/manager/create-block.md | 18 + .../examples/manager/delete-block.md | 16 + .../examples/manager/list-blocks.md | 14 + .../examples/manager/update-user-status.md | 17 + .../organizations/create-plan-estimation.md | 18 + .../examples/project/create-ephemeral-key.md | 16 + .../examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 16 + .../examples/project/delete-mock-phone.md | 15 + .../console-web/examples/project/delete.md | 13 + .../examples/project/get-mock-phone.md | 15 + .../examples/project/get-o-auth-2-provider.md | 15 + .../examples/project/get-policy.md | 15 + .../examples/project/list-email-templates.md | 16 + .../examples/project/list-mock-phones.md | 16 + .../project/list-o-auth-2-providers.md | 13 + .../examples/project/list-policies.md | 16 + .../examples/project/update-auth-method.md | 16 + .../examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 16 + .../project/update-o-auth-2-amazon.md | 17 + .../examples/project/update-o-auth-2-apple.md | 19 + .../project/update-o-auth-2-auth-0.md | 18 + .../project/update-o-auth-2-authentik.md | 18 + .../project/update-o-auth-2-autodesk.md | 17 + .../project/update-o-auth-2-bitbucket.md | 17 + .../examples/project/update-o-auth-2-bitly.md | 17 + .../examples/project/update-o-auth-2-box.md | 17 + .../project/update-o-auth-2-dailymotion.md | 17 + .../project/update-o-auth-2-discord.md | 17 + .../project/update-o-auth-2-disqus.md | 17 + .../project/update-o-auth-2-dropbox.md | 17 + .../examples/project/update-o-auth-2-etsy.md | 17 + .../project/update-o-auth-2-facebook.md | 17 + .../examples/project/update-o-auth-2-figma.md | 17 + .../project/update-o-auth-2-fusion-auth.md | 18 + .../project/update-o-auth-2-git-hub.md | 17 + .../project/update-o-auth-2-gitlab.md | 18 + .../project/update-o-auth-2-google.md | 17 + .../project/update-o-auth-2-keycloak.md | 19 + .../examples/project/update-o-auth-2-kick.md | 17 + .../project/update-o-auth-2-linkedin.md | 17 + .../project/update-o-auth-2-microsoft.md | 18 + .../project/update-o-auth-2-notion.md | 17 + .../examples/project/update-o-auth-2-oidc.md | 21 + .../examples/project/update-o-auth-2-okta.md | 19 + .../project/update-o-auth-2-paypal-sandbox.md | 17 + .../project/update-o-auth-2-paypal.md | 17 + .../examples/project/update-o-auth-2-podio.md | 17 + .../project/update-o-auth-2-salesforce.md | 17 + .../examples/project/update-o-auth-2-slack.md | 17 + .../project/update-o-auth-2-spotify.md | 17 + .../project/update-o-auth-2-stripe.md | 17 + .../update-o-auth-2-tradeshift-sandbox.md | 17 + .../project/update-o-auth-2-tradeshift.md | 17 + .../project/update-o-auth-2-twitch.md | 17 + .../project/update-o-auth-2-word-press.md | 17 + .../examples/project/update-o-auth-2-yahoo.md | 17 + .../project/update-o-auth-2-yandex.md | 17 + .../examples/project/update-o-auth-2-zoho.md | 17 + .../examples/project/update-o-auth-2-zoom.md | 17 + .../examples/project/update-o-auth-2x.md | 17 + .../server-dart/examples/functions/create.md | 2 +- .../server-dart/examples/functions/update.md | 2 +- .../examples/project/create-ephemeral-key.md | 16 + .../examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 15 + .../examples/project/delete-mock-phone.md | 14 + .../server-dart/examples/project/delete.md | 12 + .../examples/project/get-mock-phone.md | 14 + .../examples/project/get-o-auth-2-provider.md | 14 + .../examples/project/get-policy.md | 15 + .../examples/project/list-email-templates.md | 15 + .../examples/project/list-mock-phones.md | 15 + .../project/list-o-auth-2-providers.md | 12 + .../examples/project/list-policies.md | 15 + .../examples/project/update-auth-method.md | 16 + .../examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 15 + .../project/update-o-auth-2-amazon.md | 16 + .../examples/project/update-o-auth-2-apple.md | 18 + .../project/update-o-auth-2-auth-0.md | 17 + .../project/update-o-auth-2-authentik.md | 17 + .../project/update-o-auth-2-autodesk.md | 16 + .../project/update-o-auth-2-bitbucket.md | 16 + .../examples/project/update-o-auth-2-bitly.md | 16 + .../examples/project/update-o-auth-2-box.md | 16 + .../project/update-o-auth-2-dailymotion.md | 16 + .../project/update-o-auth-2-discord.md | 16 + .../project/update-o-auth-2-disqus.md | 16 + .../project/update-o-auth-2-dropbox.md | 16 + .../examples/project/update-o-auth-2-etsy.md | 16 + .../project/update-o-auth-2-facebook.md | 16 + .../examples/project/update-o-auth-2-figma.md | 16 + .../project/update-o-auth-2-fusion-auth.md | 17 + .../project/update-o-auth-2-git-hub.md | 16 + .../project/update-o-auth-2-gitlab.md | 17 + .../project/update-o-auth-2-google.md | 16 + .../project/update-o-auth-2-keycloak.md | 18 + .../examples/project/update-o-auth-2-kick.md | 16 + .../project/update-o-auth-2-linkedin.md | 16 + .../project/update-o-auth-2-microsoft.md | 17 + .../project/update-o-auth-2-notion.md | 16 + .../examples/project/update-o-auth-2-oidc.md | 20 + .../examples/project/update-o-auth-2-okta.md | 18 + .../project/update-o-auth-2-paypal-sandbox.md | 16 + .../project/update-o-auth-2-paypal.md | 16 + .../examples/project/update-o-auth-2-podio.md | 16 + .../project/update-o-auth-2-salesforce.md | 16 + .../examples/project/update-o-auth-2-slack.md | 16 + .../project/update-o-auth-2-spotify.md | 16 + .../project/update-o-auth-2-stripe.md | 16 + .../update-o-auth-2-tradeshift-sandbox.md | 16 + .../project/update-o-auth-2-tradeshift.md | 16 + .../project/update-o-auth-2-twitch.md | 16 + .../project/update-o-auth-2-word-press.md | 16 + .../examples/project/update-o-auth-2-yahoo.md | 16 + .../project/update-o-auth-2-yandex.md | 16 + .../examples/project/update-o-auth-2-zoho.md | 16 + .../examples/project/update-o-auth-2-zoom.md | 16 + .../examples/project/update-o-auth-2x.md | 16 + .../examples/functions/create.md | 2 +- .../examples/functions/update.md | 2 +- .../examples/project/create-ephemeral-key.md | 17 + .../examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 16 + .../examples/project/delete-mock-phone.md | 15 + .../server-dotnet/examples/project/delete.md | 14 + .../examples/project/get-mock-phone.md | 15 + .../examples/project/get-o-auth-2-provider.md | 15 + .../examples/project/get-policy.md | 16 + .../examples/project/list-email-templates.md | 16 + .../examples/project/list-mock-phones.md | 16 + .../project/list-o-auth-2-providers.md | 14 + .../examples/project/list-policies.md | 16 + .../examples/project/update-auth-method.md | 17 + .../examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 16 + .../project/update-o-auth-2-amazon.md | 17 + .../examples/project/update-o-auth-2-apple.md | 19 + .../project/update-o-auth-2-auth-0.md | 18 + .../project/update-o-auth-2-authentik.md | 18 + .../project/update-o-auth-2-autodesk.md | 17 + .../project/update-o-auth-2-bitbucket.md | 17 + .../examples/project/update-o-auth-2-bitly.md | 17 + .../examples/project/update-o-auth-2-box.md | 17 + .../project/update-o-auth-2-dailymotion.md | 17 + .../project/update-o-auth-2-discord.md | 17 + .../project/update-o-auth-2-disqus.md | 17 + .../project/update-o-auth-2-dropbox.md | 17 + .../examples/project/update-o-auth-2-etsy.md | 17 + .../project/update-o-auth-2-facebook.md | 17 + .../examples/project/update-o-auth-2-figma.md | 17 + .../project/update-o-auth-2-fusion-auth.md | 18 + .../project/update-o-auth-2-git-hub.md | 17 + .../project/update-o-auth-2-gitlab.md | 18 + .../project/update-o-auth-2-google.md | 17 + .../project/update-o-auth-2-keycloak.md | 19 + .../examples/project/update-o-auth-2-kick.md | 17 + .../project/update-o-auth-2-linkedin.md | 17 + .../project/update-o-auth-2-microsoft.md | 18 + .../project/update-o-auth-2-notion.md | 17 + .../examples/project/update-o-auth-2-oidc.md | 21 + .../examples/project/update-o-auth-2-okta.md | 19 + .../project/update-o-auth-2-paypal-sandbox.md | 17 + .../project/update-o-auth-2-paypal.md | 17 + .../examples/project/update-o-auth-2-podio.md | 17 + .../project/update-o-auth-2-salesforce.md | 17 + .../examples/project/update-o-auth-2-slack.md | 17 + .../project/update-o-auth-2-spotify.md | 17 + .../project/update-o-auth-2-stripe.md | 17 + .../update-o-auth-2-tradeshift-sandbox.md | 17 + .../project/update-o-auth-2-tradeshift.md | 17 + .../project/update-o-auth-2-twitch.md | 17 + .../project/update-o-auth-2-word-press.md | 17 + .../examples/project/update-o-auth-2-yahoo.md | 17 + .../project/update-o-auth-2-yandex.md | 17 + .../examples/project/update-o-auth-2-zoho.md | 17 + .../examples/project/update-o-auth-2-zoom.md | 17 + .../examples/project/update-o-auth-2x.md | 17 + .../examples/project/create-ephemeral-key.md | 22 + .../examples/project/create-mock-phone.md | 22 + .../examples/project/delete-mock-phone.md | 21 + .../server-go/examples/project/delete.md | 19 + .../examples/project/get-mock-phone.md | 21 + .../examples/project/get-o-auth-2-provider.md | 21 + .../server-go/examples/project/get-policy.md | 21 + .../examples/project/list-email-templates.md | 22 + .../examples/project/list-mock-phones.md | 22 + .../project/list-o-auth-2-providers.md | 19 + .../examples/project/list-policies.md | 22 + .../examples/project/update-auth-method.md | 22 + .../examples/project/update-mock-phone.md | 22 + .../project/update-o-auth-2-amazon.md | 23 + .../examples/project/update-o-auth-2-apple.md | 25 + .../project/update-o-auth-2-auth-0.md | 24 + .../project/update-o-auth-2-authentik.md | 24 + .../project/update-o-auth-2-autodesk.md | 23 + .../project/update-o-auth-2-bitbucket.md | 23 + .../examples/project/update-o-auth-2-bitly.md | 23 + .../examples/project/update-o-auth-2-box.md | 23 + .../project/update-o-auth-2-dailymotion.md | 23 + .../project/update-o-auth-2-discord.md | 23 + .../project/update-o-auth-2-disqus.md | 23 + .../project/update-o-auth-2-dropbox.md | 23 + .../examples/project/update-o-auth-2-etsy.md | 23 + .../project/update-o-auth-2-facebook.md | 23 + .../examples/project/update-o-auth-2-figma.md | 23 + .../project/update-o-auth-2-fusion-auth.md | 24 + .../project/update-o-auth-2-git-hub.md | 23 + .../project/update-o-auth-2-gitlab.md | 24 + .../project/update-o-auth-2-google.md | 23 + .../project/update-o-auth-2-keycloak.md | 25 + .../examples/project/update-o-auth-2-kick.md | 23 + .../project/update-o-auth-2-linkedin.md | 23 + .../project/update-o-auth-2-microsoft.md | 24 + .../project/update-o-auth-2-notion.md | 23 + .../examples/project/update-o-auth-2-oidc.md | 27 + .../examples/project/update-o-auth-2-okta.md | 25 + .../project/update-o-auth-2-paypal-sandbox.md | 23 + .../project/update-o-auth-2-paypal.md | 23 + .../examples/project/update-o-auth-2-podio.md | 23 + .../project/update-o-auth-2-salesforce.md | 23 + .../examples/project/update-o-auth-2-slack.md | 23 + .../project/update-o-auth-2-spotify.md | 23 + .../project/update-o-auth-2-stripe.md | 23 + .../update-o-auth-2-tradeshift-sandbox.md | 23 + .../project/update-o-auth-2-tradeshift.md | 23 + .../project/update-o-auth-2-twitch.md | 23 + .../project/update-o-auth-2-word-press.md | 23 + .../examples/project/update-o-auth-2-yahoo.md | 23 + .../project/update-o-auth-2-yandex.md | 23 + .../examples/project/update-o-auth-2-zoho.md | 23 + .../examples/project/update-o-auth-2-zoom.md | 23 + .../examples/project/update-o-auth-2x.md | 23 + .../examples/functions/create-deployment.md | 2 +- .../examples/project/create-ephemeral-key.md | 18 + .../examples/project/create-mock-phone.md | 13 + .../examples/project/delete-mock-phone.md | 9 + .../server-graphql/examples/project/delete.md | 7 + .../examples/project/get-mock-phone.md | 2 + .../examples/project/get-o-auth-2-provider.md | 2 + .../examples/project/get-policy.md | 2 + .../examples/project/list-email-templates.md | 2 + .../examples/project/list-mock-phones.md | 2 + .../project/list-o-auth-2-providers.md | 2 + .../examples/project/list-policies.md | 2 + .../examples/project/update-auth-method.md | 154 + .../examples/project/update-labels.md | 9 +- .../update-membership-privacy-policy.md | 9 +- .../examples/project/update-mock-phone.md | 13 + .../project/update-o-auth-2-amazon.md | 14 + .../examples/project/update-o-auth-2-apple.md | 18 + .../project/update-o-auth-2-auth-0.md | 16 + .../project/update-o-auth-2-authentik.md | 16 + .../project/update-o-auth-2-autodesk.md | 14 + .../project/update-o-auth-2-bitbucket.md | 14 + .../examples/project/update-o-auth-2-bitly.md | 14 + .../examples/project/update-o-auth-2-box.md | 14 + .../project/update-o-auth-2-dailymotion.md | 14 + .../project/update-o-auth-2-discord.md | 14 + .../project/update-o-auth-2-disqus.md | 14 + .../project/update-o-auth-2-dropbox.md | 14 + .../examples/project/update-o-auth-2-etsy.md | 14 + .../project/update-o-auth-2-facebook.md | 14 + .../examples/project/update-o-auth-2-figma.md | 14 + .../project/update-o-auth-2-fusion-auth.md | 16 + .../project/update-o-auth-2-git-hub.md | 14 + .../project/update-o-auth-2-gitlab.md | 16 + .../project/update-o-auth-2-google.md | 14 + .../project/update-o-auth-2-keycloak.md | 18 + .../examples/project/update-o-auth-2-kick.md | 14 + .../project/update-o-auth-2-linkedin.md | 14 + .../project/update-o-auth-2-microsoft.md | 16 + .../project/update-o-auth-2-notion.md | 14 + .../examples/project/update-o-auth-2-oidc.md | 22 + .../examples/project/update-o-auth-2-okta.md | 18 + .../project/update-o-auth-2-paypal-sandbox.md | 14 + .../project/update-o-auth-2-paypal.md | 14 + .../examples/project/update-o-auth-2-podio.md | 14 + .../project/update-o-auth-2-salesforce.md | 14 + .../examples/project/update-o-auth-2-slack.md | 14 + .../project/update-o-auth-2-spotify.md | 14 + .../project/update-o-auth-2-stripe.md | 14 + .../update-o-auth-2-tradeshift-sandbox.md | 14 + .../project/update-o-auth-2-tradeshift.md | 14 + .../project/update-o-auth-2-twitch.md | 14 + .../project/update-o-auth-2-word-press.md | 14 + .../examples/project/update-o-auth-2-yahoo.md | 14 + .../project/update-o-auth-2-yandex.md | 14 + .../examples/project/update-o-auth-2-zoho.md | 14 + .../examples/project/update-o-auth-2-zoom.md | 14 + .../examples/project/update-o-auth-2x.md | 14 + .../update-password-dictionary-policy.md | 9 +- .../project/update-password-history-policy.md | 9 +- .../update-password-personal-data-policy.md | 9 +- .../examples/project/update-protocol.md | 9 +- .../examples/project/update-service.md | 9 +- .../project/update-session-alert-policy.md | 9 +- .../project/update-session-duration-policy.md | 9 +- .../update-session-invalidation-policy.md | 9 +- .../project/update-session-limit-policy.md | 9 +- .../examples/project/update-smtp.md | 9 +- .../project/update-user-limit-policy.md | 9 +- .../examples/sites/create-deployment.md | 2 +- .../examples/storage/create-file.md | 2 +- .../server-kotlin/java/functions/create.md | 2 +- .../server-kotlin/java/functions/update.md | 2 +- .../java/project/create-ephemeral-key.md | 27 + .../server-kotlin/java/project/create-key.md | 2 +- .../java/project/create-mock-phone.md | 26 + .../java/project/delete-mock-phone.md | 25 + .../server-kotlin/java/project/delete.md | 21 + .../java/project/get-mock-phone.md | 25 + .../java/project/get-o-auth-2-provider.md | 25 + .../server-kotlin/java/project/get-policy.md | 26 + .../java/project/list-email-templates.md | 26 + .../java/project/list-mock-phones.md | 26 + .../java/project/list-o-auth-2-providers.md | 21 + .../java/project/list-policies.md | 26 + .../java/project/update-auth-method.md | 27 + .../server-kotlin/java/project/update-key.md | 2 +- .../java/project/update-mock-phone.md | 26 + .../java/project/update-o-auth-2-amazon.md | 27 + .../java/project/update-o-auth-2-apple.md | 29 + .../java/project/update-o-auth-2-auth-0.md | 28 + .../java/project/update-o-auth-2-authentik.md | 28 + .../java/project/update-o-auth-2-autodesk.md | 27 + .../java/project/update-o-auth-2-bitbucket.md | 27 + .../java/project/update-o-auth-2-bitly.md | 27 + .../java/project/update-o-auth-2-box.md | 27 + .../project/update-o-auth-2-dailymotion.md | 27 + .../java/project/update-o-auth-2-discord.md | 27 + .../java/project/update-o-auth-2-disqus.md | 27 + .../java/project/update-o-auth-2-dropbox.md | 27 + .../java/project/update-o-auth-2-etsy.md | 27 + .../java/project/update-o-auth-2-facebook.md | 27 + .../java/project/update-o-auth-2-figma.md | 27 + .../project/update-o-auth-2-fusion-auth.md | 28 + .../java/project/update-o-auth-2-git-hub.md | 27 + .../java/project/update-o-auth-2-gitlab.md | 28 + .../java/project/update-o-auth-2-google.md | 27 + .../java/project/update-o-auth-2-keycloak.md | 29 + .../java/project/update-o-auth-2-kick.md | 27 + .../java/project/update-o-auth-2-linkedin.md | 27 + .../java/project/update-o-auth-2-microsoft.md | 28 + .../java/project/update-o-auth-2-notion.md | 27 + .../java/project/update-o-auth-2-oidc.md | 31 + .../java/project/update-o-auth-2-okta.md | 29 + .../project/update-o-auth-2-paypal-sandbox.md | 27 + .../java/project/update-o-auth-2-paypal.md | 27 + .../java/project/update-o-auth-2-podio.md | 27 + .../project/update-o-auth-2-salesforce.md | 27 + .../java/project/update-o-auth-2-slack.md | 27 + .../java/project/update-o-auth-2-spotify.md | 27 + .../java/project/update-o-auth-2-stripe.md | 27 + .../update-o-auth-2-tradeshift-sandbox.md | 27 + .../project/update-o-auth-2-tradeshift.md | 27 + .../java/project/update-o-auth-2-twitch.md | 27 + .../project/update-o-auth-2-word-press.md | 27 + .../java/project/update-o-auth-2-yahoo.md | 27 + .../java/project/update-o-auth-2-yandex.md | 27 + .../java/project/update-o-auth-2-zoho.md | 27 + .../java/project/update-o-auth-2-zoom.md | 27 + .../java/project/update-o-auth-2x.md | 27 + .../server-kotlin/kotlin/functions/create.md | 2 +- .../server-kotlin/kotlin/functions/update.md | 2 +- .../kotlin/project/create-ephemeral-key.md | 18 + .../kotlin/project/create-key.md | 2 +- .../kotlin/project/create-mock-phone.md | 17 + .../kotlin/project/delete-mock-phone.md | 16 + .../server-kotlin/kotlin/project/delete.md | 14 + .../kotlin/project/get-mock-phone.md | 16 + .../kotlin/project/get-o-auth-2-provider.md | 16 + .../kotlin/project/get-policy.md | 17 + .../kotlin/project/list-email-templates.md | 17 + .../kotlin/project/list-mock-phones.md | 17 + .../kotlin/project/list-o-auth-2-providers.md | 14 + .../kotlin/project/list-policies.md | 17 + .../kotlin/project/update-auth-method.md | 18 + .../kotlin/project/update-key.md | 2 +- .../kotlin/project/update-mock-phone.md | 17 + .../kotlin/project/update-o-auth-2-amazon.md | 18 + .../kotlin/project/update-o-auth-2-apple.md | 20 + .../kotlin/project/update-o-auth-2-auth-0.md | 19 + .../project/update-o-auth-2-authentik.md | 19 + .../project/update-o-auth-2-autodesk.md | 18 + .../project/update-o-auth-2-bitbucket.md | 18 + .../kotlin/project/update-o-auth-2-bitly.md | 18 + .../kotlin/project/update-o-auth-2-box.md | 18 + .../project/update-o-auth-2-dailymotion.md | 18 + .../kotlin/project/update-o-auth-2-discord.md | 18 + .../kotlin/project/update-o-auth-2-disqus.md | 18 + .../kotlin/project/update-o-auth-2-dropbox.md | 18 + .../kotlin/project/update-o-auth-2-etsy.md | 18 + .../project/update-o-auth-2-facebook.md | 18 + .../kotlin/project/update-o-auth-2-figma.md | 18 + .../project/update-o-auth-2-fusion-auth.md | 19 + .../kotlin/project/update-o-auth-2-git-hub.md | 18 + .../kotlin/project/update-o-auth-2-gitlab.md | 19 + .../kotlin/project/update-o-auth-2-google.md | 18 + .../project/update-o-auth-2-keycloak.md | 20 + .../kotlin/project/update-o-auth-2-kick.md | 18 + .../project/update-o-auth-2-linkedin.md | 18 + .../project/update-o-auth-2-microsoft.md | 19 + .../kotlin/project/update-o-auth-2-notion.md | 18 + .../kotlin/project/update-o-auth-2-oidc.md | 22 + .../kotlin/project/update-o-auth-2-okta.md | 20 + .../project/update-o-auth-2-paypal-sandbox.md | 18 + .../kotlin/project/update-o-auth-2-paypal.md | 18 + .../kotlin/project/update-o-auth-2-podio.md | 18 + .../project/update-o-auth-2-salesforce.md | 18 + .../kotlin/project/update-o-auth-2-slack.md | 18 + .../kotlin/project/update-o-auth-2-spotify.md | 18 + .../kotlin/project/update-o-auth-2-stripe.md | 18 + .../update-o-auth-2-tradeshift-sandbox.md | 18 + .../project/update-o-auth-2-tradeshift.md | 18 + .../kotlin/project/update-o-auth-2-twitch.md | 18 + .../project/update-o-auth-2-word-press.md | 18 + .../kotlin/project/update-o-auth-2-yahoo.md | 18 + .../kotlin/project/update-o-auth-2-yandex.md | 18 + .../kotlin/project/update-o-auth-2-zoho.md | 18 + .../kotlin/project/update-o-auth-2-zoom.md | 18 + .../kotlin/project/update-o-auth-2x.md | 18 + .../examples/functions/create.md | 2 +- .../examples/functions/update.md | 2 +- .../examples/project/create-ephemeral-key.md | 15 + .../examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 15 + .../examples/project/delete-mock-phone.md | 14 + .../server-nodejs/examples/project/delete.md | 12 + .../examples/project/get-mock-phone.md | 14 + .../examples/project/get-o-auth-2-provider.md | 14 + .../examples/project/get-policy.md | 14 + .../examples/project/list-email-templates.md | 15 + .../examples/project/list-mock-phones.md | 15 + .../project/list-o-auth-2-providers.md | 12 + .../examples/project/list-policies.md | 15 + .../examples/project/update-auth-method.md | 15 + .../examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 15 + .../project/update-o-auth-2-amazon.md | 16 + .../examples/project/update-o-auth-2-apple.md | 18 + .../project/update-o-auth-2-auth-0.md | 17 + .../project/update-o-auth-2-authentik.md | 17 + .../project/update-o-auth-2-autodesk.md | 16 + .../project/update-o-auth-2-bitbucket.md | 16 + .../examples/project/update-o-auth-2-bitly.md | 16 + .../examples/project/update-o-auth-2-box.md | 16 + .../project/update-o-auth-2-dailymotion.md | 16 + .../project/update-o-auth-2-discord.md | 16 + .../project/update-o-auth-2-disqus.md | 16 + .../project/update-o-auth-2-dropbox.md | 16 + .../examples/project/update-o-auth-2-etsy.md | 16 + .../project/update-o-auth-2-facebook.md | 16 + .../examples/project/update-o-auth-2-figma.md | 16 + .../project/update-o-auth-2-fusion-auth.md | 17 + .../project/update-o-auth-2-git-hub.md | 16 + .../project/update-o-auth-2-gitlab.md | 17 + .../project/update-o-auth-2-google.md | 16 + .../project/update-o-auth-2-keycloak.md | 18 + .../examples/project/update-o-auth-2-kick.md | 16 + .../project/update-o-auth-2-linkedin.md | 16 + .../project/update-o-auth-2-microsoft.md | 17 + .../project/update-o-auth-2-notion.md | 16 + .../examples/project/update-o-auth-2-oidc.md | 20 + .../examples/project/update-o-auth-2-okta.md | 18 + .../project/update-o-auth-2-paypal-sandbox.md | 16 + .../project/update-o-auth-2-paypal.md | 16 + .../examples/project/update-o-auth-2-podio.md | 16 + .../project/update-o-auth-2-salesforce.md | 16 + .../examples/project/update-o-auth-2-slack.md | 16 + .../project/update-o-auth-2-spotify.md | 16 + .../project/update-o-auth-2-stripe.md | 16 + .../update-o-auth-2-tradeshift-sandbox.md | 16 + .../project/update-o-auth-2-tradeshift.md | 16 + .../project/update-o-auth-2-twitch.md | 16 + .../project/update-o-auth-2-word-press.md | 16 + .../examples/project/update-o-auth-2-yahoo.md | 16 + .../project/update-o-auth-2-yandex.md | 16 + .../examples/project/update-o-auth-2-zoho.md | 16 + .../examples/project/update-o-auth-2-zoom.md | 16 + .../examples/project/update-o-auth-2x.md | 16 + .../server-php/examples/functions/create.md | 2 +- .../server-php/examples/functions/update.md | 2 +- .../examples/project/create-ephemeral-key.md | 18 + .../server-php/examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 17 + .../examples/project/delete-mock-phone.md | 16 + .../server-php/examples/project/delete.md | 15 + .../examples/project/get-mock-phone.md | 16 + .../examples/project/get-o-auth-2-provider.md | 16 + .../server-php/examples/project/get-policy.md | 17 + .../examples/project/list-email-templates.md | 17 + .../examples/project/list-mock-phones.md | 17 + .../project/list-o-auth-2-providers.md | 15 + .../examples/project/list-policies.md | 17 + .../examples/project/update-auth-method.md | 18 + .../server-php/examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 17 + .../project/update-o-auth-2-amazon.md | 18 + .../examples/project/update-o-auth-2-apple.md | 20 + .../project/update-o-auth-2-auth-0.md | 19 + .../project/update-o-auth-2-authentik.md | 19 + .../project/update-o-auth-2-autodesk.md | 18 + .../project/update-o-auth-2-bitbucket.md | 18 + .../examples/project/update-o-auth-2-bitly.md | 18 + .../examples/project/update-o-auth-2-box.md | 18 + .../project/update-o-auth-2-dailymotion.md | 18 + .../project/update-o-auth-2-discord.md | 18 + .../project/update-o-auth-2-disqus.md | 18 + .../project/update-o-auth-2-dropbox.md | 18 + .../examples/project/update-o-auth-2-etsy.md | 18 + .../project/update-o-auth-2-facebook.md | 18 + .../examples/project/update-o-auth-2-figma.md | 18 + .../project/update-o-auth-2-fusion-auth.md | 19 + .../project/update-o-auth-2-git-hub.md | 18 + .../project/update-o-auth-2-gitlab.md | 19 + .../project/update-o-auth-2-google.md | 18 + .../project/update-o-auth-2-keycloak.md | 20 + .../examples/project/update-o-auth-2-kick.md | 18 + .../project/update-o-auth-2-linkedin.md | 18 + .../project/update-o-auth-2-microsoft.md | 19 + .../project/update-o-auth-2-notion.md | 18 + .../examples/project/update-o-auth-2-oidc.md | 22 + .../examples/project/update-o-auth-2-okta.md | 20 + .../project/update-o-auth-2-paypal-sandbox.md | 18 + .../project/update-o-auth-2-paypal.md | 18 + .../examples/project/update-o-auth-2-podio.md | 18 + .../project/update-o-auth-2-salesforce.md | 18 + .../examples/project/update-o-auth-2-slack.md | 18 + .../project/update-o-auth-2-spotify.md | 18 + .../project/update-o-auth-2-stripe.md | 18 + .../update-o-auth-2-tradeshift-sandbox.md | 18 + .../project/update-o-auth-2-tradeshift.md | 18 + .../project/update-o-auth-2-twitch.md | 18 + .../project/update-o-auth-2-word-press.md | 18 + .../examples/project/update-o-auth-2-yahoo.md | 18 + .../project/update-o-auth-2-yandex.md | 18 + .../examples/project/update-o-auth-2-zoho.md | 18 + .../examples/project/update-o-auth-2-zoom.md | 18 + .../examples/project/update-o-auth-2x.md | 18 + .../examples/functions/create.md | 2 +- .../examples/functions/update.md | 2 +- .../examples/project/create-ephemeral-key.md | 20 + .../examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 19 + .../examples/project/delete-mock-phone.md | 15 + .../server-python/examples/project/delete.md | 13 + .../examples/project/get-mock-phone.md | 18 + .../examples/project/get-o-auth-2-provider.md | 58 + .../examples/project/get-policy.md | 28 + .../examples/project/list-email-templates.md | 19 + .../examples/project/list-mock-phones.md | 19 + .../project/list-o-auth-2-providers.md | 16 + .../examples/project/list-policies.md | 19 + .../examples/project/update-auth-method.md | 20 + .../examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 19 + .../project/update-o-auth-2-amazon.md | 20 + .../examples/project/update-o-auth-2-apple.md | 22 + .../project/update-o-auth-2-auth-0.md | 21 + .../project/update-o-auth-2-authentik.md | 21 + .../project/update-o-auth-2-autodesk.md | 20 + .../project/update-o-auth-2-bitbucket.md | 20 + .../examples/project/update-o-auth-2-bitly.md | 20 + .../examples/project/update-o-auth-2-box.md | 20 + .../project/update-o-auth-2-dailymotion.md | 20 + .../project/update-o-auth-2-discord.md | 20 + .../project/update-o-auth-2-disqus.md | 20 + .../project/update-o-auth-2-dropbox.md | 20 + .../examples/project/update-o-auth-2-etsy.md | 20 + .../project/update-o-auth-2-facebook.md | 20 + .../examples/project/update-o-auth-2-figma.md | 20 + .../project/update-o-auth-2-fusion-auth.md | 21 + .../project/update-o-auth-2-git-hub.md | 20 + .../project/update-o-auth-2-gitlab.md | 21 + .../project/update-o-auth-2-google.md | 20 + .../project/update-o-auth-2-keycloak.md | 22 + .../examples/project/update-o-auth-2-kick.md | 20 + .../project/update-o-auth-2-linkedin.md | 20 + .../project/update-o-auth-2-microsoft.md | 21 + .../project/update-o-auth-2-notion.md | 20 + .../examples/project/update-o-auth-2-oidc.md | 24 + .../examples/project/update-o-auth-2-okta.md | 22 + .../project/update-o-auth-2-paypal-sandbox.md | 20 + .../project/update-o-auth-2-paypal.md | 20 + .../examples/project/update-o-auth-2-podio.md | 20 + .../project/update-o-auth-2-salesforce.md | 20 + .../examples/project/update-o-auth-2-slack.md | 20 + .../project/update-o-auth-2-spotify.md | 20 + .../project/update-o-auth-2-stripe.md | 20 + .../update-o-auth-2-tradeshift-sandbox.md | 20 + .../project/update-o-auth-2-tradeshift.md | 20 + .../project/update-o-auth-2-twitch.md | 20 + .../project/update-o-auth-2-word-press.md | 20 + .../examples/project/update-o-auth-2-yahoo.md | 20 + .../project/update-o-auth-2-yandex.md | 20 + .../examples/project/update-o-auth-2-zoho.md | 20 + .../examples/project/update-o-auth-2-zoom.md | 20 + .../examples/project/update-o-auth-2x.md | 20 + .../account/create-anonymous-session.md | 2 +- .../account/create-email-password-session.md | 2 +- .../examples/account/create-email-token.md | 2 +- .../account/create-email-verification.md | 2 +- .../examples/account/create-jwt.md | 2 +- .../account/create-magic-url-token.md | 2 +- .../account/create-mfa-authenticator.md | 2 +- .../examples/account/create-mfa-challenge.md | 2 +- .../account/create-mfa-recovery-codes.md | 2 +- .../examples/account/create-o-auth-2-token.md | 2 +- .../examples/account/create-phone-token.md | 2 +- .../account/create-phone-verification.md | 2 +- .../examples/account/create-recovery.md | 2 +- .../examples/account/create-session.md | 2 +- .../examples/account/create-verification.md | 2 +- .../server-rest/examples/account/create.md | 2 +- .../examples/account/delete-identity.md | 2 +- .../account/delete-mfa-authenticator.md | 2 +- .../examples/account/delete-session.md | 2 +- .../examples/account/delete-sessions.md | 2 +- .../account/get-mfa-recovery-codes.md | 2 +- .../server-rest/examples/account/get-prefs.md | 2 +- .../examples/account/get-session.md | 2 +- .../1.9.x/server-rest/examples/account/get.md | 2 +- .../examples/account/list-identities.md | 2 +- .../server-rest/examples/account/list-logs.md | 2 +- .../examples/account/list-mfa-factors.md | 2 +- .../examples/account/list-sessions.md | 2 +- .../account/update-email-verification.md | 2 +- .../examples/account/update-email.md | 2 +- .../account/update-magic-url-session.md | 2 +- .../account/update-mfa-authenticator.md | 2 +- .../examples/account/update-mfa-challenge.md | 2 +- .../account/update-mfa-recovery-codes.md | 2 +- .../examples/account/update-mfa.md | 2 +- .../examples/account/update-name.md | 2 +- .../examples/account/update-password.md | 2 +- .../examples/account/update-phone-session.md | 2 +- .../account/update-phone-verification.md | 2 +- .../examples/account/update-phone.md | 2 +- .../examples/account/update-prefs.md | 2 +- .../examples/account/update-recovery.md | 2 +- .../examples/account/update-session.md | 2 +- .../examples/account/update-status.md | 2 +- .../examples/account/update-verification.md | 2 +- .../examples/activities/get-event.md | 2 +- .../examples/activities/list-events.md | 2 +- .../examples/avatars/get-browser.md | 2 +- .../examples/avatars/get-credit-card.md | 2 +- .../examples/avatars/get-favicon.md | 2 +- .../server-rest/examples/avatars/get-flag.md | 2 +- .../server-rest/examples/avatars/get-image.md | 2 +- .../examples/avatars/get-initials.md | 2 +- .../server-rest/examples/avatars/get-qr.md | 2 +- .../examples/avatars/get-screenshot.md | 2 +- .../examples/backups/create-archive.md | 2 +- .../examples/backups/create-policy.md | 2 +- .../examples/backups/create-restoration.md | 2 +- .../examples/backups/delete-archive.md | 2 +- .../examples/backups/delete-policy.md | 2 +- .../examples/backups/get-archive.md | 2 +- .../examples/backups/get-policy.md | 2 +- .../examples/backups/get-restoration.md | 2 +- .../examples/backups/list-archives.md | 2 +- .../examples/backups/list-policies.md | 2 +- .../examples/backups/list-restorations.md | 2 +- .../examples/backups/update-policy.md | 2 +- .../databases/create-boolean-attribute.md | 2 +- .../examples/databases/create-collection.md | 2 +- .../databases/create-datetime-attribute.md | 2 +- .../examples/databases/create-document.md | 2 +- .../examples/databases/create-documents.md | 2 +- .../databases/create-email-attribute.md | 2 +- .../databases/create-enum-attribute.md | 2 +- .../databases/create-float-attribute.md | 2 +- .../examples/databases/create-index.md | 2 +- .../databases/create-integer-attribute.md | 2 +- .../examples/databases/create-ip-attribute.md | 2 +- .../databases/create-line-attribute.md | 2 +- .../databases/create-longtext-attribute.md | 2 +- .../databases/create-mediumtext-attribute.md | 2 +- .../examples/databases/create-operations.md | 2 +- .../databases/create-point-attribute.md | 2 +- .../databases/create-polygon-attribute.md | 2 +- .../create-relationship-attribute.md | 2 +- .../databases/create-string-attribute.md | 2 +- .../databases/create-text-attribute.md | 2 +- .../examples/databases/create-transaction.md | 2 +- .../databases/create-url-attribute.md | 2 +- .../databases/create-varchar-attribute.md | 2 +- .../server-rest/examples/databases/create.md | 2 +- .../databases/decrement-document-attribute.md | 2 +- .../examples/databases/delete-attribute.md | 2 +- .../examples/databases/delete-collection.md | 2 +- .../examples/databases/delete-document.md | 2 +- .../examples/databases/delete-documents.md | 2 +- .../examples/databases/delete-index.md | 2 +- .../examples/databases/delete-transaction.md | 2 +- .../server-rest/examples/databases/delete.md | 2 +- .../examples/databases/get-attribute.md | 2 +- .../examples/databases/get-collection.md | 2 +- .../examples/databases/get-document.md | 2 +- .../examples/databases/get-index.md | 2 +- .../examples/databases/get-transaction.md | 2 +- .../server-rest/examples/databases/get.md | 2 +- .../databases/increment-document-attribute.md | 2 +- .../examples/databases/list-attributes.md | 2 +- .../examples/databases/list-collections.md | 2 +- .../examples/databases/list-documents.md | 2 +- .../examples/databases/list-indexes.md | 2 +- .../examples/databases/list-transactions.md | 2 +- .../server-rest/examples/databases/list.md | 2 +- .../databases/update-boolean-attribute.md | 2 +- .../examples/databases/update-collection.md | 2 +- .../databases/update-datetime-attribute.md | 2 +- .../examples/databases/update-document.md | 2 +- .../examples/databases/update-documents.md | 2 +- .../databases/update-email-attribute.md | 2 +- .../databases/update-enum-attribute.md | 2 +- .../databases/update-float-attribute.md | 2 +- .../databases/update-integer-attribute.md | 2 +- .../examples/databases/update-ip-attribute.md | 2 +- .../databases/update-line-attribute.md | 2 +- .../databases/update-longtext-attribute.md | 2 +- .../databases/update-mediumtext-attribute.md | 2 +- .../databases/update-point-attribute.md | 2 +- .../databases/update-polygon-attribute.md | 2 +- .../update-relationship-attribute.md | 2 +- .../databases/update-string-attribute.md | 2 +- .../databases/update-text-attribute.md | 2 +- .../examples/databases/update-transaction.md | 2 +- .../databases/update-url-attribute.md | 2 +- .../databases/update-varchar-attribute.md | 2 +- .../server-rest/examples/databases/update.md | 2 +- .../examples/databases/upsert-document.md | 2 +- .../examples/databases/upsert-documents.md | 2 +- .../examples/functions/create-deployment.md | 2 +- .../functions/create-duplicate-deployment.md | 2 +- .../examples/functions/create-execution.md | 2 +- .../functions/create-template-deployment.md | 2 +- .../examples/functions/create-variable.md | 2 +- .../functions/create-vcs-deployment.md | 2 +- .../server-rest/examples/functions/create.md | 2 +- .../examples/functions/delete-deployment.md | 2 +- .../examples/functions/delete-execution.md | 2 +- .../examples/functions/delete-variable.md | 2 +- .../server-rest/examples/functions/delete.md | 2 +- .../functions/get-deployment-download.md | 2 +- .../examples/functions/get-deployment.md | 2 +- .../examples/functions/get-execution.md | 2 +- .../examples/functions/get-variable.md | 2 +- .../server-rest/examples/functions/get.md | 2 +- .../examples/functions/list-deployments.md | 2 +- .../examples/functions/list-executions.md | 2 +- .../examples/functions/list-runtimes.md | 2 +- .../examples/functions/list-specifications.md | 2 +- .../examples/functions/list-variables.md | 2 +- .../server-rest/examples/functions/list.md | 2 +- .../functions/update-deployment-status.md | 2 +- .../functions/update-function-deployment.md | 2 +- .../examples/functions/update-variable.md | 2 +- .../server-rest/examples/functions/update.md | 2 +- .../server-rest/examples/graphql/mutation.md | 2 +- .../server-rest/examples/graphql/query.md | 2 +- .../examples/health/get-antivirus.md | 2 +- .../server-rest/examples/health/get-cache.md | 2 +- .../examples/health/get-certificate.md | 2 +- .../examples/health/get-console-pausing.md | 2 +- .../server-rest/examples/health/get-db.md | 2 +- .../examples/health/get-failed-jobs.md | 2 +- .../examples/health/get-pub-sub.md | 2 +- .../examples/health/get-queue-audits.md | 2 +- .../examples/health/get-queue-builds.md | 2 +- .../examples/health/get-queue-certificates.md | 2 +- .../examples/health/get-queue-databases.md | 2 +- .../examples/health/get-queue-deletes.md | 2 +- .../examples/health/get-queue-functions.md | 2 +- .../examples/health/get-queue-logs.md | 2 +- .../examples/health/get-queue-mails.md | 2 +- .../examples/health/get-queue-messaging.md | 2 +- .../examples/health/get-queue-migrations.md | 2 +- .../health/get-queue-stats-resources.md | 2 +- .../examples/health/get-queue-usage.md | 2 +- .../examples/health/get-queue-webhooks.md | 2 +- .../examples/health/get-storage-local.md | 2 +- .../examples/health/get-storage.md | 2 +- .../server-rest/examples/health/get-time.md | 2 +- .../1.9.x/server-rest/examples/health/get.md | 2 +- .../1.9.x/server-rest/examples/locale/get.md | 2 +- .../server-rest/examples/locale/list-codes.md | 2 +- .../examples/locale/list-continents.md | 2 +- .../examples/locale/list-countries-eu.md | 2 +- .../examples/locale/list-countries-phones.md | 2 +- .../examples/locale/list-countries.md | 2 +- .../examples/locale/list-currencies.md | 2 +- .../examples/locale/list-languages.md | 2 +- .../messaging/create-apns-provider.md | 2 +- .../examples/messaging/create-email.md | 2 +- .../examples/messaging/create-fcm-provider.md | 2 +- .../messaging/create-mailgun-provider.md | 2 +- .../messaging/create-msg-91-provider.md | 2 +- .../examples/messaging/create-push.md | 2 +- .../messaging/create-resend-provider.md | 2 +- .../messaging/create-sendgrid-provider.md | 2 +- .../examples/messaging/create-sms.md | 2 +- .../messaging/create-smtp-provider.md | 2 +- .../examples/messaging/create-subscriber.md | 2 +- .../messaging/create-telesign-provider.md | 2 +- .../messaging/create-textmagic-provider.md | 2 +- .../examples/messaging/create-topic.md | 2 +- .../messaging/create-twilio-provider.md | 2 +- .../messaging/create-vonage-provider.md | 2 +- .../examples/messaging/delete-provider.md | 2 +- .../examples/messaging/delete-subscriber.md | 2 +- .../examples/messaging/delete-topic.md | 2 +- .../server-rest/examples/messaging/delete.md | 2 +- .../examples/messaging/get-message.md | 2 +- .../examples/messaging/get-provider.md | 2 +- .../examples/messaging/get-subscriber.md | 2 +- .../examples/messaging/get-topic.md | 2 +- .../examples/messaging/list-message-logs.md | 2 +- .../examples/messaging/list-messages.md | 2 +- .../examples/messaging/list-provider-logs.md | 2 +- .../examples/messaging/list-providers.md | 2 +- .../messaging/list-subscriber-logs.md | 2 +- .../examples/messaging/list-subscribers.md | 2 +- .../examples/messaging/list-targets.md | 2 +- .../examples/messaging/list-topic-logs.md | 2 +- .../examples/messaging/list-topics.md | 2 +- .../messaging/update-apns-provider.md | 2 +- .../examples/messaging/update-email.md | 2 +- .../examples/messaging/update-fcm-provider.md | 2 +- .../messaging/update-mailgun-provider.md | 2 +- .../messaging/update-msg-91-provider.md | 2 +- .../examples/messaging/update-push.md | 2 +- .../messaging/update-resend-provider.md | 2 +- .../messaging/update-sendgrid-provider.md | 2 +- .../examples/messaging/update-sms.md | 2 +- .../messaging/update-smtp-provider.md | 2 +- .../messaging/update-telesign-provider.md | 2 +- .../messaging/update-textmagic-provider.md | 2 +- .../examples/messaging/update-topic.md | 2 +- .../messaging/update-twilio-provider.md | 2 +- .../messaging/update-vonage-provider.md | 2 +- .../project/create-android-platform.md | 2 +- .../examples/project/create-apple-platform.md | 2 +- .../examples/project/create-ephemeral-key.md | 13 + .../examples/project/create-key.md | 2 +- .../examples/project/create-linux-platform.md | 2 +- .../examples/project/create-mock-phone.md | 13 + .../examples/project/create-smtp-test.md | 2 +- .../examples/project/create-variable.md | 2 +- .../examples/project/create-web-platform.md | 2 +- .../project/create-windows-platform.md | 2 +- .../examples/project/delete-key.md | 2 +- .../examples/project/delete-mock-phone.md | 9 + .../examples/project/delete-platform.md | 2 +- .../examples/project/delete-variable.md | 2 +- .../server-rest/examples/project/delete.md | 9 + .../examples/project/get-email-template.md | 2 +- .../server-rest/examples/project/get-key.md | 2 +- .../examples/project/get-mock-phone.md | 7 + .../examples/project/get-o-auth-2-provider.md | 7 + .../examples/project/get-platform.md | 2 +- .../examples/project/get-policy.md | 7 + .../examples/project/get-variable.md | 2 +- .../examples/project/list-email-templates.md | 7 + .../server-rest/examples/project/list-keys.md | 2 +- .../examples/project/list-mock-phones.md | 7 + .../project/list-o-auth-2-providers.md | 7 + .../examples/project/list-platforms.md | 2 +- .../examples/project/list-policies.md | 7 + .../examples/project/list-variables.md | 2 +- .../project/update-android-platform.md | 2 +- .../examples/project/update-apple-platform.md | 2 +- .../examples/project/update-auth-method.md | 12 + .../examples/project/update-email-template.md | 2 +- .../examples/project/update-key.md | 2 +- .../examples/project/update-labels.md | 2 +- .../examples/project/update-linux-platform.md | 2 +- .../update-membership-privacy-policy.md | 2 +- .../examples/project/update-mock-phone.md | 12 + .../project/update-o-auth-2-amazon.md | 14 + .../examples/project/update-o-auth-2-apple.md | 16 + .../project/update-o-auth-2-auth-0.md | 15 + .../project/update-o-auth-2-authentik.md | 15 + .../project/update-o-auth-2-autodesk.md | 14 + .../project/update-o-auth-2-bitbucket.md | 14 + .../examples/project/update-o-auth-2-bitly.md | 14 + .../examples/project/update-o-auth-2-box.md | 14 + .../project/update-o-auth-2-dailymotion.md | 14 + .../project/update-o-auth-2-discord.md | 14 + .../project/update-o-auth-2-disqus.md | 14 + .../project/update-o-auth-2-dropbox.md | 14 + .../examples/project/update-o-auth-2-etsy.md | 14 + .../project/update-o-auth-2-facebook.md | 14 + .../examples/project/update-o-auth-2-figma.md | 14 + .../project/update-o-auth-2-fusion-auth.md | 15 + .../project/update-o-auth-2-git-hub.md | 14 + .../project/update-o-auth-2-gitlab.md | 15 + .../project/update-o-auth-2-google.md | 14 + .../project/update-o-auth-2-keycloak.md | 16 + .../examples/project/update-o-auth-2-kick.md | 14 + .../project/update-o-auth-2-linkedin.md | 14 + .../project/update-o-auth-2-microsoft.md | 15 + .../project/update-o-auth-2-notion.md | 14 + .../examples/project/update-o-auth-2-oidc.md | 18 + .../examples/project/update-o-auth-2-okta.md | 16 + .../project/update-o-auth-2-paypal-sandbox.md | 14 + .../project/update-o-auth-2-paypal.md | 14 + .../examples/project/update-o-auth-2-podio.md | 14 + .../project/update-o-auth-2-salesforce.md | 14 + .../examples/project/update-o-auth-2-slack.md | 14 + .../project/update-o-auth-2-spotify.md | 14 + .../project/update-o-auth-2-stripe.md | 14 + .../update-o-auth-2-tradeshift-sandbox.md | 14 + .../project/update-o-auth-2-tradeshift.md | 14 + .../project/update-o-auth-2-twitch.md | 14 + .../project/update-o-auth-2-word-press.md | 14 + .../examples/project/update-o-auth-2-yahoo.md | 14 + .../project/update-o-auth-2-yandex.md | 14 + .../examples/project/update-o-auth-2-zoho.md | 14 + .../examples/project/update-o-auth-2-zoom.md | 14 + .../examples/project/update-o-auth-2x.md | 14 + .../update-password-dictionary-policy.md | 2 +- .../project/update-password-history-policy.md | 2 +- .../update-password-personal-data-policy.md | 2 +- .../examples/project/update-protocol.md | 2 +- .../examples/project/update-service.md | 2 +- .../project/update-session-alert-policy.md | 2 +- .../project/update-session-duration-policy.md | 2 +- .../update-session-invalidation-policy.md | 2 +- .../project/update-session-limit-policy.md | 2 +- .../examples/project/update-smtp.md | 2 +- .../project/update-user-limit-policy.md | 2 +- .../examples/project/update-variable.md | 2 +- .../examples/project/update-web-platform.md | 2 +- .../project/update-windows-platform.md | 2 +- .../examples/sites/create-deployment.md | 2 +- .../sites/create-duplicate-deployment.md | 2 +- .../sites/create-template-deployment.md | 2 +- .../examples/sites/create-variable.md | 2 +- .../examples/sites/create-vcs-deployment.md | 2 +- .../server-rest/examples/sites/create.md | 2 +- .../examples/sites/delete-deployment.md | 2 +- .../server-rest/examples/sites/delete-log.md | 2 +- .../examples/sites/delete-variable.md | 2 +- .../server-rest/examples/sites/delete.md | 2 +- .../examples/sites/get-deployment-download.md | 2 +- .../examples/sites/get-deployment.md | 2 +- .../server-rest/examples/sites/get-log.md | 2 +- .../examples/sites/get-variable.md | 2 +- .../1.9.x/server-rest/examples/sites/get.md | 2 +- .../examples/sites/list-deployments.md | 2 +- .../examples/sites/list-frameworks.md | 2 +- .../server-rest/examples/sites/list-logs.md | 2 +- .../examples/sites/list-specifications.md | 2 +- .../examples/sites/list-variables.md | 2 +- .../1.9.x/server-rest/examples/sites/list.md | 2 +- .../sites/update-deployment-status.md | 2 +- .../examples/sites/update-site-deployment.md | 2 +- .../examples/sites/update-variable.md | 2 +- .../server-rest/examples/sites/update.md | 2 +- .../examples/storage/create-bucket.md | 2 +- .../examples/storage/create-file.md | 2 +- .../examples/storage/delete-bucket.md | 2 +- .../examples/storage/delete-file.md | 2 +- .../examples/storage/get-bucket.md | 2 +- .../examples/storage/get-file-download.md | 2 +- .../examples/storage/get-file-preview.md | 2 +- .../examples/storage/get-file-view.md | 2 +- .../server-rest/examples/storage/get-file.md | 2 +- .../examples/storage/list-buckets.md | 2 +- .../examples/storage/list-files.md | 2 +- .../examples/storage/update-bucket.md | 2 +- .../examples/storage/update-file.md | 2 +- .../tablesdb/create-boolean-column.md | 2 +- .../tablesdb/create-datetime-column.md | 2 +- .../examples/tablesdb/create-email-column.md | 2 +- .../examples/tablesdb/create-enum-column.md | 2 +- .../examples/tablesdb/create-float-column.md | 2 +- .../examples/tablesdb/create-index.md | 2 +- .../tablesdb/create-integer-column.md | 2 +- .../examples/tablesdb/create-ip-column.md | 2 +- .../examples/tablesdb/create-line-column.md | 2 +- .../tablesdb/create-longtext-column.md | 2 +- .../tablesdb/create-mediumtext-column.md | 2 +- .../examples/tablesdb/create-operations.md | 2 +- .../examples/tablesdb/create-point-column.md | 2 +- .../tablesdb/create-polygon-column.md | 2 +- .../tablesdb/create-relationship-column.md | 2 +- .../examples/tablesdb/create-row.md | 2 +- .../examples/tablesdb/create-rows.md | 2 +- .../examples/tablesdb/create-string-column.md | 2 +- .../examples/tablesdb/create-table.md | 2 +- .../examples/tablesdb/create-text-column.md | 2 +- .../examples/tablesdb/create-transaction.md | 2 +- .../examples/tablesdb/create-url-column.md | 2 +- .../tablesdb/create-varchar-column.md | 2 +- .../server-rest/examples/tablesdb/create.md | 2 +- .../examples/tablesdb/decrement-row-column.md | 2 +- .../examples/tablesdb/delete-column.md | 2 +- .../examples/tablesdb/delete-index.md | 2 +- .../examples/tablesdb/delete-row.md | 2 +- .../examples/tablesdb/delete-rows.md | 2 +- .../examples/tablesdb/delete-table.md | 2 +- .../examples/tablesdb/delete-transaction.md | 2 +- .../server-rest/examples/tablesdb/delete.md | 2 +- .../examples/tablesdb/get-column.md | 2 +- .../examples/tablesdb/get-index.md | 2 +- .../server-rest/examples/tablesdb/get-row.md | 2 +- .../examples/tablesdb/get-table.md | 2 +- .../examples/tablesdb/get-transaction.md | 2 +- .../server-rest/examples/tablesdb/get.md | 2 +- .../examples/tablesdb/increment-row-column.md | 2 +- .../examples/tablesdb/list-columns.md | 2 +- .../examples/tablesdb/list-indexes.md | 2 +- .../examples/tablesdb/list-rows.md | 2 +- .../examples/tablesdb/list-tables.md | 2 +- .../examples/tablesdb/list-transactions.md | 2 +- .../server-rest/examples/tablesdb/list.md | 2 +- .../tablesdb/update-boolean-column.md | 2 +- .../tablesdb/update-datetime-column.md | 2 +- .../examples/tablesdb/update-email-column.md | 2 +- .../examples/tablesdb/update-enum-column.md | 2 +- .../examples/tablesdb/update-float-column.md | 2 +- .../tablesdb/update-integer-column.md | 2 +- .../examples/tablesdb/update-ip-column.md | 2 +- .../examples/tablesdb/update-line-column.md | 2 +- .../tablesdb/update-longtext-column.md | 2 +- .../tablesdb/update-mediumtext-column.md | 2 +- .../examples/tablesdb/update-point-column.md | 2 +- .../tablesdb/update-polygon-column.md | 2 +- .../tablesdb/update-relationship-column.md | 2 +- .../examples/tablesdb/update-row.md | 2 +- .../examples/tablesdb/update-rows.md | 2 +- .../examples/tablesdb/update-string-column.md | 2 +- .../examples/tablesdb/update-table.md | 2 +- .../examples/tablesdb/update-text-column.md | 2 +- .../examples/tablesdb/update-transaction.md | 2 +- .../examples/tablesdb/update-url-column.md | 2 +- .../tablesdb/update-varchar-column.md | 2 +- .../server-rest/examples/tablesdb/update.md | 2 +- .../examples/tablesdb/upsert-row.md | 2 +- .../examples/tablesdb/upsert-rows.md | 2 +- .../examples/teams/create-membership.md | 2 +- .../server-rest/examples/teams/create.md | 2 +- .../examples/teams/delete-membership.md | 2 +- .../server-rest/examples/teams/delete.md | 2 +- .../examples/teams/get-membership.md | 2 +- .../server-rest/examples/teams/get-prefs.md | 2 +- .../1.9.x/server-rest/examples/teams/get.md | 2 +- .../examples/teams/list-memberships.md | 2 +- .../1.9.x/server-rest/examples/teams/list.md | 2 +- .../teams/update-membership-status.md | 2 +- .../examples/teams/update-membership.md | 2 +- .../server-rest/examples/teams/update-name.md | 2 +- .../examples/teams/update-prefs.md | 2 +- .../examples/tokens/create-file-token.md | 2 +- .../server-rest/examples/tokens/delete.md | 2 +- .../1.9.x/server-rest/examples/tokens/get.md | 2 +- .../1.9.x/server-rest/examples/tokens/list.md | 2 +- .../server-rest/examples/tokens/update.md | 2 +- .../examples/users/create-argon-2-user.md | 2 +- .../examples/users/create-bcrypt-user.md | 2 +- .../server-rest/examples/users/create-jwt.md | 2 +- .../examples/users/create-md-5-user.md | 2 +- .../users/create-mfa-recovery-codes.md | 2 +- .../examples/users/create-ph-pass-user.md | 2 +- .../users/create-scrypt-modified-user.md | 2 +- .../examples/users/create-scrypt-user.md | 2 +- .../examples/users/create-session.md | 2 +- .../examples/users/create-sha-user.md | 2 +- .../examples/users/create-target.md | 2 +- .../examples/users/create-token.md | 2 +- .../server-rest/examples/users/create.md | 2 +- .../examples/users/delete-identity.md | 2 +- .../users/delete-mfa-authenticator.md | 2 +- .../examples/users/delete-session.md | 2 +- .../examples/users/delete-sessions.md | 2 +- .../examples/users/delete-target.md | 2 +- .../server-rest/examples/users/delete.md | 2 +- .../examples/users/get-mfa-recovery-codes.md | 2 +- .../server-rest/examples/users/get-prefs.md | 2 +- .../server-rest/examples/users/get-target.md | 2 +- .../1.9.x/server-rest/examples/users/get.md | 2 +- .../examples/users/list-identities.md | 2 +- .../server-rest/examples/users/list-logs.md | 2 +- .../examples/users/list-memberships.md | 2 +- .../examples/users/list-mfa-factors.md | 2 +- .../examples/users/list-sessions.md | 2 +- .../examples/users/list-targets.md | 2 +- .../1.9.x/server-rest/examples/users/list.md | 2 +- .../users/update-email-verification.md | 2 +- .../examples/users/update-email.md | 2 +- .../examples/users/update-impersonator.md | 2 +- .../examples/users/update-labels.md | 2 +- .../users/update-mfa-recovery-codes.md | 2 +- .../server-rest/examples/users/update-mfa.md | 2 +- .../server-rest/examples/users/update-name.md | 2 +- .../examples/users/update-password.md | 2 +- .../users/update-phone-verification.md | 2 +- .../examples/users/update-phone.md | 2 +- .../examples/users/update-prefs.md | 2 +- .../examples/users/update-status.md | 2 +- .../examples/users/update-target.md | 2 +- .../server-rest/examples/webhooks/create.md | 2 +- .../server-rest/examples/webhooks/delete.md | 2 +- .../server-rest/examples/webhooks/get.md | 2 +- .../server-rest/examples/webhooks/list.md | 2 +- .../examples/webhooks/update-secret.md | 2 +- .../server-rest/examples/webhooks/update.md | 2 +- .../server-ruby/examples/functions/create.md | 2 +- .../server-ruby/examples/functions/update.md | 2 +- .../examples/project/create-ephemeral-key.md | 18 + .../examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 17 + .../examples/project/delete-mock-phone.md | 16 + .../server-ruby/examples/project/delete.md | 14 + .../examples/project/get-mock-phone.md | 16 + .../examples/project/get-o-auth-2-provider.md | 16 + .../examples/project/get-policy.md | 17 + .../examples/project/list-email-templates.md | 17 + .../examples/project/list-mock-phones.md | 17 + .../project/list-o-auth-2-providers.md | 14 + .../examples/project/list-policies.md | 17 + .../examples/project/update-auth-method.md | 18 + .../examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 17 + .../project/update-o-auth-2-amazon.md | 18 + .../examples/project/update-o-auth-2-apple.md | 20 + .../project/update-o-auth-2-auth-0.md | 19 + .../project/update-o-auth-2-authentik.md | 19 + .../project/update-o-auth-2-autodesk.md | 18 + .../project/update-o-auth-2-bitbucket.md | 18 + .../examples/project/update-o-auth-2-bitly.md | 18 + .../examples/project/update-o-auth-2-box.md | 18 + .../project/update-o-auth-2-dailymotion.md | 18 + .../project/update-o-auth-2-discord.md | 18 + .../project/update-o-auth-2-disqus.md | 18 + .../project/update-o-auth-2-dropbox.md | 18 + .../examples/project/update-o-auth-2-etsy.md | 18 + .../project/update-o-auth-2-facebook.md | 18 + .../examples/project/update-o-auth-2-figma.md | 18 + .../project/update-o-auth-2-fusion-auth.md | 19 + .../project/update-o-auth-2-git-hub.md | 18 + .../project/update-o-auth-2-gitlab.md | 19 + .../project/update-o-auth-2-google.md | 18 + .../project/update-o-auth-2-keycloak.md | 20 + .../examples/project/update-o-auth-2-kick.md | 18 + .../project/update-o-auth-2-linkedin.md | 18 + .../project/update-o-auth-2-microsoft.md | 19 + .../project/update-o-auth-2-notion.md | 18 + .../examples/project/update-o-auth-2-oidc.md | 22 + .../examples/project/update-o-auth-2-okta.md | 20 + .../project/update-o-auth-2-paypal-sandbox.md | 18 + .../project/update-o-auth-2-paypal.md | 18 + .../examples/project/update-o-auth-2-podio.md | 18 + .../project/update-o-auth-2-salesforce.md | 18 + .../examples/project/update-o-auth-2-slack.md | 18 + .../project/update-o-auth-2-spotify.md | 18 + .../project/update-o-auth-2-stripe.md | 18 + .../update-o-auth-2-tradeshift-sandbox.md | 18 + .../project/update-o-auth-2-tradeshift.md | 18 + .../project/update-o-auth-2-twitch.md | 18 + .../project/update-o-auth-2-word-press.md | 18 + .../examples/project/update-o-auth-2-yahoo.md | 18 + .../project/update-o-auth-2-yandex.md | 18 + .../examples/project/update-o-auth-2-zoho.md | 18 + .../examples/project/update-o-auth-2-zoom.md | 18 + .../examples/project/update-o-auth-2x.md | 18 + .../databases/update-boolean-attribute.md | 2 +- .../databases/update-datetime-attribute.md | 2 +- .../databases/update-email-attribute.md | 2 +- .../databases/update-enum-attribute.md | 2 +- .../databases/update-float-attribute.md | 2 +- .../databases/update-integer-attribute.md | 2 +- .../examples/databases/update-ip-attribute.md | 2 +- .../databases/update-longtext-attribute.md | 2 +- .../databases/update-mediumtext-attribute.md | 2 +- .../databases/update-string-attribute.md | 2 +- .../databases/update-text-attribute.md | 2 +- .../databases/update-url-attribute.md | 2 +- .../databases/update-varchar-attribute.md | 2 +- .../server-rust/examples/functions/create.md | 2 +- .../server-rust/examples/functions/update.md | 2 +- .../examples/project/create-ephemeral-key.md | 23 + .../examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 23 + .../examples/project/delete-mock-phone.md | 20 + .../server-rust/examples/project/delete.md | 18 + .../examples/project/get-mock-phone.md | 22 + .../examples/project/get-o-auth-2-provider.md | 22 + .../examples/project/get-policy.md | 22 + .../examples/project/list-email-templates.md | 23 + .../examples/project/list-mock-phones.md | 23 + .../project/list-o-auth-2-providers.md | 20 + .../examples/project/list-policies.md | 23 + .../examples/project/update-auth-method.md | 23 + .../examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 23 + .../project/update-o-auth-2-amazon.md | 24 + .../examples/project/update-o-auth-2-apple.md | 26 + .../project/update-o-auth-2-auth-0.md | 25 + .../project/update-o-auth-2-authentik.md | 25 + .../project/update-o-auth-2-autodesk.md | 24 + .../project/update-o-auth-2-bitbucket.md | 24 + .../examples/project/update-o-auth-2-bitly.md | 24 + .../examples/project/update-o-auth-2-box.md | 24 + .../project/update-o-auth-2-dailymotion.md | 24 + .../project/update-o-auth-2-discord.md | 24 + .../project/update-o-auth-2-disqus.md | 24 + .../project/update-o-auth-2-dropbox.md | 24 + .../examples/project/update-o-auth-2-etsy.md | 24 + .../project/update-o-auth-2-facebook.md | 24 + .../examples/project/update-o-auth-2-figma.md | 24 + .../project/update-o-auth-2-fusion-auth.md | 25 + .../project/update-o-auth-2-git-hub.md | 24 + .../project/update-o-auth-2-gitlab.md | 25 + .../project/update-o-auth-2-google.md | 24 + .../project/update-o-auth-2-keycloak.md | 26 + .../examples/project/update-o-auth-2-kick.md | 24 + .../project/update-o-auth-2-linkedin.md | 24 + .../project/update-o-auth-2-microsoft.md | 25 + .../project/update-o-auth-2-notion.md | 24 + .../examples/project/update-o-auth-2-oidc.md | 28 + .../examples/project/update-o-auth-2-okta.md | 26 + .../project/update-o-auth-2-paypal-sandbox.md | 24 + .../project/update-o-auth-2-paypal.md | 24 + .../examples/project/update-o-auth-2-podio.md | 24 + .../project/update-o-auth-2-salesforce.md | 24 + .../examples/project/update-o-auth-2-slack.md | 24 + .../project/update-o-auth-2-spotify.md | 24 + .../project/update-o-auth-2-stripe.md | 24 + .../update-o-auth-2-tradeshift-sandbox.md | 24 + .../project/update-o-auth-2-tradeshift.md | 24 + .../project/update-o-auth-2-twitch.md | 24 + .../project/update-o-auth-2-word-press.md | 24 + .../examples/project/update-o-auth-2-yahoo.md | 24 + .../project/update-o-auth-2-yandex.md | 24 + .../examples/project/update-o-auth-2-zoho.md | 24 + .../examples/project/update-o-auth-2-zoom.md | 24 + .../examples/project/update-o-auth-2x.md | 24 + .../project/update-password-history-policy.md | 2 +- .../project/update-session-limit-policy.md | 2 +- .../project/update-user-limit-policy.md | 2 +- .../tablesdb/update-boolean-column.md | 2 +- .../tablesdb/update-datetime-column.md | 2 +- .../examples/tablesdb/update-email-column.md | 2 +- .../examples/tablesdb/update-enum-column.md | 2 +- .../examples/tablesdb/update-float-column.md | 2 +- .../tablesdb/update-integer-column.md | 2 +- .../examples/tablesdb/update-ip-column.md | 2 +- .../tablesdb/update-longtext-column.md | 2 +- .../tablesdb/update-mediumtext-column.md | 2 +- .../examples/tablesdb/update-string-column.md | 2 +- .../examples/tablesdb/update-text-column.md | 2 +- .../examples/tablesdb/update-url-column.md | 2 +- .../tablesdb/update-varchar-column.md | 2 +- .../server-swift/examples/functions/create.md | 2 +- .../server-swift/examples/functions/update.md | 2 +- .../examples/project/create-ephemeral-key.md | 17 + .../examples/project/create-key.md | 2 +- .../examples/project/create-mock-phone.md | 16 + .../examples/project/delete-mock-phone.md | 15 + .../server-swift/examples/project/delete.md | 13 + .../examples/project/get-mock-phone.md | 15 + .../examples/project/get-o-auth-2-provider.md | 15 + .../examples/project/get-policy.md | 16 + .../examples/project/list-email-templates.md | 16 + .../examples/project/list-mock-phones.md | 16 + .../project/list-o-auth-2-providers.md | 13 + .../examples/project/list-policies.md | 16 + .../examples/project/update-auth-method.md | 17 + .../examples/project/update-key.md | 2 +- .../examples/project/update-mock-phone.md | 16 + .../project/update-o-auth-2-amazon.md | 17 + .../examples/project/update-o-auth-2-apple.md | 19 + .../project/update-o-auth-2-auth-0.md | 18 + .../project/update-o-auth-2-authentik.md | 18 + .../project/update-o-auth-2-autodesk.md | 17 + .../project/update-o-auth-2-bitbucket.md | 17 + .../examples/project/update-o-auth-2-bitly.md | 17 + .../examples/project/update-o-auth-2-box.md | 17 + .../project/update-o-auth-2-dailymotion.md | 17 + .../project/update-o-auth-2-discord.md | 17 + .../project/update-o-auth-2-disqus.md | 17 + .../project/update-o-auth-2-dropbox.md | 17 + .../examples/project/update-o-auth-2-etsy.md | 17 + .../project/update-o-auth-2-facebook.md | 17 + .../examples/project/update-o-auth-2-figma.md | 17 + .../project/update-o-auth-2-fusion-auth.md | 18 + .../project/update-o-auth-2-git-hub.md | 17 + .../project/update-o-auth-2-gitlab.md | 18 + .../project/update-o-auth-2-google.md | 17 + .../project/update-o-auth-2-keycloak.md | 19 + .../examples/project/update-o-auth-2-kick.md | 17 + .../project/update-o-auth-2-linkedin.md | 17 + .../project/update-o-auth-2-microsoft.md | 18 + .../project/update-o-auth-2-notion.md | 17 + .../examples/project/update-o-auth-2-oidc.md | 21 + .../examples/project/update-o-auth-2-okta.md | 19 + .../project/update-o-auth-2-paypal-sandbox.md | 17 + .../project/update-o-auth-2-paypal.md | 17 + .../examples/project/update-o-auth-2-podio.md | 17 + .../project/update-o-auth-2-salesforce.md | 17 + .../examples/project/update-o-auth-2-slack.md | 17 + .../project/update-o-auth-2-spotify.md | 17 + .../project/update-o-auth-2-stripe.md | 17 + .../update-o-auth-2-tradeshift-sandbox.md | 17 + .../project/update-o-auth-2-tradeshift.md | 17 + .../project/update-o-auth-2-twitch.md | 17 + .../project/update-o-auth-2-word-press.md | 17 + .../examples/project/update-o-auth-2-yahoo.md | 17 + .../project/update-o-auth-2-yandex.md | 17 + .../examples/project/update-o-auth-2-zoho.md | 17 + .../examples/project/update-o-auth-2-zoom.md | 17 + .../examples/project/update-o-auth-2x.md | 17 + specs/1.9.x/open-api3-1.9.x-client.json | 227 +- specs/1.9.x/open-api3-1.9.x-console.json | 52188 +++++++++------- specs/1.9.x/open-api3-1.9.x-server.json | 36943 ++++++----- specs/1.9.x/swagger2-1.9.x-client.json | 227 +- specs/1.9.x/swagger2-1.9.x-console.json | 51894 ++++++++------- specs/1.9.x/swagger2-1.9.x-server.json | 42381 +++++++------ 1581 files changed, 122312 insertions(+), 77733 deletions(-) create mode 100644 examples/1.9.x/console-cli/examples/manager/create-block.md create mode 100644 examples/1.9.x/console-cli/examples/manager/delete-block.md create mode 100644 examples/1.9.x/console-cli/examples/manager/list-blocks.md create mode 100644 examples/1.9.x/console-cli/examples/manager/update-user-status.md create mode 100644 examples/1.9.x/console-cli/examples/organizations/create-plan-estimation.md create mode 100644 examples/1.9.x/console-cli/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/console-cli/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/console-cli/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/console-cli/examples/project/delete.md create mode 100644 examples/1.9.x/console-cli/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/console-cli/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/console-cli/examples/project/get-policy.md create mode 100644 examples/1.9.x/console-cli/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/console-cli/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/console-cli/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/console-cli/examples/project/list-policies.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/console-cli/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/console-web/examples/console/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/console-web/examples/console/list-project-scopes.md create mode 100644 examples/1.9.x/console-web/examples/manager/create-block.md create mode 100644 examples/1.9.x/console-web/examples/manager/delete-block.md create mode 100644 examples/1.9.x/console-web/examples/manager/list-blocks.md create mode 100644 examples/1.9.x/console-web/examples/manager/update-user-status.md create mode 100644 examples/1.9.x/console-web/examples/organizations/create-plan-estimation.md create mode 100644 examples/1.9.x/console-web/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/console-web/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/console-web/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/console-web/examples/project/delete.md create mode 100644 examples/1.9.x/console-web/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/console-web/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/console-web/examples/project/get-policy.md create mode 100644 examples/1.9.x/console-web/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/console-web/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/console-web/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/console-web/examples/project/list-policies.md create mode 100644 examples/1.9.x/console-web/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/console-web/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/console-web/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-dart/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-dart/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-dart/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-dart/examples/project/delete.md create mode 100644 examples/1.9.x/server-dart/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-dart/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-dart/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-dart/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-dart/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-dart/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-dart/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-dart/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/delete.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-dotnet/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-go/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-go/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-go/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-go/examples/project/delete.md create mode 100644 examples/1.9.x/server-go/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-go/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-go/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-go/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-go/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-go/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-go/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-go/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-go/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-go/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-graphql/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-graphql/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-graphql/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-graphql/examples/project/delete.md create mode 100644 examples/1.9.x/server-graphql/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-graphql/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-graphql/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-graphql/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-graphql/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-graphql/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-graphql/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-graphql/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-kotlin/java/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-kotlin/java/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-kotlin/java/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-kotlin/java/project/delete.md create mode 100644 examples/1.9.x/server-kotlin/java/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-kotlin/java/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-kotlin/java/project/get-policy.md create mode 100644 examples/1.9.x/server-kotlin/java/project/list-email-templates.md create mode 100644 examples/1.9.x/server-kotlin/java/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-kotlin/java/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-kotlin/java/project/list-policies.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-auth-method.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-kotlin/java/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/delete.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/get-policy.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/list-email-templates.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/list-policies.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-auth-method.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/delete.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-nodejs/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-php/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-php/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-php/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-php/examples/project/delete.md create mode 100644 examples/1.9.x/server-php/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-php/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-php/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-php/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-php/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-php/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-php/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-php/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-php/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-php/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-python/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-python/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-python/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-python/examples/project/delete.md create mode 100644 examples/1.9.x/server-python/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-python/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-python/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-python/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-python/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-python/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-python/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-python/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-python/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-python/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-rest/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-rest/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-rest/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-rest/examples/project/delete.md create mode 100644 examples/1.9.x/server-rest/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-rest/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-rest/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-rest/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-rest/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-rest/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-rest/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-rest/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-ruby/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-ruby/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-ruby/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-ruby/examples/project/delete.md create mode 100644 examples/1.9.x/server-ruby/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-ruby/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-ruby/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-ruby/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-ruby/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-ruby/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-ruby/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-ruby/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-rust/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-rust/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-rust/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-rust/examples/project/delete.md create mode 100644 examples/1.9.x/server-rust/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-rust/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-rust/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-rust/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-rust/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-rust/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-rust/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-rust/examples/project/update-o-auth-2x.md create mode 100644 examples/1.9.x/server-swift/examples/project/create-ephemeral-key.md create mode 100644 examples/1.9.x/server-swift/examples/project/create-mock-phone.md create mode 100644 examples/1.9.x/server-swift/examples/project/delete-mock-phone.md create mode 100644 examples/1.9.x/server-swift/examples/project/delete.md create mode 100644 examples/1.9.x/server-swift/examples/project/get-mock-phone.md create mode 100644 examples/1.9.x/server-swift/examples/project/get-o-auth-2-provider.md create mode 100644 examples/1.9.x/server-swift/examples/project/get-policy.md create mode 100644 examples/1.9.x/server-swift/examples/project/list-email-templates.md create mode 100644 examples/1.9.x/server-swift/examples/project/list-mock-phones.md create mode 100644 examples/1.9.x/server-swift/examples/project/list-o-auth-2-providers.md create mode 100644 examples/1.9.x/server-swift/examples/project/list-policies.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-auth-method.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-mock-phone.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-amazon.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-apple.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-auth-0.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-authentik.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-autodesk.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-bitbucket.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-bitly.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-box.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-dailymotion.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-discord.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-disqus.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-dropbox.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-etsy.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-facebook.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-figma.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-fusion-auth.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-git-hub.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-gitlab.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-google.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-keycloak.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-kick.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-linkedin.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-microsoft.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-notion.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-oidc.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-okta.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-paypal-sandbox.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-paypal.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-podio.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-salesforce.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-slack.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-spotify.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-stripe.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-tradeshift-sandbox.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-tradeshift.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-twitch.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-word-press.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-yahoo.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-yandex.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-zoho.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2-zoom.md create mode 100644 examples/1.9.x/server-swift/examples/project/update-o-auth-2x.md diff --git a/examples/1.9.x/client-graphql/examples/storage/create-file.md b/examples/1.9.x/client-graphql/examples/storage/create-file.md index 075faaa0d..cf5ee49bb 100644 --- a/examples/1.9.x/client-graphql/examples/storage/create-file.md +++ b/examples/1.9.x/client-graphql/examples/storage/create-file.md @@ -2,7 +2,7 @@ POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-anonymous-session.md b/examples/1.9.x/client-rest/examples/account/create-anonymous-session.md index abb31c52b..633d10862 100644 --- a/examples/1.9.x/client-rest/examples/account/create-anonymous-session.md +++ b/examples/1.9.x/client-rest/examples/account/create-anonymous-session.md @@ -2,7 +2,7 @@ POST /v1/account/sessions/anonymous HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-email-password-session.md b/examples/1.9.x/client-rest/examples/account/create-email-password-session.md index fc3b785b1..0b93f1722 100644 --- a/examples/1.9.x/client-rest/examples/account/create-email-password-session.md +++ b/examples/1.9.x/client-rest/examples/account/create-email-password-session.md @@ -2,7 +2,7 @@ POST /v1/account/sessions/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-email-token.md b/examples/1.9.x/client-rest/examples/account/create-email-token.md index 9d5487edf..67deaa2a2 100644 --- a/examples/1.9.x/client-rest/examples/account/create-email-token.md +++ b/examples/1.9.x/client-rest/examples/account/create-email-token.md @@ -2,7 +2,7 @@ POST /v1/account/tokens/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-email-verification.md b/examples/1.9.x/client-rest/examples/account/create-email-verification.md index 278e27d4b..aedb22614 100644 --- a/examples/1.9.x/client-rest/examples/account/create-email-verification.md +++ b/examples/1.9.x/client-rest/examples/account/create-email-verification.md @@ -2,7 +2,7 @@ POST /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-jwt.md b/examples/1.9.x/client-rest/examples/account/create-jwt.md index 2f338bd42..5c95f61cf 100644 --- a/examples/1.9.x/client-rest/examples/account/create-jwt.md +++ b/examples/1.9.x/client-rest/examples/account/create-jwt.md @@ -2,7 +2,7 @@ POST /v1/account/jwts HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-magic-url-token.md b/examples/1.9.x/client-rest/examples/account/create-magic-url-token.md index 4a2fb939d..6e14589fe 100644 --- a/examples/1.9.x/client-rest/examples/account/create-magic-url-token.md +++ b/examples/1.9.x/client-rest/examples/account/create-magic-url-token.md @@ -2,7 +2,7 @@ POST /v1/account/tokens/magic-url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-mfa-authenticator.md b/examples/1.9.x/client-rest/examples/account/create-mfa-authenticator.md index 74dc6618b..c7d937009 100644 --- a/examples/1.9.x/client-rest/examples/account/create-mfa-authenticator.md +++ b/examples/1.9.x/client-rest/examples/account/create-mfa-authenticator.md @@ -2,7 +2,7 @@ POST /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-mfa-challenge.md b/examples/1.9.x/client-rest/examples/account/create-mfa-challenge.md index d4d65e323..a1bc7eeb6 100644 --- a/examples/1.9.x/client-rest/examples/account/create-mfa-challenge.md +++ b/examples/1.9.x/client-rest/examples/account/create-mfa-challenge.md @@ -2,7 +2,7 @@ POST /v1/account/mfa/challenges HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-mfa-recovery-codes.md b/examples/1.9.x/client-rest/examples/account/create-mfa-recovery-codes.md index 9a2e0b422..34a9cc030 100644 --- a/examples/1.9.x/client-rest/examples/account/create-mfa-recovery-codes.md +++ b/examples/1.9.x/client-rest/examples/account/create-mfa-recovery-codes.md @@ -2,7 +2,7 @@ POST /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-o-auth-2-session.md b/examples/1.9.x/client-rest/examples/account/create-o-auth-2-session.md index ef92feeda..83939c120 100644 --- a/examples/1.9.x/client-rest/examples/account/create-o-auth-2-session.md +++ b/examples/1.9.x/client-rest/examples/account/create-o-auth-2-session.md @@ -1,7 +1,7 @@ ```http GET /v1/account/sessions/oauth2/{provider} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-o-auth-2-token.md b/examples/1.9.x/client-rest/examples/account/create-o-auth-2-token.md index 257373c0b..baa48cd3c 100644 --- a/examples/1.9.x/client-rest/examples/account/create-o-auth-2-token.md +++ b/examples/1.9.x/client-rest/examples/account/create-o-auth-2-token.md @@ -1,7 +1,7 @@ ```http GET /v1/account/tokens/oauth2/{provider} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-phone-token.md b/examples/1.9.x/client-rest/examples/account/create-phone-token.md index be258f568..4392617e9 100644 --- a/examples/1.9.x/client-rest/examples/account/create-phone-token.md +++ b/examples/1.9.x/client-rest/examples/account/create-phone-token.md @@ -2,7 +2,7 @@ POST /v1/account/tokens/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-phone-verification.md b/examples/1.9.x/client-rest/examples/account/create-phone-verification.md index 8c909ba24..2543da46e 100644 --- a/examples/1.9.x/client-rest/examples/account/create-phone-verification.md +++ b/examples/1.9.x/client-rest/examples/account/create-phone-verification.md @@ -2,7 +2,7 @@ POST /v1/account/verifications/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-push-target.md b/examples/1.9.x/client-rest/examples/account/create-push-target.md index bd82cf5e8..bf6ed06e6 100644 --- a/examples/1.9.x/client-rest/examples/account/create-push-target.md +++ b/examples/1.9.x/client-rest/examples/account/create-push-target.md @@ -2,7 +2,7 @@ POST /v1/account/targets/push HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: diff --git a/examples/1.9.x/client-rest/examples/account/create-recovery.md b/examples/1.9.x/client-rest/examples/account/create-recovery.md index 9c6e1500e..7db763019 100644 --- a/examples/1.9.x/client-rest/examples/account/create-recovery.md +++ b/examples/1.9.x/client-rest/examples/account/create-recovery.md @@ -2,7 +2,7 @@ POST /v1/account/recovery HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-session.md b/examples/1.9.x/client-rest/examples/account/create-session.md index 0dd0eb2ca..7380aab0a 100644 --- a/examples/1.9.x/client-rest/examples/account/create-session.md +++ b/examples/1.9.x/client-rest/examples/account/create-session.md @@ -2,7 +2,7 @@ POST /v1/account/sessions/token HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create-verification.md b/examples/1.9.x/client-rest/examples/account/create-verification.md index 278e27d4b..aedb22614 100644 --- a/examples/1.9.x/client-rest/examples/account/create-verification.md +++ b/examples/1.9.x/client-rest/examples/account/create-verification.md @@ -2,7 +2,7 @@ POST /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/create.md b/examples/1.9.x/client-rest/examples/account/create.md index db3430111..5c216e5ad 100644 --- a/examples/1.9.x/client-rest/examples/account/create.md +++ b/examples/1.9.x/client-rest/examples/account/create.md @@ -2,7 +2,7 @@ POST /v1/account HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/delete-identity.md b/examples/1.9.x/client-rest/examples/account/delete-identity.md index f740ba15a..6d5f59c13 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-identity.md +++ b/examples/1.9.x/client-rest/examples/account/delete-identity.md @@ -2,7 +2,7 @@ DELETE /v1/account/identities/{identityId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/delete-mfa-authenticator.md b/examples/1.9.x/client-rest/examples/account/delete-mfa-authenticator.md index 144e1ed8a..8401f4b45 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-mfa-authenticator.md +++ b/examples/1.9.x/client-rest/examples/account/delete-mfa-authenticator.md @@ -2,7 +2,7 @@ DELETE /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/delete-push-target.md b/examples/1.9.x/client-rest/examples/account/delete-push-target.md index 8412985b8..5cb605f04 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-push-target.md +++ b/examples/1.9.x/client-rest/examples/account/delete-push-target.md @@ -2,7 +2,7 @@ DELETE /v1/account/targets/{targetId}/push HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: diff --git a/examples/1.9.x/client-rest/examples/account/delete-session.md b/examples/1.9.x/client-rest/examples/account/delete-session.md index 0d1b5685a..0f74214d1 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-session.md +++ b/examples/1.9.x/client-rest/examples/account/delete-session.md @@ -2,7 +2,7 @@ DELETE /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/delete-sessions.md b/examples/1.9.x/client-rest/examples/account/delete-sessions.md index d9f45ae82..821f826b7 100644 --- a/examples/1.9.x/client-rest/examples/account/delete-sessions.md +++ b/examples/1.9.x/client-rest/examples/account/delete-sessions.md @@ -2,7 +2,7 @@ DELETE /v1/account/sessions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/get-mfa-recovery-codes.md b/examples/1.9.x/client-rest/examples/account/get-mfa-recovery-codes.md index 69ce0a460..2c69f412c 100644 --- a/examples/1.9.x/client-rest/examples/account/get-mfa-recovery-codes.md +++ b/examples/1.9.x/client-rest/examples/account/get-mfa-recovery-codes.md @@ -1,7 +1,7 @@ ```http GET /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/get-prefs.md b/examples/1.9.x/client-rest/examples/account/get-prefs.md index 4a69ac91f..53ece5f7a 100644 --- a/examples/1.9.x/client-rest/examples/account/get-prefs.md +++ b/examples/1.9.x/client-rest/examples/account/get-prefs.md @@ -1,7 +1,7 @@ ```http GET /v1/account/prefs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/get-session.md b/examples/1.9.x/client-rest/examples/account/get-session.md index 662afe426..f35e063b0 100644 --- a/examples/1.9.x/client-rest/examples/account/get-session.md +++ b/examples/1.9.x/client-rest/examples/account/get-session.md @@ -1,7 +1,7 @@ ```http GET /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/get.md b/examples/1.9.x/client-rest/examples/account/get.md index 6a5d65f9f..310803497 100644 --- a/examples/1.9.x/client-rest/examples/account/get.md +++ b/examples/1.9.x/client-rest/examples/account/get.md @@ -1,7 +1,7 @@ ```http GET /v1/account HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/list-identities.md b/examples/1.9.x/client-rest/examples/account/list-identities.md index f9ca73bd6..fbe54ee18 100644 --- a/examples/1.9.x/client-rest/examples/account/list-identities.md +++ b/examples/1.9.x/client-rest/examples/account/list-identities.md @@ -1,7 +1,7 @@ ```http GET /v1/account/identities HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/list-logs.md b/examples/1.9.x/client-rest/examples/account/list-logs.md index 8298a0441..1ed8b116c 100644 --- a/examples/1.9.x/client-rest/examples/account/list-logs.md +++ b/examples/1.9.x/client-rest/examples/account/list-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/account/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/list-mfa-factors.md b/examples/1.9.x/client-rest/examples/account/list-mfa-factors.md index d84aeeba7..f2f5fbbcd 100644 --- a/examples/1.9.x/client-rest/examples/account/list-mfa-factors.md +++ b/examples/1.9.x/client-rest/examples/account/list-mfa-factors.md @@ -1,7 +1,7 @@ ```http GET /v1/account/mfa/factors HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/list-sessions.md b/examples/1.9.x/client-rest/examples/account/list-sessions.md index 4016f0881..b1da2d3f1 100644 --- a/examples/1.9.x/client-rest/examples/account/list-sessions.md +++ b/examples/1.9.x/client-rest/examples/account/list-sessions.md @@ -1,7 +1,7 @@ ```http GET /v1/account/sessions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-email-verification.md b/examples/1.9.x/client-rest/examples/account/update-email-verification.md index 6808a712c..514b3db2a 100644 --- a/examples/1.9.x/client-rest/examples/account/update-email-verification.md +++ b/examples/1.9.x/client-rest/examples/account/update-email-verification.md @@ -2,7 +2,7 @@ PUT /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-email.md b/examples/1.9.x/client-rest/examples/account/update-email.md index bbef632ad..310dc18cf 100644 --- a/examples/1.9.x/client-rest/examples/account/update-email.md +++ b/examples/1.9.x/client-rest/examples/account/update-email.md @@ -2,7 +2,7 @@ PATCH /v1/account/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-magic-url-session.md b/examples/1.9.x/client-rest/examples/account/update-magic-url-session.md index c56ab9cbb..1d2663167 100644 --- a/examples/1.9.x/client-rest/examples/account/update-magic-url-session.md +++ b/examples/1.9.x/client-rest/examples/account/update-magic-url-session.md @@ -2,7 +2,7 @@ PUT /v1/account/sessions/magic-url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-mfa-authenticator.md b/examples/1.9.x/client-rest/examples/account/update-mfa-authenticator.md index 92df4df4b..193935c69 100644 --- a/examples/1.9.x/client-rest/examples/account/update-mfa-authenticator.md +++ b/examples/1.9.x/client-rest/examples/account/update-mfa-authenticator.md @@ -2,7 +2,7 @@ PUT /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-mfa-challenge.md b/examples/1.9.x/client-rest/examples/account/update-mfa-challenge.md index 02f8ecac6..0a226266b 100644 --- a/examples/1.9.x/client-rest/examples/account/update-mfa-challenge.md +++ b/examples/1.9.x/client-rest/examples/account/update-mfa-challenge.md @@ -2,7 +2,7 @@ PUT /v1/account/mfa/challenges HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-mfa-recovery-codes.md b/examples/1.9.x/client-rest/examples/account/update-mfa-recovery-codes.md index fe197ec6b..b96489da1 100644 --- a/examples/1.9.x/client-rest/examples/account/update-mfa-recovery-codes.md +++ b/examples/1.9.x/client-rest/examples/account/update-mfa-recovery-codes.md @@ -2,7 +2,7 @@ PATCH /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-mfa.md b/examples/1.9.x/client-rest/examples/account/update-mfa.md index 6c7d2f325..4518a3e1d 100644 --- a/examples/1.9.x/client-rest/examples/account/update-mfa.md +++ b/examples/1.9.x/client-rest/examples/account/update-mfa.md @@ -2,7 +2,7 @@ PATCH /v1/account/mfa HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-name.md b/examples/1.9.x/client-rest/examples/account/update-name.md index b4877c831..2b92e524e 100644 --- a/examples/1.9.x/client-rest/examples/account/update-name.md +++ b/examples/1.9.x/client-rest/examples/account/update-name.md @@ -2,7 +2,7 @@ PATCH /v1/account/name HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-password.md b/examples/1.9.x/client-rest/examples/account/update-password.md index f36bc1128..ed3a1a678 100644 --- a/examples/1.9.x/client-rest/examples/account/update-password.md +++ b/examples/1.9.x/client-rest/examples/account/update-password.md @@ -2,7 +2,7 @@ PATCH /v1/account/password HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-phone-session.md b/examples/1.9.x/client-rest/examples/account/update-phone-session.md index 3b212d099..2e33ddd98 100644 --- a/examples/1.9.x/client-rest/examples/account/update-phone-session.md +++ b/examples/1.9.x/client-rest/examples/account/update-phone-session.md @@ -2,7 +2,7 @@ PUT /v1/account/sessions/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-phone-verification.md b/examples/1.9.x/client-rest/examples/account/update-phone-verification.md index d2de6a841..a9bcf32c7 100644 --- a/examples/1.9.x/client-rest/examples/account/update-phone-verification.md +++ b/examples/1.9.x/client-rest/examples/account/update-phone-verification.md @@ -2,7 +2,7 @@ PUT /v1/account/verifications/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-phone.md b/examples/1.9.x/client-rest/examples/account/update-phone.md index 11e14f6cf..1f3c62d09 100644 --- a/examples/1.9.x/client-rest/examples/account/update-phone.md +++ b/examples/1.9.x/client-rest/examples/account/update-phone.md @@ -2,7 +2,7 @@ PATCH /v1/account/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-prefs.md b/examples/1.9.x/client-rest/examples/account/update-prefs.md index 45ed9d7f7..045158548 100644 --- a/examples/1.9.x/client-rest/examples/account/update-prefs.md +++ b/examples/1.9.x/client-rest/examples/account/update-prefs.md @@ -2,7 +2,7 @@ PATCH /v1/account/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-push-target.md b/examples/1.9.x/client-rest/examples/account/update-push-target.md index f1f398026..975b50446 100644 --- a/examples/1.9.x/client-rest/examples/account/update-push-target.md +++ b/examples/1.9.x/client-rest/examples/account/update-push-target.md @@ -2,7 +2,7 @@ PUT /v1/account/targets/{targetId}/push HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: diff --git a/examples/1.9.x/client-rest/examples/account/update-recovery.md b/examples/1.9.x/client-rest/examples/account/update-recovery.md index b3e531a1a..6dd79f223 100644 --- a/examples/1.9.x/client-rest/examples/account/update-recovery.md +++ b/examples/1.9.x/client-rest/examples/account/update-recovery.md @@ -2,7 +2,7 @@ PUT /v1/account/recovery HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-session.md b/examples/1.9.x/client-rest/examples/account/update-session.md index 506e3af86..2b956d23b 100644 --- a/examples/1.9.x/client-rest/examples/account/update-session.md +++ b/examples/1.9.x/client-rest/examples/account/update-session.md @@ -2,7 +2,7 @@ PATCH /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-status.md b/examples/1.9.x/client-rest/examples/account/update-status.md index 57b8c77fd..1c3f02237 100644 --- a/examples/1.9.x/client-rest/examples/account/update-status.md +++ b/examples/1.9.x/client-rest/examples/account/update-status.md @@ -2,7 +2,7 @@ PATCH /v1/account/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/account/update-verification.md b/examples/1.9.x/client-rest/examples/account/update-verification.md index 6808a712c..514b3db2a 100644 --- a/examples/1.9.x/client-rest/examples/account/update-verification.md +++ b/examples/1.9.x/client-rest/examples/account/update-verification.md @@ -2,7 +2,7 @@ PUT /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/avatars/get-browser.md b/examples/1.9.x/client-rest/examples/avatars/get-browser.md index 2c2e98a1d..9deca03ed 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-browser.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-browser.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/browsers/{code} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/avatars/get-credit-card.md b/examples/1.9.x/client-rest/examples/avatars/get-credit-card.md index e74535526..2cc19d80e 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-credit-card.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/credit-cards/{code} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/avatars/get-favicon.md b/examples/1.9.x/client-rest/examples/avatars/get-favicon.md index 100fd7de5..8ac55190e 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-favicon.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-favicon.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/favicon HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/avatars/get-flag.md b/examples/1.9.x/client-rest/examples/avatars/get-flag.md index 8c89a9070..c2b00f428 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-flag.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-flag.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/flags/{code} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/avatars/get-image.md b/examples/1.9.x/client-rest/examples/avatars/get-image.md index 8573e7175..9a5fe5bdf 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-image.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-image.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/image HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/avatars/get-initials.md b/examples/1.9.x/client-rest/examples/avatars/get-initials.md index b8656cb7a..296e05f24 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-initials.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-initials.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/initials HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/avatars/get-qr.md b/examples/1.9.x/client-rest/examples/avatars/get-qr.md index 256a3e949..c48f5e1f9 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-qr.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-qr.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/qr HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/avatars/get-screenshot.md b/examples/1.9.x/client-rest/examples/avatars/get-screenshot.md index d67248c6b..fa7e66d63 100644 --- a/examples/1.9.x/client-rest/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/client-rest/examples/avatars/get-screenshot.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/screenshots HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/create-document.md b/examples/1.9.x/client-rest/examples/databases/create-document.md index caedf1d8e..e1aafdbb5 100644 --- a/examples/1.9.x/client-rest/examples/databases/create-document.md +++ b/examples/1.9.x/client-rest/examples/databases/create-document.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/create-operations.md b/examples/1.9.x/client-rest/examples/databases/create-operations.md index da46bb31a..01e94c722 100644 --- a/examples/1.9.x/client-rest/examples/databases/create-operations.md +++ b/examples/1.9.x/client-rest/examples/databases/create-operations.md @@ -2,7 +2,7 @@ POST /v1/databases/transactions/{transactionId}/operations HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/create-transaction.md b/examples/1.9.x/client-rest/examples/databases/create-transaction.md index fcbc82e03..7079170ca 100644 --- a/examples/1.9.x/client-rest/examples/databases/create-transaction.md +++ b/examples/1.9.x/client-rest/examples/databases/create-transaction.md @@ -2,7 +2,7 @@ POST /v1/databases/transactions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/decrement-document-attribute.md b/examples/1.9.x/client-rest/examples/databases/decrement-document-attribute.md index f8f0a09f3..54eb612f9 100644 --- a/examples/1.9.x/client-rest/examples/databases/decrement-document-attribute.md +++ b/examples/1.9.x/client-rest/examples/databases/decrement-document-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/delete-document.md b/examples/1.9.x/client-rest/examples/databases/delete-document.md index b7357613e..9e0aa1c90 100644 --- a/examples/1.9.x/client-rest/examples/databases/delete-document.md +++ b/examples/1.9.x/client-rest/examples/databases/delete-document.md @@ -2,7 +2,7 @@ DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/delete-transaction.md b/examples/1.9.x/client-rest/examples/databases/delete-transaction.md index 9b1d7c7a1..321bce36a 100644 --- a/examples/1.9.x/client-rest/examples/databases/delete-transaction.md +++ b/examples/1.9.x/client-rest/examples/databases/delete-transaction.md @@ -2,7 +2,7 @@ DELETE /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/get-document.md b/examples/1.9.x/client-rest/examples/databases/get-document.md index 6d6c6120a..ffcdd3c2b 100644 --- a/examples/1.9.x/client-rest/examples/databases/get-document.md +++ b/examples/1.9.x/client-rest/examples/databases/get-document.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/get-transaction.md b/examples/1.9.x/client-rest/examples/databases/get-transaction.md index d9be4a731..226da6d73 100644 --- a/examples/1.9.x/client-rest/examples/databases/get-transaction.md +++ b/examples/1.9.x/client-rest/examples/databases/get-transaction.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/increment-document-attribute.md b/examples/1.9.x/client-rest/examples/databases/increment-document-attribute.md index 07823a9c9..c3eb475e9 100644 --- a/examples/1.9.x/client-rest/examples/databases/increment-document-attribute.md +++ b/examples/1.9.x/client-rest/examples/databases/increment-document-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/list-documents.md b/examples/1.9.x/client-rest/examples/databases/list-documents.md index 8d96dc96b..3a5438c66 100644 --- a/examples/1.9.x/client-rest/examples/databases/list-documents.md +++ b/examples/1.9.x/client-rest/examples/databases/list-documents.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/list-transactions.md b/examples/1.9.x/client-rest/examples/databases/list-transactions.md index 93fb484c2..d384a2844 100644 --- a/examples/1.9.x/client-rest/examples/databases/list-transactions.md +++ b/examples/1.9.x/client-rest/examples/databases/list-transactions.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/transactions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/update-document.md b/examples/1.9.x/client-rest/examples/databases/update-document.md index 66b71e84f..5a3fc7384 100644 --- a/examples/1.9.x/client-rest/examples/databases/update-document.md +++ b/examples/1.9.x/client-rest/examples/databases/update-document.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/update-transaction.md b/examples/1.9.x/client-rest/examples/databases/update-transaction.md index fe7e095f6..34d93447f 100644 --- a/examples/1.9.x/client-rest/examples/databases/update-transaction.md +++ b/examples/1.9.x/client-rest/examples/databases/update-transaction.md @@ -2,7 +2,7 @@ PATCH /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/databases/upsert-document.md b/examples/1.9.x/client-rest/examples/databases/upsert-document.md index d3004e11c..424d6acf3 100644 --- a/examples/1.9.x/client-rest/examples/databases/upsert-document.md +++ b/examples/1.9.x/client-rest/examples/databases/upsert-document.md @@ -2,7 +2,7 @@ PUT /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/functions/create-execution.md b/examples/1.9.x/client-rest/examples/functions/create-execution.md index 34ab88352..fd7be4ce5 100644 --- a/examples/1.9.x/client-rest/examples/functions/create-execution.md +++ b/examples/1.9.x/client-rest/examples/functions/create-execution.md @@ -2,7 +2,7 @@ POST /v1/functions/{functionId}/executions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/functions/get-execution.md b/examples/1.9.x/client-rest/examples/functions/get-execution.md index 53069677f..02a198b3c 100644 --- a/examples/1.9.x/client-rest/examples/functions/get-execution.md +++ b/examples/1.9.x/client-rest/examples/functions/get-execution.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/functions/list-executions.md b/examples/1.9.x/client-rest/examples/functions/list-executions.md index 62aed1434..4c38725dd 100644 --- a/examples/1.9.x/client-rest/examples/functions/list-executions.md +++ b/examples/1.9.x/client-rest/examples/functions/list-executions.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/executions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/graphql/mutation.md b/examples/1.9.x/client-rest/examples/graphql/mutation.md index c640380c9..8e916b709 100644 --- a/examples/1.9.x/client-rest/examples/graphql/mutation.md +++ b/examples/1.9.x/client-rest/examples/graphql/mutation.md @@ -3,7 +3,7 @@ POST /v1/graphql/mutation HTTP/1.1 Host: cloud.appwrite.io X-Sdk-Graphql: true Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/graphql/query.md b/examples/1.9.x/client-rest/examples/graphql/query.md index 8f8d8e346..7de863877 100644 --- a/examples/1.9.x/client-rest/examples/graphql/query.md +++ b/examples/1.9.x/client-rest/examples/graphql/query.md @@ -3,7 +3,7 @@ POST /v1/graphql HTTP/1.1 Host: cloud.appwrite.io X-Sdk-Graphql: true Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/locale/get.md b/examples/1.9.x/client-rest/examples/locale/get.md index 4777bc61f..b9e962f20 100644 --- a/examples/1.9.x/client-rest/examples/locale/get.md +++ b/examples/1.9.x/client-rest/examples/locale/get.md @@ -1,7 +1,7 @@ ```http GET /v1/locale HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/locale/list-codes.md b/examples/1.9.x/client-rest/examples/locale/list-codes.md index 92f0b7423..ac4ae346c 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-codes.md +++ b/examples/1.9.x/client-rest/examples/locale/list-codes.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/codes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/locale/list-continents.md b/examples/1.9.x/client-rest/examples/locale/list-continents.md index 82b4fb273..d232b25ca 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-continents.md +++ b/examples/1.9.x/client-rest/examples/locale/list-continents.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/continents HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/locale/list-countries-eu.md b/examples/1.9.x/client-rest/examples/locale/list-countries-eu.md index 56e5395c6..63859b5a6 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-countries-eu.md +++ b/examples/1.9.x/client-rest/examples/locale/list-countries-eu.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/countries/eu HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/locale/list-countries-phones.md b/examples/1.9.x/client-rest/examples/locale/list-countries-phones.md index e58eb708b..8812317a2 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-countries-phones.md +++ b/examples/1.9.x/client-rest/examples/locale/list-countries-phones.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/countries/phones HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/locale/list-countries.md b/examples/1.9.x/client-rest/examples/locale/list-countries.md index 344546646..540fa3e21 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-countries.md +++ b/examples/1.9.x/client-rest/examples/locale/list-countries.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/countries HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/locale/list-currencies.md b/examples/1.9.x/client-rest/examples/locale/list-currencies.md index f5d6a3250..f2a0c027a 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-currencies.md +++ b/examples/1.9.x/client-rest/examples/locale/list-currencies.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/currencies HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/locale/list-languages.md b/examples/1.9.x/client-rest/examples/locale/list-languages.md index 04033f033..d661e2392 100644 --- a/examples/1.9.x/client-rest/examples/locale/list-languages.md +++ b/examples/1.9.x/client-rest/examples/locale/list-languages.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/languages HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/messaging/create-subscriber.md b/examples/1.9.x/client-rest/examples/messaging/create-subscriber.md index 05c04a22d..1d8580449 100644 --- a/examples/1.9.x/client-rest/examples/messaging/create-subscriber.md +++ b/examples/1.9.x/client-rest/examples/messaging/create-subscriber.md @@ -2,7 +2,7 @@ POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-JWT: X-Appwrite-Session: diff --git a/examples/1.9.x/client-rest/examples/messaging/delete-subscriber.md b/examples/1.9.x/client-rest/examples/messaging/delete-subscriber.md index 776bb28d4..32211c462 100644 --- a/examples/1.9.x/client-rest/examples/messaging/delete-subscriber.md +++ b/examples/1.9.x/client-rest/examples/messaging/delete-subscriber.md @@ -2,7 +2,7 @@ DELETE /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-JWT: X-Appwrite-Session: diff --git a/examples/1.9.x/client-rest/examples/storage/create-file.md b/examples/1.9.x/client-rest/examples/storage/create-file.md index 3709ca8ff..f23561d0d 100644 --- a/examples/1.9.x/client-rest/examples/storage/create-file.md +++ b/examples/1.9.x/client-rest/examples/storage/create-file.md @@ -2,7 +2,7 @@ POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/storage/delete-file.md b/examples/1.9.x/client-rest/examples/storage/delete-file.md index 45f0dfec0..618e2afd5 100644 --- a/examples/1.9.x/client-rest/examples/storage/delete-file.md +++ b/examples/1.9.x/client-rest/examples/storage/delete-file.md @@ -2,7 +2,7 @@ DELETE /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/storage/get-file-download.md b/examples/1.9.x/client-rest/examples/storage/get-file-download.md index 6e8d385db..e3744a003 100644 --- a/examples/1.9.x/client-rest/examples/storage/get-file-download.md +++ b/examples/1.9.x/client-rest/examples/storage/get-file-download.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/download HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/storage/get-file-preview.md b/examples/1.9.x/client-rest/examples/storage/get-file-preview.md index abcffbfa5..4d628effa 100644 --- a/examples/1.9.x/client-rest/examples/storage/get-file-preview.md +++ b/examples/1.9.x/client-rest/examples/storage/get-file-preview.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/preview HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/storage/get-file-view.md b/examples/1.9.x/client-rest/examples/storage/get-file-view.md index afe841bc0..52f78ca43 100644 --- a/examples/1.9.x/client-rest/examples/storage/get-file-view.md +++ b/examples/1.9.x/client-rest/examples/storage/get-file-view.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/view HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/storage/get-file.md b/examples/1.9.x/client-rest/examples/storage/get-file.md index af988b349..b1c71d7db 100644 --- a/examples/1.9.x/client-rest/examples/storage/get-file.md +++ b/examples/1.9.x/client-rest/examples/storage/get-file.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/storage/list-files.md b/examples/1.9.x/client-rest/examples/storage/list-files.md index f84f3c4c7..9184d33bc 100644 --- a/examples/1.9.x/client-rest/examples/storage/list-files.md +++ b/examples/1.9.x/client-rest/examples/storage/list-files.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/storage/update-file.md b/examples/1.9.x/client-rest/examples/storage/update-file.md index 4c2abfdee..9d0a26a70 100644 --- a/examples/1.9.x/client-rest/examples/storage/update-file.md +++ b/examples/1.9.x/client-rest/examples/storage/update-file.md @@ -2,7 +2,7 @@ PUT /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/create-operations.md b/examples/1.9.x/client-rest/examples/tablesdb/create-operations.md index c276d9422..bc3f1371a 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/create-operations.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/create-operations.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/transactions/{transactionId}/operations HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/create-row.md b/examples/1.9.x/client-rest/examples/tablesdb/create-row.md index 0b8f91f9d..6bec6bd5a 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/create-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/create-row.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/create-transaction.md b/examples/1.9.x/client-rest/examples/tablesdb/create-transaction.md index bbac803f9..443874e38 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/create-transaction.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/create-transaction.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/transactions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/decrement-row-column.md b/examples/1.9.x/client-rest/examples/tablesdb/decrement-row-column.md index 67e56a4e5..6226a3d94 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/decrement-row-column.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/decrement-row-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/decrement HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md b/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md index 2b9866120..7c2d6dabe 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/delete-transaction.md b/examples/1.9.x/client-rest/examples/tablesdb/delete-transaction.md index cf1402d8c..6910fea47 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/delete-transaction.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/delete-transaction.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/get-row.md b/examples/1.9.x/client-rest/examples/tablesdb/get-row.md index 6472a2f8f..4f15ecae4 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/get-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/get-row.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/get-transaction.md b/examples/1.9.x/client-rest/examples/tablesdb/get-transaction.md index 6e3078653..8d23d4434 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/get-transaction.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/get-transaction.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/increment-row-column.md b/examples/1.9.x/client-rest/examples/tablesdb/increment-row-column.md index f575890a7..7d1fe42f8 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/increment-row-column.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/increment-row-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/increment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/list-rows.md b/examples/1.9.x/client-rest/examples/tablesdb/list-rows.md index 722acb198..e4d74f1f7 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/list-rows.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/list-rows.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/list-transactions.md b/examples/1.9.x/client-rest/examples/tablesdb/list-transactions.md index a34489be8..9fd4df3d1 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/list-transactions.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/list-transactions.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/transactions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/update-row.md b/examples/1.9.x/client-rest/examples/tablesdb/update-row.md index 52ccb2fdf..548ec2416 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/update-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/update-row.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/update-transaction.md b/examples/1.9.x/client-rest/examples/tablesdb/update-transaction.md index 7933d1d4c..1ed24af8f 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/update-transaction.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/update-transaction.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/tablesdb/upsert-row.md b/examples/1.9.x/client-rest/examples/tablesdb/upsert-row.md index 2982e0cd8..17f91df14 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/upsert-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/upsert-row.md @@ -2,7 +2,7 @@ PUT /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/create-membership.md b/examples/1.9.x/client-rest/examples/teams/create-membership.md index 305105d92..9fcc9744c 100644 --- a/examples/1.9.x/client-rest/examples/teams/create-membership.md +++ b/examples/1.9.x/client-rest/examples/teams/create-membership.md @@ -2,7 +2,7 @@ POST /v1/teams/{teamId}/memberships HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/create.md b/examples/1.9.x/client-rest/examples/teams/create.md index 12b66b277..6ed27ba92 100644 --- a/examples/1.9.x/client-rest/examples/teams/create.md +++ b/examples/1.9.x/client-rest/examples/teams/create.md @@ -2,7 +2,7 @@ POST /v1/teams HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/delete-membership.md b/examples/1.9.x/client-rest/examples/teams/delete-membership.md index 7fd2be7ee..0f7fa4995 100644 --- a/examples/1.9.x/client-rest/examples/teams/delete-membership.md +++ b/examples/1.9.x/client-rest/examples/teams/delete-membership.md @@ -2,7 +2,7 @@ DELETE /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/delete.md b/examples/1.9.x/client-rest/examples/teams/delete.md index a811ea729..ad923d36a 100644 --- a/examples/1.9.x/client-rest/examples/teams/delete.md +++ b/examples/1.9.x/client-rest/examples/teams/delete.md @@ -2,7 +2,7 @@ DELETE /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/get-membership.md b/examples/1.9.x/client-rest/examples/teams/get-membership.md index cd6ddcf16..b9f4bcd66 100644 --- a/examples/1.9.x/client-rest/examples/teams/get-membership.md +++ b/examples/1.9.x/client-rest/examples/teams/get-membership.md @@ -1,7 +1,7 @@ ```http GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/get-prefs.md b/examples/1.9.x/client-rest/examples/teams/get-prefs.md index fa9787ad4..29c800ed9 100644 --- a/examples/1.9.x/client-rest/examples/teams/get-prefs.md +++ b/examples/1.9.x/client-rest/examples/teams/get-prefs.md @@ -1,7 +1,7 @@ ```http GET /v1/teams/{teamId}/prefs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/get.md b/examples/1.9.x/client-rest/examples/teams/get.md index 8e1f51afd..94597df19 100644 --- a/examples/1.9.x/client-rest/examples/teams/get.md +++ b/examples/1.9.x/client-rest/examples/teams/get.md @@ -1,7 +1,7 @@ ```http GET /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/list-memberships.md b/examples/1.9.x/client-rest/examples/teams/list-memberships.md index d50168dab..2b157f179 100644 --- a/examples/1.9.x/client-rest/examples/teams/list-memberships.md +++ b/examples/1.9.x/client-rest/examples/teams/list-memberships.md @@ -1,7 +1,7 @@ ```http GET /v1/teams/{teamId}/memberships HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/list.md b/examples/1.9.x/client-rest/examples/teams/list.md index 7c033a0bb..f8e5d2035 100644 --- a/examples/1.9.x/client-rest/examples/teams/list.md +++ b/examples/1.9.x/client-rest/examples/teams/list.md @@ -1,7 +1,7 @@ ```http GET /v1/teams HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/update-membership-status.md b/examples/1.9.x/client-rest/examples/teams/update-membership-status.md index 87b5ab403..e7e20952c 100644 --- a/examples/1.9.x/client-rest/examples/teams/update-membership-status.md +++ b/examples/1.9.x/client-rest/examples/teams/update-membership-status.md @@ -2,7 +2,7 @@ PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/update-membership.md b/examples/1.9.x/client-rest/examples/teams/update-membership.md index 8795b767b..ac70c5508 100644 --- a/examples/1.9.x/client-rest/examples/teams/update-membership.md +++ b/examples/1.9.x/client-rest/examples/teams/update-membership.md @@ -2,7 +2,7 @@ PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/update-name.md b/examples/1.9.x/client-rest/examples/teams/update-name.md index f1029774a..f3cfd2df0 100644 --- a/examples/1.9.x/client-rest/examples/teams/update-name.md +++ b/examples/1.9.x/client-rest/examples/teams/update-name.md @@ -2,7 +2,7 @@ PUT /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/client-rest/examples/teams/update-prefs.md b/examples/1.9.x/client-rest/examples/teams/update-prefs.md index 186eda636..b76054e8f 100644 --- a/examples/1.9.x/client-rest/examples/teams/update-prefs.md +++ b/examples/1.9.x/client-rest/examples/teams/update-prefs.md @@ -2,7 +2,7 @@ PUT /v1/teams/{teamId}/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/console-cli/examples/account/list-identities.md b/examples/1.9.x/console-cli/examples/account/list-identities.md index 583d515c9..ecc5d6853 100644 --- a/examples/1.9.x/console-cli/examples/account/list-identities.md +++ b/examples/1.9.x/console-cli/examples/account/list-identities.md @@ -1,3 +1,4 @@ ```bash -appwrite account list-identities +appwrite account list-identities \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/account/list-logs.md b/examples/1.9.x/console-cli/examples/account/list-logs.md index 2414a8aa7..5149c953d 100644 --- a/examples/1.9.x/console-cli/examples/account/list-logs.md +++ b/examples/1.9.x/console-cli/examples/account/list-logs.md @@ -1,3 +1,4 @@ ```bash -appwrite account list-logs +appwrite account list-logs \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/backups/list-archives.md b/examples/1.9.x/console-cli/examples/backups/list-archives.md index 81a64aa15..403c03959 100644 --- a/examples/1.9.x/console-cli/examples/backups/list-archives.md +++ b/examples/1.9.x/console-cli/examples/backups/list-archives.md @@ -1,3 +1,4 @@ ```bash -appwrite backups list-archives +appwrite backups list-archives \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/backups/list-policies.md b/examples/1.9.x/console-cli/examples/backups/list-policies.md index 29feba3dd..cdaccd027 100644 --- a/examples/1.9.x/console-cli/examples/backups/list-policies.md +++ b/examples/1.9.x/console-cli/examples/backups/list-policies.md @@ -1,3 +1,4 @@ ```bash -appwrite backups list-policies +appwrite backups list-policies \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/backups/list-restorations.md b/examples/1.9.x/console-cli/examples/backups/list-restorations.md index aba2d2a0e..37406de15 100644 --- a/examples/1.9.x/console-cli/examples/backups/list-restorations.md +++ b/examples/1.9.x/console-cli/examples/backups/list-restorations.md @@ -1,3 +1,4 @@ ```bash -appwrite backups list-restorations +appwrite backups list-restorations \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/delete-documents.md b/examples/1.9.x/console-cli/examples/databases/delete-documents.md index 081420c54..7b1b3cb31 100644 --- a/examples/1.9.x/console-cli/examples/databases/delete-documents.md +++ b/examples/1.9.x/console-cli/examples/databases/delete-documents.md @@ -1,5 +1,6 @@ ```bash appwrite databases delete-documents \ --database-id \ - --collection-id + --collection-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list-attributes.md b/examples/1.9.x/console-cli/examples/databases/list-attributes.md index e38711de5..677b7e1f0 100644 --- a/examples/1.9.x/console-cli/examples/databases/list-attributes.md +++ b/examples/1.9.x/console-cli/examples/databases/list-attributes.md @@ -1,5 +1,6 @@ ```bash appwrite databases list-attributes \ --database-id \ - --collection-id + --collection-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list-collection-logs.md b/examples/1.9.x/console-cli/examples/databases/list-collection-logs.md index fe4f7cdcb..63f62f502 100644 --- a/examples/1.9.x/console-cli/examples/databases/list-collection-logs.md +++ b/examples/1.9.x/console-cli/examples/databases/list-collection-logs.md @@ -1,5 +1,6 @@ ```bash appwrite databases list-collection-logs \ --database-id \ - --collection-id + --collection-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list-collections.md b/examples/1.9.x/console-cli/examples/databases/list-collections.md index 9e71024ef..6935aeb0f 100644 --- a/examples/1.9.x/console-cli/examples/databases/list-collections.md +++ b/examples/1.9.x/console-cli/examples/databases/list-collections.md @@ -1,4 +1,5 @@ ```bash appwrite databases list-collections \ - --database-id + --database-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list-document-logs.md b/examples/1.9.x/console-cli/examples/databases/list-document-logs.md index 6ee590eaa..0c5b5521d 100644 --- a/examples/1.9.x/console-cli/examples/databases/list-document-logs.md +++ b/examples/1.9.x/console-cli/examples/databases/list-document-logs.md @@ -2,5 +2,6 @@ appwrite databases list-document-logs \ --database-id \ --collection-id \ - --document-id + --document-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list-documents.md b/examples/1.9.x/console-cli/examples/databases/list-documents.md index 34e875186..9a1e55a66 100644 --- a/examples/1.9.x/console-cli/examples/databases/list-documents.md +++ b/examples/1.9.x/console-cli/examples/databases/list-documents.md @@ -1,5 +1,6 @@ ```bash appwrite databases list-documents \ --database-id \ - --collection-id + --collection-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list-indexes.md b/examples/1.9.x/console-cli/examples/databases/list-indexes.md index c660a669e..7ba7a81d2 100644 --- a/examples/1.9.x/console-cli/examples/databases/list-indexes.md +++ b/examples/1.9.x/console-cli/examples/databases/list-indexes.md @@ -1,5 +1,6 @@ ```bash appwrite databases list-indexes \ --database-id \ - --collection-id + --collection-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list-logs.md b/examples/1.9.x/console-cli/examples/databases/list-logs.md index fbb6aac3b..d205ea6f7 100644 --- a/examples/1.9.x/console-cli/examples/databases/list-logs.md +++ b/examples/1.9.x/console-cli/examples/databases/list-logs.md @@ -1,4 +1,5 @@ ```bash appwrite databases list-logs \ - --database-id + --database-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list-transactions.md b/examples/1.9.x/console-cli/examples/databases/list-transactions.md index d3857f3a9..f74d48bc0 100644 --- a/examples/1.9.x/console-cli/examples/databases/list-transactions.md +++ b/examples/1.9.x/console-cli/examples/databases/list-transactions.md @@ -1,3 +1,4 @@ ```bash -appwrite databases list-transactions +appwrite databases list-transactions \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/list.md b/examples/1.9.x/console-cli/examples/databases/list.md index b3475f33c..dd8c3bb09 100644 --- a/examples/1.9.x/console-cli/examples/databases/list.md +++ b/examples/1.9.x/console-cli/examples/databases/list.md @@ -1,3 +1,4 @@ ```bash -appwrite databases list +appwrite databases list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/databases/update-documents.md b/examples/1.9.x/console-cli/examples/databases/update-documents.md index 4047ec8d6..27f825402 100644 --- a/examples/1.9.x/console-cli/examples/databases/update-documents.md +++ b/examples/1.9.x/console-cli/examples/databases/update-documents.md @@ -1,5 +1,6 @@ ```bash appwrite databases update-documents \ --database-id \ - --collection-id + --collection-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/functions/list-deployments.md b/examples/1.9.x/console-cli/examples/functions/list-deployments.md index c47edd24a..db7090061 100644 --- a/examples/1.9.x/console-cli/examples/functions/list-deployments.md +++ b/examples/1.9.x/console-cli/examples/functions/list-deployments.md @@ -1,4 +1,5 @@ ```bash appwrite functions list-deployments \ - --function-id + --function-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/functions/list-executions.md b/examples/1.9.x/console-cli/examples/functions/list-executions.md index d04eeb8e6..1b82ec5e7 100644 --- a/examples/1.9.x/console-cli/examples/functions/list-executions.md +++ b/examples/1.9.x/console-cli/examples/functions/list-executions.md @@ -1,4 +1,5 @@ ```bash appwrite functions list-executions \ - --function-id + --function-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/functions/list.md b/examples/1.9.x/console-cli/examples/functions/list.md index 173245824..9542b5c7a 100644 --- a/examples/1.9.x/console-cli/examples/functions/list.md +++ b/examples/1.9.x/console-cli/examples/functions/list.md @@ -1,3 +1,4 @@ ```bash -appwrite functions list +appwrite functions list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/manager/create-block.md b/examples/1.9.x/console-cli/examples/manager/create-block.md new file mode 100644 index 000000000..98c2339bc --- /dev/null +++ b/examples/1.9.x/console-cli/examples/manager/create-block.md @@ -0,0 +1,5 @@ +```bash +appwrite manager create-block \ + --project-id \ + --resource-type projects +``` diff --git a/examples/1.9.x/console-cli/examples/manager/delete-block.md b/examples/1.9.x/console-cli/examples/manager/delete-block.md new file mode 100644 index 000000000..04d7ce4ec --- /dev/null +++ b/examples/1.9.x/console-cli/examples/manager/delete-block.md @@ -0,0 +1,5 @@ +```bash +appwrite manager delete-block \ + --project-id \ + --resource-type projects +``` diff --git a/examples/1.9.x/console-cli/examples/manager/list-blocks.md b/examples/1.9.x/console-cli/examples/manager/list-blocks.md new file mode 100644 index 000000000..cdc4a0ed0 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/manager/list-blocks.md @@ -0,0 +1,4 @@ +```bash +appwrite manager list-blocks \ + --project-id +``` diff --git a/examples/1.9.x/console-cli/examples/manager/update-user-status.md b/examples/1.9.x/console-cli/examples/manager/update-user-status.md new file mode 100644 index 000000000..3161f7049 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/manager/update-user-status.md @@ -0,0 +1,4 @@ +```bash +appwrite manager update-user-status \ + --status false +``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-message-logs.md b/examples/1.9.x/console-cli/examples/messaging/list-message-logs.md index 45b14aa3b..e5278e5cd 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-message-logs.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-message-logs.md @@ -1,4 +1,5 @@ ```bash appwrite messaging list-message-logs \ - --message-id + --message-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-messages.md b/examples/1.9.x/console-cli/examples/messaging/list-messages.md index 3efe74592..fbbdea826 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-messages.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-messages.md @@ -1,3 +1,4 @@ ```bash -appwrite messaging list-messages +appwrite messaging list-messages \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-provider-logs.md b/examples/1.9.x/console-cli/examples/messaging/list-provider-logs.md index ca94e5119..c71e14493 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-provider-logs.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-provider-logs.md @@ -1,4 +1,5 @@ ```bash appwrite messaging list-provider-logs \ - --provider-id + --provider-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-providers.md b/examples/1.9.x/console-cli/examples/messaging/list-providers.md index 6fa490ab3..787ee524a 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-providers.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-providers.md @@ -1,3 +1,4 @@ ```bash -appwrite messaging list-providers +appwrite messaging list-providers \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-subscriber-logs.md b/examples/1.9.x/console-cli/examples/messaging/list-subscriber-logs.md index 5dc4100f2..c42b88442 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-subscriber-logs.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-subscriber-logs.md @@ -1,4 +1,5 @@ ```bash appwrite messaging list-subscriber-logs \ - --subscriber-id + --subscriber-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-subscribers.md b/examples/1.9.x/console-cli/examples/messaging/list-subscribers.md index 1431c324c..bc7d33404 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-subscribers.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-subscribers.md @@ -1,4 +1,5 @@ ```bash appwrite messaging list-subscribers \ - --topic-id + --topic-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-targets.md b/examples/1.9.x/console-cli/examples/messaging/list-targets.md index 08072882e..d49b1922e 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-targets.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-targets.md @@ -1,4 +1,5 @@ ```bash appwrite messaging list-targets \ - --message-id + --message-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-topic-logs.md b/examples/1.9.x/console-cli/examples/messaging/list-topic-logs.md index 3bcda10fa..bdfe5a958 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-topic-logs.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-topic-logs.md @@ -1,4 +1,5 @@ ```bash appwrite messaging list-topic-logs \ - --topic-id + --topic-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/messaging/list-topics.md b/examples/1.9.x/console-cli/examples/messaging/list-topics.md index 87e895e06..3cb2a5dd2 100644 --- a/examples/1.9.x/console-cli/examples/messaging/list-topics.md +++ b/examples/1.9.x/console-cli/examples/messaging/list-topics.md @@ -1,3 +1,4 @@ ```bash -appwrite messaging list-topics +appwrite messaging list-topics \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/migrations/create-csv-export.md b/examples/1.9.x/console-cli/examples/migrations/create-csv-export.md index 0e2a463ea..4f00222e6 100644 --- a/examples/1.9.x/console-cli/examples/migrations/create-csv-export.md +++ b/examples/1.9.x/console-cli/examples/migrations/create-csv-export.md @@ -1,5 +1,6 @@ ```bash appwrite migrations create-csv-export \ --resource-id \ - --filename + --filename \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/migrations/create-json-export.md b/examples/1.9.x/console-cli/examples/migrations/create-json-export.md index 9c87078c2..5dbf4d624 100644 --- a/examples/1.9.x/console-cli/examples/migrations/create-json-export.md +++ b/examples/1.9.x/console-cli/examples/migrations/create-json-export.md @@ -1,5 +1,6 @@ ```bash appwrite migrations create-json-export \ --resource-id \ - --filename + --filename \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/migrations/list.md b/examples/1.9.x/console-cli/examples/migrations/list.md index ffc69a201..7aa5c19f4 100644 --- a/examples/1.9.x/console-cli/examples/migrations/list.md +++ b/examples/1.9.x/console-cli/examples/migrations/list.md @@ -1,3 +1,4 @@ ```bash -appwrite migrations list +appwrite migrations list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/organizations/create-plan-estimation.md b/examples/1.9.x/console-cli/examples/organizations/create-plan-estimation.md new file mode 100644 index 000000000..c84bac276 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/organizations/create-plan-estimation.md @@ -0,0 +1,5 @@ +```bash +appwrite organizations create-plan-estimation \ + --organization-id \ + --billing-plan tier-0 +``` diff --git a/examples/1.9.x/console-cli/examples/organizations/list-aggregations.md b/examples/1.9.x/console-cli/examples/organizations/list-aggregations.md index d93be54da..200d8e4d8 100644 --- a/examples/1.9.x/console-cli/examples/organizations/list-aggregations.md +++ b/examples/1.9.x/console-cli/examples/organizations/list-aggregations.md @@ -1,4 +1,5 @@ ```bash appwrite organizations list-aggregations \ - --organization-id + --organization-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/organizations/list-credits.md b/examples/1.9.x/console-cli/examples/organizations/list-credits.md index 73ee191a4..5d8f9d1db 100644 --- a/examples/1.9.x/console-cli/examples/organizations/list-credits.md +++ b/examples/1.9.x/console-cli/examples/organizations/list-credits.md @@ -1,4 +1,5 @@ ```bash appwrite organizations list-credits \ - --organization-id + --organization-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/organizations/list.md b/examples/1.9.x/console-cli/examples/organizations/list.md index 457315ce2..ca0c5ea1d 100644 --- a/examples/1.9.x/console-cli/examples/organizations/list.md +++ b/examples/1.9.x/console-cli/examples/organizations/list.md @@ -1,3 +1,4 @@ ```bash -appwrite organizations list +appwrite organizations list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/project/create-ephemeral-key.md b/examples/1.9.x/console-cli/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..d80508a3c --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/create-ephemeral-key.md @@ -0,0 +1,5 @@ +```bash +appwrite project create-ephemeral-key \ + --scopes one two three \ + --duration 1 +``` diff --git a/examples/1.9.x/console-cli/examples/project/create-mock-phone.md b/examples/1.9.x/console-cli/examples/project/create-mock-phone.md new file mode 100644 index 000000000..bed52904f --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/create-mock-phone.md @@ -0,0 +1,5 @@ +```bash +appwrite project create-mock-phone \ + --number +12065550100 \ + --otp +``` diff --git a/examples/1.9.x/console-cli/examples/project/delete-mock-phone.md b/examples/1.9.x/console-cli/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..7e817c34c --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/delete-mock-phone.md @@ -0,0 +1,4 @@ +```bash +appwrite project delete-mock-phone \ + --number +12065550100 +``` diff --git a/examples/1.9.x/console-cli/examples/project/delete.md b/examples/1.9.x/console-cli/examples/project/delete.md new file mode 100644 index 000000000..376dee039 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/delete.md @@ -0,0 +1,3 @@ +```bash +appwrite project delete +``` diff --git a/examples/1.9.x/console-cli/examples/project/get-mock-phone.md b/examples/1.9.x/console-cli/examples/project/get-mock-phone.md new file mode 100644 index 000000000..a4437830b --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/get-mock-phone.md @@ -0,0 +1,4 @@ +```bash +appwrite project get-mock-phone \ + --number +12065550100 +``` diff --git a/examples/1.9.x/console-cli/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/console-cli/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..ba47af11c --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,4 @@ +```bash +appwrite project get-o-auth-2-provider \ + --provider +``` diff --git a/examples/1.9.x/console-cli/examples/project/get-policy.md b/examples/1.9.x/console-cli/examples/project/get-policy.md new file mode 100644 index 000000000..3ad505055 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/get-policy.md @@ -0,0 +1,4 @@ +```bash +appwrite project get-policy \ + --policy-id password-dictionary +``` diff --git a/examples/1.9.x/console-cli/examples/project/list-email-templates.md b/examples/1.9.x/console-cli/examples/project/list-email-templates.md new file mode 100644 index 000000000..ea26ea338 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/list-email-templates.md @@ -0,0 +1,4 @@ +```bash +appwrite project list-email-templates \ + --limit 25 +``` diff --git a/examples/1.9.x/console-cli/examples/project/list-keys.md b/examples/1.9.x/console-cli/examples/project/list-keys.md index 83042b733..ce3e44e3b 100644 --- a/examples/1.9.x/console-cli/examples/project/list-keys.md +++ b/examples/1.9.x/console-cli/examples/project/list-keys.md @@ -1,3 +1,4 @@ ```bash -appwrite project list-keys +appwrite project list-keys \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/project/list-mock-phones.md b/examples/1.9.x/console-cli/examples/project/list-mock-phones.md new file mode 100644 index 000000000..16a0b9304 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/list-mock-phones.md @@ -0,0 +1,4 @@ +```bash +appwrite project list-mock-phones \ + --limit 25 +``` diff --git a/examples/1.9.x/console-cli/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/console-cli/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..df16be415 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,3 @@ +```bash +appwrite project list-o-auth-2-providers +``` diff --git a/examples/1.9.x/console-cli/examples/project/list-platforms.md b/examples/1.9.x/console-cli/examples/project/list-platforms.md index f6f5d6651..0c61bb5f2 100644 --- a/examples/1.9.x/console-cli/examples/project/list-platforms.md +++ b/examples/1.9.x/console-cli/examples/project/list-platforms.md @@ -1,3 +1,4 @@ ```bash -appwrite project list-platforms +appwrite project list-platforms \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/project/list-policies.md b/examples/1.9.x/console-cli/examples/project/list-policies.md new file mode 100644 index 000000000..61aa6d4bd --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/list-policies.md @@ -0,0 +1,4 @@ +```bash +appwrite project list-policies \ + --limit 25 +``` diff --git a/examples/1.9.x/console-cli/examples/project/list-variables.md b/examples/1.9.x/console-cli/examples/project/list-variables.md index 2f564671a..5ab4c9d9e 100644 --- a/examples/1.9.x/console-cli/examples/project/list-variables.md +++ b/examples/1.9.x/console-cli/examples/project/list-variables.md @@ -1,3 +1,4 @@ ```bash -appwrite project list-variables +appwrite project list-variables \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/project/update-auth-method.md b/examples/1.9.x/console-cli/examples/project/update-auth-method.md new file mode 100644 index 000000000..45ca9a749 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-auth-method.md @@ -0,0 +1,5 @@ +```bash +appwrite project update-auth-method \ + --method-id email-password \ + --enabled false +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-mock-phone.md b/examples/1.9.x/console-cli/examples/project/update-mock-phone.md new file mode 100644 index 000000000..f8b267d36 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-mock-phone.md @@ -0,0 +1,5 @@ +```bash +appwrite project update-mock-phone \ + --number +12065550100 \ + --otp +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..fd478a992 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-amazon +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..6b74296b4 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-apple +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..84fc78203 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-auth-0 +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..9eaf8366c --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-authentik +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..fb1146551 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-autodesk +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..685fa8d2e --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-bitbucket +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..48426eb37 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-bitly +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-box.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..e9ad37c7a --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-box.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-box +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..36897064c --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-dailymotion +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..83362d114 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-discord +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..d34026f39 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-disqus +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..d2c2ee970 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-dropbox +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..c8ed2e1c6 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-etsy +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..a9d50ec4e --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-facebook +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..a689ce49d --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-figma +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..f22e1e407 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-fusion-auth +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..a3b08096d --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-git-hub +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..fd883f2c6 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-gitlab +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-google.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..aab34410d --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-google.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-google +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..39ca172b2 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-keycloak +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..ed41a4c38 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-kick +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..f2bfef2bc --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-linkedin +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..1eb97419c --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-microsoft +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..249e6bc04 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-notion +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..70446b62f --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-oidc +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..e98bb24bd --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-okta +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..56afb4c0c --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-paypal-sandbox +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..2a84b3507 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-paypal +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..0e6ec3a8a --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-podio +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..b4832b0c6 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-salesforce +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..039856987 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-slack +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..3d9d8efe3 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-spotify +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..cc317881e --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-stripe +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..cf13b34b5 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-tradeshift-sandbox +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..1bf3e8896 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-tradeshift +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..cb4f970dc --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-twitch +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..51db13835 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-word-press +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..1cac8450a --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-yahoo +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..8d3670559 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-yandex +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..54dd7d072 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-zoho +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..ee5bbf743 --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2-zoom +``` diff --git a/examples/1.9.x/console-cli/examples/project/update-o-auth-2x.md b/examples/1.9.x/console-cli/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..e1b988ddf --- /dev/null +++ b/examples/1.9.x/console-cli/examples/project/update-o-auth-2x.md @@ -0,0 +1,3 @@ +```bash +appwrite project update-o-auth-2x +``` diff --git a/examples/1.9.x/console-cli/examples/projects/list-dev-keys.md b/examples/1.9.x/console-cli/examples/projects/list-dev-keys.md index aa0c9502c..ce7ff1880 100644 --- a/examples/1.9.x/console-cli/examples/projects/list-dev-keys.md +++ b/examples/1.9.x/console-cli/examples/projects/list-dev-keys.md @@ -1,4 +1,5 @@ ```bash appwrite projects list-dev-keys \ - --project-id + --project-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/projects/list-schedules.md b/examples/1.9.x/console-cli/examples/projects/list-schedules.md index f2b04e9f6..16ae9beaa 100644 --- a/examples/1.9.x/console-cli/examples/projects/list-schedules.md +++ b/examples/1.9.x/console-cli/examples/projects/list-schedules.md @@ -1,4 +1,5 @@ ```bash appwrite projects list-schedules \ - --project-id + --project-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/projects/list.md b/examples/1.9.x/console-cli/examples/projects/list.md index e22f4117a..91e8ef852 100644 --- a/examples/1.9.x/console-cli/examples/projects/list.md +++ b/examples/1.9.x/console-cli/examples/projects/list.md @@ -1,3 +1,4 @@ ```bash -appwrite projects list +appwrite projects list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/proxy/list-rules.md b/examples/1.9.x/console-cli/examples/proxy/list-rules.md index 167603db3..219fdfc76 100644 --- a/examples/1.9.x/console-cli/examples/proxy/list-rules.md +++ b/examples/1.9.x/console-cli/examples/proxy/list-rules.md @@ -1,3 +1,4 @@ ```bash -appwrite proxy list-rules +appwrite proxy list-rules \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/sites/list-deployments.md b/examples/1.9.x/console-cli/examples/sites/list-deployments.md index 9d27a69f3..f93db87ff 100644 --- a/examples/1.9.x/console-cli/examples/sites/list-deployments.md +++ b/examples/1.9.x/console-cli/examples/sites/list-deployments.md @@ -1,4 +1,5 @@ ```bash appwrite sites list-deployments \ - --site-id + --site-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/sites/list-logs.md b/examples/1.9.x/console-cli/examples/sites/list-logs.md index 3cc1e0a25..97e098e9d 100644 --- a/examples/1.9.x/console-cli/examples/sites/list-logs.md +++ b/examples/1.9.x/console-cli/examples/sites/list-logs.md @@ -1,4 +1,5 @@ ```bash appwrite sites list-logs \ - --site-id + --site-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/sites/list.md b/examples/1.9.x/console-cli/examples/sites/list.md index 7ca046dcd..025a917dd 100644 --- a/examples/1.9.x/console-cli/examples/sites/list.md +++ b/examples/1.9.x/console-cli/examples/sites/list.md @@ -1,3 +1,4 @@ ```bash -appwrite sites list +appwrite sites list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/storage/list-buckets.md b/examples/1.9.x/console-cli/examples/storage/list-buckets.md index 2b466f640..3208c83d6 100644 --- a/examples/1.9.x/console-cli/examples/storage/list-buckets.md +++ b/examples/1.9.x/console-cli/examples/storage/list-buckets.md @@ -1,3 +1,4 @@ ```bash -appwrite storage list-buckets +appwrite storage list-buckets \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/storage/list-files.md b/examples/1.9.x/console-cli/examples/storage/list-files.md index bb45294c1..1a37b3f5b 100644 --- a/examples/1.9.x/console-cli/examples/storage/list-files.md +++ b/examples/1.9.x/console-cli/examples/storage/list-files.md @@ -1,4 +1,5 @@ ```bash appwrite storage list-files \ - --bucket-id + --bucket-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/delete-rows.md b/examples/1.9.x/console-cli/examples/tablesdb/delete-rows.md index eccdc1503..dd8e9a616 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/delete-rows.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/delete-rows.md @@ -1,5 +1,6 @@ ```bash appwrite tables-db delete-rows \ --database-id \ - --table-id + --table-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/list-columns.md b/examples/1.9.x/console-cli/examples/tablesdb/list-columns.md index d84d3b88b..44fc89371 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/list-columns.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/list-columns.md @@ -1,5 +1,6 @@ ```bash appwrite tables-db list-columns \ --database-id \ - --table-id + --table-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/list-indexes.md b/examples/1.9.x/console-cli/examples/tablesdb/list-indexes.md index 5880cfd9e..c78ad6f15 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/list-indexes.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/list-indexes.md @@ -1,5 +1,6 @@ ```bash appwrite tables-db list-indexes \ --database-id \ - --table-id + --table-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/list-row-logs.md b/examples/1.9.x/console-cli/examples/tablesdb/list-row-logs.md index f956b3ee0..f99cff06c 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/list-row-logs.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/list-row-logs.md @@ -2,5 +2,6 @@ appwrite tables-db list-row-logs \ --database-id \ --table-id \ - --row-id + --row-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/list-rows.md b/examples/1.9.x/console-cli/examples/tablesdb/list-rows.md index adf42b303..5a47f9fbc 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/list-rows.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/list-rows.md @@ -1,5 +1,6 @@ ```bash appwrite tables-db list-rows \ --database-id \ - --table-id + --table-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/list-table-logs.md b/examples/1.9.x/console-cli/examples/tablesdb/list-table-logs.md index 3b7bf557c..b8625741c 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/list-table-logs.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/list-table-logs.md @@ -1,5 +1,6 @@ ```bash appwrite tables-db list-table-logs \ --database-id \ - --table-id + --table-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/list-tables.md b/examples/1.9.x/console-cli/examples/tablesdb/list-tables.md index 5954aa178..b7ff42092 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/list-tables.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/list-tables.md @@ -1,4 +1,5 @@ ```bash appwrite tables-db list-tables \ - --database-id + --database-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/list-transactions.md b/examples/1.9.x/console-cli/examples/tablesdb/list-transactions.md index b99de5fb3..9554db6b4 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/list-transactions.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/list-transactions.md @@ -1,3 +1,4 @@ ```bash -appwrite tables-db list-transactions +appwrite tables-db list-transactions \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/list.md b/examples/1.9.x/console-cli/examples/tablesdb/list.md index 832493db5..c3e86e0f4 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/list.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/list.md @@ -1,3 +1,4 @@ ```bash -appwrite tables-db list +appwrite tables-db list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tablesdb/update-rows.md b/examples/1.9.x/console-cli/examples/tablesdb/update-rows.md index 517661643..7e46f6182 100644 --- a/examples/1.9.x/console-cli/examples/tablesdb/update-rows.md +++ b/examples/1.9.x/console-cli/examples/tablesdb/update-rows.md @@ -1,5 +1,6 @@ ```bash appwrite tables-db update-rows \ --database-id \ - --table-id + --table-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/teams/list-logs.md b/examples/1.9.x/console-cli/examples/teams/list-logs.md index 6a1929229..dddb83c28 100644 --- a/examples/1.9.x/console-cli/examples/teams/list-logs.md +++ b/examples/1.9.x/console-cli/examples/teams/list-logs.md @@ -1,4 +1,5 @@ ```bash appwrite teams list-logs \ - --team-id + --team-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/teams/list-memberships.md b/examples/1.9.x/console-cli/examples/teams/list-memberships.md index bce1769de..1a324ea40 100644 --- a/examples/1.9.x/console-cli/examples/teams/list-memberships.md +++ b/examples/1.9.x/console-cli/examples/teams/list-memberships.md @@ -1,4 +1,5 @@ ```bash appwrite teams list-memberships \ - --team-id + --team-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/teams/list.md b/examples/1.9.x/console-cli/examples/teams/list.md index 6f4f38dcd..8a783324a 100644 --- a/examples/1.9.x/console-cli/examples/teams/list.md +++ b/examples/1.9.x/console-cli/examples/teams/list.md @@ -1,3 +1,4 @@ ```bash -appwrite teams list +appwrite teams list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/tokens/list.md b/examples/1.9.x/console-cli/examples/tokens/list.md index 8f0599147..ae34788d7 100644 --- a/examples/1.9.x/console-cli/examples/tokens/list.md +++ b/examples/1.9.x/console-cli/examples/tokens/list.md @@ -1,5 +1,6 @@ ```bash appwrite tokens list \ --bucket-id \ - --file-id + --file-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/users/list-identities.md b/examples/1.9.x/console-cli/examples/users/list-identities.md index 4dcdb5d8a..49032aa1b 100644 --- a/examples/1.9.x/console-cli/examples/users/list-identities.md +++ b/examples/1.9.x/console-cli/examples/users/list-identities.md @@ -1,3 +1,4 @@ ```bash -appwrite users list-identities +appwrite users list-identities \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/users/list-logs.md b/examples/1.9.x/console-cli/examples/users/list-logs.md index 0b622bf9d..e32e654b0 100644 --- a/examples/1.9.x/console-cli/examples/users/list-logs.md +++ b/examples/1.9.x/console-cli/examples/users/list-logs.md @@ -1,4 +1,5 @@ ```bash appwrite users list-logs \ - --user-id + --user-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/users/list-memberships.md b/examples/1.9.x/console-cli/examples/users/list-memberships.md index df51790f9..c10ce7457 100644 --- a/examples/1.9.x/console-cli/examples/users/list-memberships.md +++ b/examples/1.9.x/console-cli/examples/users/list-memberships.md @@ -1,4 +1,5 @@ ```bash appwrite users list-memberships \ - --user-id + --user-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/users/list-targets.md b/examples/1.9.x/console-cli/examples/users/list-targets.md index 38d7eee82..9d5046a22 100644 --- a/examples/1.9.x/console-cli/examples/users/list-targets.md +++ b/examples/1.9.x/console-cli/examples/users/list-targets.md @@ -1,4 +1,5 @@ ```bash appwrite users list-targets \ - --user-id + --user-id \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/users/list.md b/examples/1.9.x/console-cli/examples/users/list.md index 9930d1849..7d1e4bc2e 100644 --- a/examples/1.9.x/console-cli/examples/users/list.md +++ b/examples/1.9.x/console-cli/examples/users/list.md @@ -1,3 +1,4 @@ ```bash -appwrite users list +appwrite users list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/vcs/list-installations.md b/examples/1.9.x/console-cli/examples/vcs/list-installations.md index 9f342c867..b78449bf8 100644 --- a/examples/1.9.x/console-cli/examples/vcs/list-installations.md +++ b/examples/1.9.x/console-cli/examples/vcs/list-installations.md @@ -1,3 +1,4 @@ ```bash -appwrite vcs list-installations +appwrite vcs list-installations \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/vcs/list-repositories.md b/examples/1.9.x/console-cli/examples/vcs/list-repositories.md index f0b67571e..5b38fe397 100644 --- a/examples/1.9.x/console-cli/examples/vcs/list-repositories.md +++ b/examples/1.9.x/console-cli/examples/vcs/list-repositories.md @@ -1,5 +1,6 @@ ```bash appwrite vcs list-repositories \ --installation-id \ - --type runtime + --type runtime \ + --limit 25 ``` diff --git a/examples/1.9.x/console-cli/examples/webhooks/list.md b/examples/1.9.x/console-cli/examples/webhooks/list.md index 50e57740b..bbf2f8ac0 100644 --- a/examples/1.9.x/console-cli/examples/webhooks/list.md +++ b/examples/1.9.x/console-cli/examples/webhooks/list.md @@ -1,3 +1,4 @@ ```bash -appwrite webhooks list +appwrite webhooks list \ + --limit 25 ``` diff --git a/examples/1.9.x/console-web/examples/console/list-o-auth-2-providers.md b/examples/1.9.x/console-web/examples/console/list-o-auth-2-providers.md new file mode 100644 index 000000000..d26800b25 --- /dev/null +++ b/examples/1.9.x/console-web/examples/console/list-o-auth-2-providers.md @@ -0,0 +1,13 @@ +```javascript +import { Client, Console } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const console = new Console(client); + +const result = await console.listOAuth2Providers(); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/console/list-project-scopes.md b/examples/1.9.x/console-web/examples/console/list-project-scopes.md new file mode 100644 index 000000000..b1cb80341 --- /dev/null +++ b/examples/1.9.x/console-web/examples/console/list-project-scopes.md @@ -0,0 +1,13 @@ +```javascript +import { Client, Console } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const console = new Console(client); + +const result = await console.listProjectScopes(); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/domains/update-purchase.md b/examples/1.9.x/console-web/examples/domains/update-purchase.md index 2f3b6bedf..b2165d207 100644 --- a/examples/1.9.x/console-web/examples/domains/update-purchase.md +++ b/examples/1.9.x/console-web/examples/domains/update-purchase.md @@ -8,7 +8,7 @@ const client = new Client() const domains = new Domains(client); const result = await domains.updatePurchase({ - domainId: '', + invoiceId: '', organizationId: '' }); diff --git a/examples/1.9.x/console-web/examples/domains/update-transfer-in.md b/examples/1.9.x/console-web/examples/domains/update-transfer-in.md index 9dc3e260c..04ea52017 100644 --- a/examples/1.9.x/console-web/examples/domains/update-transfer-in.md +++ b/examples/1.9.x/console-web/examples/domains/update-transfer-in.md @@ -8,7 +8,7 @@ const client = new Client() const domains = new Domains(client); const result = await domains.updateTransferIn({ - domainId: '', + invoiceId: '', organizationId: '' }); diff --git a/examples/1.9.x/console-web/examples/functions/create.md b/examples/1.9.x/console-web/examples/functions/create.md index b45b0a1b1..5cd33258d 100644 --- a/examples/1.9.x/console-web/examples/functions/create.md +++ b/examples/1.9.x/console-web/examples/functions/create.md @@ -19,7 +19,7 @@ const result = await functions.create({ logging: false, // optional entrypoint: '', // optional commands: '', // optional - scopes: [Scopes.SessionsWrite], // optional + scopes: [Scopes.ProjectRead], // optional installationId: '', // optional providerRepositoryId: '', // optional providerBranch: '', // optional diff --git a/examples/1.9.x/console-web/examples/functions/update.md b/examples/1.9.x/console-web/examples/functions/update.md index f6f90ed7d..cb77dea18 100644 --- a/examples/1.9.x/console-web/examples/functions/update.md +++ b/examples/1.9.x/console-web/examples/functions/update.md @@ -19,7 +19,7 @@ const result = await functions.update({ logging: false, // optional entrypoint: '', // optional commands: '', // optional - scopes: [Scopes.SessionsWrite], // optional + scopes: [Scopes.ProjectRead], // optional installationId: '', // optional providerRepositoryId: '', // optional providerBranch: '', // optional diff --git a/examples/1.9.x/console-web/examples/manager/create-block.md b/examples/1.9.x/console-web/examples/manager/create-block.md new file mode 100644 index 000000000..3515e471d --- /dev/null +++ b/examples/1.9.x/console-web/examples/manager/create-block.md @@ -0,0 +1,18 @@ +```javascript +import { Client, Manager, ResourceType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + +const manager = new Manager(client); + +const result = await manager.createBlock({ + projectId: '', + resourceType: ResourceType.Projects, + resourceId: '', // optional + reason: '', // optional + expiredAt: '2020-10-15T06:38:00.000+00:00' // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/manager/delete-block.md b/examples/1.9.x/console-web/examples/manager/delete-block.md new file mode 100644 index 000000000..285eee035 --- /dev/null +++ b/examples/1.9.x/console-web/examples/manager/delete-block.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Manager, ResourceType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + +const manager = new Manager(client); + +const result = await manager.deleteBlock({ + projectId: '', + resourceType: ResourceType.Projects, + resourceId: '' // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/manager/list-blocks.md b/examples/1.9.x/console-web/examples/manager/list-blocks.md new file mode 100644 index 000000000..0bdd5c102 --- /dev/null +++ b/examples/1.9.x/console-web/examples/manager/list-blocks.md @@ -0,0 +1,14 @@ +```javascript +import { Client, Manager } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + +const manager = new Manager(client); + +const result = await manager.listBlocks({ + projectId: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/manager/update-user-status.md b/examples/1.9.x/console-web/examples/manager/update-user-status.md new file mode 100644 index 000000000..34af5753b --- /dev/null +++ b/examples/1.9.x/console-web/examples/manager/update-user-status.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Manager } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + +const manager = new Manager(client); + +const result = await manager.updateUserStatus({ + status: false, + userId: '', // optional + email: '', // optional + reason: '' // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/organizations/create-plan-estimation.md b/examples/1.9.x/console-web/examples/organizations/create-plan-estimation.md new file mode 100644 index 000000000..ee143eccd --- /dev/null +++ b/examples/1.9.x/console-web/examples/organizations/create-plan-estimation.md @@ -0,0 +1,18 @@ +```javascript +import { Client, Organizations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const organizations = new Organizations(client); + +const result = await organizations.createPlanEstimation({ + organizationId: '', + billingPlan: 'tier-0', + invites: [], // optional + couponId: '' // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/create-ephemeral-key.md b/examples/1.9.x/console-web/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..e1514f600 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/create-ephemeral-key.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Project, Scopes } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.createEphemeralKey({ + scopes: [Scopes.ProjectRead], + duration: 1 +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/create-key.md b/examples/1.9.x/console-web/examples/project/create-key.md index 1e4ba0174..362d4ca0c 100644 --- a/examples/1.9.x/console-web/examples/project/create-key.md +++ b/examples/1.9.x/console-web/examples/project/create-key.md @@ -10,7 +10,7 @@ const project = new Project(client); const result = await project.createKey({ keyId: '', name: '', - scopes: [Scopes.SessionsWrite], + scopes: [Scopes.ProjectRead], expire: '2020-10-15T06:38:00.000+00:00' // optional }); diff --git a/examples/1.9.x/console-web/examples/project/create-mock-phone.md b/examples/1.9.x/console-web/examples/project/create-mock-phone.md new file mode 100644 index 000000000..eaf3dad68 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/create-mock-phone.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.createMockPhone({ + number: '+12065550100', + otp: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/delete-mock-phone.md b/examples/1.9.x/console-web/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..598c56aae --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/delete-mock-phone.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.deleteMockPhone({ + number: '+12065550100' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/delete.md b/examples/1.9.x/console-web/examples/project/delete.md new file mode 100644 index 000000000..7e38d433e --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/delete.md @@ -0,0 +1,13 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.delete(); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/get-mock-phone.md b/examples/1.9.x/console-web/examples/project/get-mock-phone.md new file mode 100644 index 000000000..938b5915c --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/get-mock-phone.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.getMockPhone({ + number: '+12065550100' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/console-web/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..a667c8203 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.getOAuth2Provider({ + provider: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/get-policy.md b/examples/1.9.x/console-web/examples/project/get-policy.md new file mode 100644 index 000000000..be9b5151c --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/get-policy.md @@ -0,0 +1,15 @@ +```javascript +import { Client, Project, PolicyId } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.getPolicy({ + policyId: PolicyId.PasswordDictionary +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/list-email-templates.md b/examples/1.9.x/console-web/examples/project/list-email-templates.md new file mode 100644 index 000000000..ec206bf39 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/list-email-templates.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.listEmailTemplates({ + queries: [], // optional + total: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/list-mock-phones.md b/examples/1.9.x/console-web/examples/project/list-mock-phones.md new file mode 100644 index 000000000..d60a0570c --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/list-mock-phones.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.listMockPhones({ + queries: [], // optional + total: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/console-web/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..f4e6545b2 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,13 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.listOAuth2Providers(); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/list-policies.md b/examples/1.9.x/console-web/examples/project/list-policies.md new file mode 100644 index 000000000..d1d842418 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/list-policies.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.listPolicies({ + queries: [], // optional + total: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-auth-method.md b/examples/1.9.x/console-web/examples/project/update-auth-method.md new file mode 100644 index 000000000..802d1d2b2 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-auth-method.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Project, MethodId } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateAuthMethod({ + methodId: MethodId.EmailPassword, + enabled: false +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-key.md b/examples/1.9.x/console-web/examples/project/update-key.md index 59aae4897..3d3282d44 100644 --- a/examples/1.9.x/console-web/examples/project/update-key.md +++ b/examples/1.9.x/console-web/examples/project/update-key.md @@ -10,7 +10,7 @@ const project = new Project(client); const result = await project.updateKey({ keyId: '', name: '', - scopes: [Scopes.SessionsWrite], + scopes: [Scopes.ProjectRead], expire: '2020-10-15T06:38:00.000+00:00' // optional }); diff --git a/examples/1.9.x/console-web/examples/project/update-mock-phone.md b/examples/1.9.x/console-web/examples/project/update-mock-phone.md new file mode 100644 index 000000000..88204665f --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-mock-phone.md @@ -0,0 +1,16 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateMockPhone({ + number: '+12065550100', + otp: '' +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..415051517 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Amazon({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..088f42faa --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,19 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Apple({ + serviceId: '', // optional + keyId: '', // optional + teamId: '', // optional + p8File: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..aae061ce6 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,18 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Auth0({ + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..b59b7ced6 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,18 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Authentik({ + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..675caa2ab --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Autodesk({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..98b39d672 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Bitbucket({ + key: '', // optional + secret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..572d6dcff --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Bitly({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-box.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..a3010c050 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-box.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Box({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..40912058c --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Dailymotion({ + apiKey: '', // optional + apiSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..c289e4b4c --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Discord({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..b356ce7fc --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Disqus({ + publicKey: '', // optional + secretKey: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..f088118af --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Dropbox({ + appKey: '', // optional + appSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..469c0a081 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Etsy({ + keyString: '', // optional + sharedSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..1af18fbdb --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Facebook({ + appId: '', // optional + appSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..e1b358751 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Figma({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..da29e909e --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,18 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2FusionAuth({ + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..f1dbb6170 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2GitHub({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..5191d0138 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,18 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Gitlab({ + applicationId: '', // optional + secret: '', // optional + endpoint: 'https://example.com', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-google.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..a6d2cbf64 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-google.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Google({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..7121691d5 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,19 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Keycloak({ + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + realmName: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..1bf99d6be --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Kick({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..2ba49a513 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Linkedin({ + clientId: '', // optional + primaryClientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..3e10286a1 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,18 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Microsoft({ + applicationId: '', // optional + applicationSecret: '', // optional + tenant: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..7c9c0f09a --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Notion({ + oauthClientId: '', // optional + oauthClientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..29b8536e1 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,21 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Oidc({ + clientId: '', // optional + clientSecret: '', // optional + wellKnownURL: 'https://example.com', // optional + authorizationURL: 'https://example.com', // optional + tokenUrl: 'https://example.com', // optional + userInfoUrl: 'https://example.com', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..6621728e5 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,19 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Okta({ + clientId: '', // optional + clientSecret: '', // optional + domain: '', // optional + authorizationServerId: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..d69e3e05f --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2PaypalSandbox({ + clientId: '', // optional + secretKey: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..4e41a3243 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Paypal({ + clientId: '', // optional + secretKey: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..247b96cc4 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Podio({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..8472e309f --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Salesforce({ + customerKey: '', // optional + customerSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..7258f2784 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Slack({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..796fd5cb5 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Spotify({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..6faf6dc10 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Stripe({ + clientId: '', // optional + apiSecretKey: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..d7eabe6e8 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2TradeshiftSandbox({ + oauth2ClientId: '', // optional + oauth2ClientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..90a18465a --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Tradeshift({ + oauth2ClientId: '', // optional + oauth2ClientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..0fc86b17e --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Twitch({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..1925bdd2c --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2WordPress({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..07af9e12d --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Yahoo({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..b43566b7e --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Yandex({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..f0113d059 --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Zoho({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..531a66a6d --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2Zoom({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/console-web/examples/project/update-o-auth-2x.md b/examples/1.9.x/console-web/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..8510e6e5e --- /dev/null +++ b/examples/1.9.x/console-web/examples/project/update-o-auth-2x.md @@ -0,0 +1,17 @@ +```javascript +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const project = new Project(client); + +const result = await project.updateOAuth2X({ + customerKey: '', // optional + secretKey: '', // optional + enabled: false // optional +}); + +console.log(result); +``` diff --git a/examples/1.9.x/server-dart/examples/functions/create.md b/examples/1.9.x/server-dart/examples/functions/create.md index c960e9bdf..744563092 100644 --- a/examples/1.9.x/server-dart/examples/functions/create.md +++ b/examples/1.9.x/server-dart/examples/functions/create.md @@ -21,7 +21,7 @@ Func result = await functions.create( logging: false, // (optional) entrypoint: '', // (optional) commands: '', // (optional) - scopes: [enums.Scopes.sessionsWrite], // (optional) + scopes: [enums.Scopes.projectRead], // (optional) installationId: '', // (optional) providerRepositoryId: '', // (optional) providerBranch: '', // (optional) diff --git a/examples/1.9.x/server-dart/examples/functions/update.md b/examples/1.9.x/server-dart/examples/functions/update.md index bd99c93fc..904f8967b 100644 --- a/examples/1.9.x/server-dart/examples/functions/update.md +++ b/examples/1.9.x/server-dart/examples/functions/update.md @@ -21,7 +21,7 @@ Func result = await functions.update( logging: false, // (optional) entrypoint: '', // (optional) commands: '', // (optional) - scopes: [enums.Scopes.sessionsWrite], // (optional) + scopes: [enums.Scopes.projectRead], // (optional) installationId: '', // (optional) providerRepositoryId: '', // (optional) providerBranch: '', // (optional) diff --git a/examples/1.9.x/server-dart/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-dart/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..abfe33152 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/create-ephemeral-key.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; +import 'package:dart_appwrite/enums.dart' as enums; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +EphemeralKey result = await project.createEphemeralKey( + scopes: [enums.Scopes.projectRead], + duration: 1, +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/create-key.md b/examples/1.9.x/server-dart/examples/project/create-key.md index 9c63e3bf0..9e1d8e8e9 100644 --- a/examples/1.9.x/server-dart/examples/project/create-key.md +++ b/examples/1.9.x/server-dart/examples/project/create-key.md @@ -12,7 +12,7 @@ Project project = Project(client); Key result = await project.createKey( keyId: '', name: '', - scopes: [enums.Scopes.sessionsWrite], + scopes: [enums.Scopes.projectRead], expire: '2020-10-15T06:38:00.000+00:00', // (optional) ); ``` diff --git a/examples/1.9.x/server-dart/examples/project/create-mock-phone.md b/examples/1.9.x/server-dart/examples/project/create-mock-phone.md new file mode 100644 index 000000000..c73c4c2fc --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/create-mock-phone.md @@ -0,0 +1,15 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +MockNumber result = await project.createMockPhone( + number: '+12065550100', + otp: '', +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/delete-mock-phone.md b/examples/1.9.x/server-dart/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..f47a21902 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/delete-mock-phone.md @@ -0,0 +1,14 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +await project.deleteMockPhone( + number: '+12065550100', +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/delete.md b/examples/1.9.x/server-dart/examples/project/delete.md new file mode 100644 index 000000000..3199e2db8 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/delete.md @@ -0,0 +1,12 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +await project.delete(); +``` diff --git a/examples/1.9.x/server-dart/examples/project/get-mock-phone.md b/examples/1.9.x/server-dart/examples/project/get-mock-phone.md new file mode 100644 index 000000000..e3ef61ff9 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/get-mock-phone.md @@ -0,0 +1,14 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +MockNumber result = await project.getMockPhone( + number: '+12065550100', +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-dart/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..127bdaa05 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,14 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +dynamic result = await project.getOAuth2Provider( + provider: '', +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/get-policy.md b/examples/1.9.x/server-dart/examples/project/get-policy.md new file mode 100644 index 000000000..55eae16f2 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/get-policy.md @@ -0,0 +1,15 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; +import 'package:dart_appwrite/enums.dart' as enums; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +dynamic result = await project.getPolicy( + policyId: enums.PolicyId.passwordDictionary, +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/list-email-templates.md b/examples/1.9.x/server-dart/examples/project/list-email-templates.md new file mode 100644 index 000000000..0bd9ee7eb --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/list-email-templates.md @@ -0,0 +1,15 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +EmailTemplateList result = await project.listEmailTemplates( + queries: [], // (optional) + total: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/list-mock-phones.md b/examples/1.9.x/server-dart/examples/project/list-mock-phones.md new file mode 100644 index 000000000..dac643971 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/list-mock-phones.md @@ -0,0 +1,15 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +MockNumberList result = await project.listMockPhones( + queries: [], // (optional) + total: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-dart/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..c8277b543 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,12 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2ProviderList result = await project.listOAuth2Providers(); +``` diff --git a/examples/1.9.x/server-dart/examples/project/list-policies.md b/examples/1.9.x/server-dart/examples/project/list-policies.md new file mode 100644 index 000000000..5aba661cf --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/list-policies.md @@ -0,0 +1,15 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +PolicyList result = await project.listPolicies( + queries: [], // (optional) + total: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-auth-method.md b/examples/1.9.x/server-dart/examples/project/update-auth-method.md new file mode 100644 index 000000000..94b5245dc --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-auth-method.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; +import 'package:dart_appwrite/enums.dart' as enums; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +Project result = await project.updateAuthMethod( + methodId: enums.MethodId.emailPassword, + enabled: false, +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-key.md b/examples/1.9.x/server-dart/examples/project/update-key.md index 83f4139c5..86379d8cb 100644 --- a/examples/1.9.x/server-dart/examples/project/update-key.md +++ b/examples/1.9.x/server-dart/examples/project/update-key.md @@ -12,7 +12,7 @@ Project project = Project(client); Key result = await project.updateKey( keyId: '', name: '', - scopes: [enums.Scopes.sessionsWrite], + scopes: [enums.Scopes.projectRead], expire: '2020-10-15T06:38:00.000+00:00', // (optional) ); ``` diff --git a/examples/1.9.x/server-dart/examples/project/update-mock-phone.md b/examples/1.9.x/server-dart/examples/project/update-mock-phone.md new file mode 100644 index 000000000..3f584d210 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-mock-phone.md @@ -0,0 +1,15 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +MockNumber result = await project.updateMockPhone( + number: '+12065550100', + otp: '', +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..1821f5d89 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Amazon result = await project.updateOAuth2Amazon( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..06f506e59 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,18 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Apple result = await project.updateOAuth2Apple( + serviceId: '', // (optional) + keyId: '', // (optional) + teamId: '', // (optional) + p8File: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..e00a59761 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,17 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Auth0 result = await project.updateOAuth2Auth0( + clientId: '', // (optional) + clientSecret: '', // (optional) + endpoint: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..734702733 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,17 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Authentik result = await project.updateOAuth2Authentik( + clientId: '', // (optional) + clientSecret: '', // (optional) + endpoint: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..1273e6e4c --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Autodesk result = await project.updateOAuth2Autodesk( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..2f9274a08 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Bitbucket result = await project.updateOAuth2Bitbucket( + key: '', // (optional) + secret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..5f03c82e8 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Bitly result = await project.updateOAuth2Bitly( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..b00ab7c58 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-box.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Box result = await project.updateOAuth2Box( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..1117cf853 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Dailymotion result = await project.updateOAuth2Dailymotion( + apiKey: '', // (optional) + apiSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..7e06450d2 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Discord result = await project.updateOAuth2Discord( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..42d62a827 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Disqus result = await project.updateOAuth2Disqus( + publicKey: '', // (optional) + secretKey: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..200829125 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Dropbox result = await project.updateOAuth2Dropbox( + appKey: '', // (optional) + appSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..3e6118a1c --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Etsy result = await project.updateOAuth2Etsy( + keyString: '', // (optional) + sharedSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..48d282a98 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Facebook result = await project.updateOAuth2Facebook( + appId: '', // (optional) + appSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..1b80d0e56 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Figma result = await project.updateOAuth2Figma( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..73c41171d --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,17 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2FusionAuth result = await project.updateOAuth2FusionAuth( + clientId: '', // (optional) + clientSecret: '', // (optional) + endpoint: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..e2830382e --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Github result = await project.updateOAuth2GitHub( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..1d7418d95 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,17 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Gitlab result = await project.updateOAuth2Gitlab( + applicationId: '', // (optional) + secret: '', // (optional) + endpoint: 'https://example.com', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..c96f80e5d --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-google.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Google result = await project.updateOAuth2Google( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..b7195b82c --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,18 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Keycloak result = await project.updateOAuth2Keycloak( + clientId: '', // (optional) + clientSecret: '', // (optional) + endpoint: '', // (optional) + realmName: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..5cfdf9a4a --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Kick result = await project.updateOAuth2Kick( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..d69f1eaa3 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Linkedin result = await project.updateOAuth2Linkedin( + clientId: '', // (optional) + primaryClientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..7f1aa6ca9 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,17 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Microsoft result = await project.updateOAuth2Microsoft( + applicationId: '', // (optional) + applicationSecret: '', // (optional) + tenant: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..ba723ccc5 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Notion result = await project.updateOAuth2Notion( + oauthClientId: '', // (optional) + oauthClientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..f1d7a125b --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,20 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Oidc result = await project.updateOAuth2Oidc( + clientId: '', // (optional) + clientSecret: '', // (optional) + wellKnownURL: 'https://example.com', // (optional) + authorizationURL: 'https://example.com', // (optional) + tokenUrl: 'https://example.com', // (optional) + userInfoUrl: 'https://example.com', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..1b79a5e6a --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,18 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Okta result = await project.updateOAuth2Okta( + clientId: '', // (optional) + clientSecret: '', // (optional) + domain: '', // (optional) + authorizationServerId: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..eda05f5e6 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Paypal result = await project.updateOAuth2PaypalSandbox( + clientId: '', // (optional) + secretKey: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..120b58170 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Paypal result = await project.updateOAuth2Paypal( + clientId: '', // (optional) + secretKey: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..9b5ee737b --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Podio result = await project.updateOAuth2Podio( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..6be026b45 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Salesforce result = await project.updateOAuth2Salesforce( + customerKey: '', // (optional) + customerSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..1032810c6 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Slack result = await project.updateOAuth2Slack( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..8e7f98347 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Spotify result = await project.updateOAuth2Spotify( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..367466733 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Stripe result = await project.updateOAuth2Stripe( + clientId: '', // (optional) + apiSecretKey: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..653abf6eb --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Tradeshift result = await project.updateOAuth2TradeshiftSandbox( + oauth2ClientId: '', // (optional) + oauth2ClientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..1e780bfc0 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Tradeshift result = await project.updateOAuth2Tradeshift( + oauth2ClientId: '', // (optional) + oauth2ClientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..93d29acdc --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Twitch result = await project.updateOAuth2Twitch( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..32e3495a3 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2WordPress result = await project.updateOAuth2WordPress( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..f08d50749 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Yahoo result = await project.updateOAuth2Yahoo( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..4106fe67b --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Yandex result = await project.updateOAuth2Yandex( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..69d44d8a2 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Zoho result = await project.updateOAuth2Zoho( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..d91ddcbde --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2Zoom result = await project.updateOAuth2Zoom( + clientId: '', // (optional) + clientSecret: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dart/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-dart/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..bf7e5f622 --- /dev/null +++ b/examples/1.9.x/server-dart/examples/project/update-o-auth-2x.md @@ -0,0 +1,16 @@ +```dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Project project = Project(client); + +OAuth2X result = await project.updateOAuth2X( + customerKey: '', // (optional) + secretKey: '', // (optional) + enabled: false, // (optional) +); +``` diff --git a/examples/1.9.x/server-dotnet/examples/functions/create.md b/examples/1.9.x/server-dotnet/examples/functions/create.md index 3a68fda79..074c92c69 100644 --- a/examples/1.9.x/server-dotnet/examples/functions/create.md +++ b/examples/1.9.x/server-dotnet/examples/functions/create.md @@ -23,7 +23,7 @@ Function result = await functions.Create( logging: false, // optional entrypoint: "", // optional commands: "", // optional - scopes: new List<Scopes> { Scopes.SessionsWrite }, // optional + scopes: new List<Scopes> { Scopes.ProjectRead }, // optional installationId: "", // optional providerRepositoryId: "", // optional providerBranch: "", // optional diff --git a/examples/1.9.x/server-dotnet/examples/functions/update.md b/examples/1.9.x/server-dotnet/examples/functions/update.md index 953417f80..02b086918 100644 --- a/examples/1.9.x/server-dotnet/examples/functions/update.md +++ b/examples/1.9.x/server-dotnet/examples/functions/update.md @@ -23,7 +23,7 @@ Function result = await functions.Update( logging: false, // optional entrypoint: "", // optional commands: "", // optional - scopes: new List<Scopes> { Scopes.SessionsWrite }, // optional + scopes: new List<Scopes> { Scopes.ProjectRead }, // optional installationId: "", // optional providerRepositoryId: "", // optional providerBranch: "", // optional diff --git a/examples/1.9.x/server-dotnet/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-dotnet/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..8fdc7cf25 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/create-ephemeral-key.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +EphemeralKey result = await project.CreateEphemeralKey( + scopes: new List<Scopes> { Scopes.ProjectRead }, + duration: 1 +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/create-key.md b/examples/1.9.x/server-dotnet/examples/project/create-key.md index 0a62e5775..905e1a470 100644 --- a/examples/1.9.x/server-dotnet/examples/project/create-key.md +++ b/examples/1.9.x/server-dotnet/examples/project/create-key.md @@ -14,6 +14,6 @@ Project project = new Project(client); Key result = await project.CreateKey( keyId: "", name: "", - scopes: new List<Scopes> { Scopes.SessionsWrite }, + scopes: new List<Scopes> { Scopes.ProjectRead }, expire: "2020-10-15T06:38:00.000+00:00" // optional );``` diff --git a/examples/1.9.x/server-dotnet/examples/project/create-mock-phone.md b/examples/1.9.x/server-dotnet/examples/project/create-mock-phone.md new file mode 100644 index 000000000..f3d846ab0 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/create-mock-phone.md @@ -0,0 +1,16 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +MockNumber result = await project.CreateMockPhone( + number: "+12065550100", + otp: "" +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/delete-mock-phone.md b/examples/1.9.x/server-dotnet/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..3ba22dcca --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/delete-mock-phone.md @@ -0,0 +1,15 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +await project.DeleteMockPhone( + number: "+12065550100" +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/delete.md b/examples/1.9.x/server-dotnet/examples/project/delete.md new file mode 100644 index 000000000..42f63b32b --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/delete.md @@ -0,0 +1,14 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +await project.Delete(); +``` diff --git a/examples/1.9.x/server-dotnet/examples/project/get-mock-phone.md b/examples/1.9.x/server-dotnet/examples/project/get-mock-phone.md new file mode 100644 index 000000000..70a48e599 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/get-mock-phone.md @@ -0,0 +1,15 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +MockNumber result = await project.GetMockPhone( + number: "+12065550100" +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-dotnet/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..81588eac3 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,15 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +object result = await project.GetOAuth2Provider( + provider: "" +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/get-policy.md b/examples/1.9.x/server-dotnet/examples/project/get-policy.md new file mode 100644 index 000000000..b9e015a5e --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/get-policy.md @@ -0,0 +1,16 @@ +```csharp +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +object result = await project.GetPolicy( + policyId: PolicyId.PasswordDictionary +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/list-email-templates.md b/examples/1.9.x/server-dotnet/examples/project/list-email-templates.md new file mode 100644 index 000000000..828692bff --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/list-email-templates.md @@ -0,0 +1,16 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +EmailTemplateList result = await project.ListEmailTemplates( + queries: new List(), // optional + total: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/list-mock-phones.md b/examples/1.9.x/server-dotnet/examples/project/list-mock-phones.md new file mode 100644 index 000000000..9e2763699 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/list-mock-phones.md @@ -0,0 +1,16 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +MockNumberList result = await project.ListMockPhones( + queries: new List(), // optional + total: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-dotnet/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..13e8003ff --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,14 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2ProviderList result = await project.ListOAuth2Providers(); +``` diff --git a/examples/1.9.x/server-dotnet/examples/project/list-policies.md b/examples/1.9.x/server-dotnet/examples/project/list-policies.md new file mode 100644 index 000000000..e1045511b --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/list-policies.md @@ -0,0 +1,16 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +PolicyList result = await project.ListPolicies( + queries: new List(), // optional + total: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-auth-method.md b/examples/1.9.x/server-dotnet/examples/project/update-auth-method.md new file mode 100644 index 000000000..dfa8fed07 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-auth-method.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +Project result = await project.UpdateAuthMethod( + methodId: MethodId.EmailPassword, + enabled: false +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-key.md b/examples/1.9.x/server-dotnet/examples/project/update-key.md index 6b4288b38..debe7dfd0 100644 --- a/examples/1.9.x/server-dotnet/examples/project/update-key.md +++ b/examples/1.9.x/server-dotnet/examples/project/update-key.md @@ -14,6 +14,6 @@ Project project = new Project(client); Key result = await project.UpdateKey( keyId: "", name: "", - scopes: new List<Scopes> { Scopes.SessionsWrite }, + scopes: new List<Scopes> { Scopes.ProjectRead }, expire: "2020-10-15T06:38:00.000+00:00" // optional );``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-mock-phone.md b/examples/1.9.x/server-dotnet/examples/project/update-mock-phone.md new file mode 100644 index 000000000..c5a18e2b3 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-mock-phone.md @@ -0,0 +1,16 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +MockNumber result = await project.UpdateMockPhone( + number: "+12065550100", + otp: "" +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..8680703d0 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Amazon result = await project.UpdateOAuth2Amazon( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..942cebc63 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,19 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Apple result = await project.UpdateOAuth2Apple( + serviceId: "", // optional + keyId: "", // optional + teamId: "", // optional + p8File: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..2c212601e --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,18 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Auth0 result = await project.UpdateOAuth2Auth0( + clientId: "", // optional + clientSecret: "", // optional + endpoint: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..293b98e9a --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,18 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Authentik result = await project.UpdateOAuth2Authentik( + clientId: "", // optional + clientSecret: "", // optional + endpoint: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..40edd2b1d --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Autodesk result = await project.UpdateOAuth2Autodesk( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..53f7411e0 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Bitbucket result = await project.UpdateOAuth2Bitbucket( + key: "", // optional + secret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..eec326fd0 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Bitly result = await project.UpdateOAuth2Bitly( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..c1f1915bd --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-box.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Box result = await project.UpdateOAuth2Box( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..b99bc3571 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Dailymotion result = await project.UpdateOAuth2Dailymotion( + apiKey: "", // optional + apiSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..7d6dc9d5f --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Discord result = await project.UpdateOAuth2Discord( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..6c7d9c7ec --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Disqus result = await project.UpdateOAuth2Disqus( + publicKey: "", // optional + secretKey: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..0106e913d --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Dropbox result = await project.UpdateOAuth2Dropbox( + appKey: "", // optional + appSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..4143db45a --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Etsy result = await project.UpdateOAuth2Etsy( + keyString: "", // optional + sharedSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..ac5ebcb8c --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Facebook result = await project.UpdateOAuth2Facebook( + appId: "", // optional + appSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..b99a6b256 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Figma result = await project.UpdateOAuth2Figma( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..8fa9fe552 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,18 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2FusionAuth result = await project.UpdateOAuth2FusionAuth( + clientId: "", // optional + clientSecret: "", // optional + endpoint: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..5c2cf3b5b --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Github result = await project.UpdateOAuth2GitHub( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..b3530fb23 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,18 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Gitlab result = await project.UpdateOAuth2Gitlab( + applicationId: "", // optional + secret: "", // optional + endpoint: "https://example.com", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..0de7dc1e0 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-google.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Google result = await project.UpdateOAuth2Google( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..3027251ec --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,19 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Keycloak result = await project.UpdateOAuth2Keycloak( + clientId: "", // optional + clientSecret: "", // optional + endpoint: "", // optional + realmName: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..8b9661bf2 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Kick result = await project.UpdateOAuth2Kick( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..e360cc7a9 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Linkedin result = await project.UpdateOAuth2Linkedin( + clientId: "", // optional + primaryClientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..eb8780b1c --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,18 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Microsoft result = await project.UpdateOAuth2Microsoft( + applicationId: "", // optional + applicationSecret: "", // optional + tenant: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..06199ccfa --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Notion result = await project.UpdateOAuth2Notion( + oauthClientId: "", // optional + oauthClientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..f115a2739 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,21 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Oidc result = await project.UpdateOAuth2Oidc( + clientId: "", // optional + clientSecret: "", // optional + wellKnownURL: "https://example.com", // optional + authorizationURL: "https://example.com", // optional + tokenUrl: "https://example.com", // optional + userInfoUrl: "https://example.com", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..87e3c4b47 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,19 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Okta result = await project.UpdateOAuth2Okta( + clientId: "", // optional + clientSecret: "", // optional + domain: "", // optional + authorizationServerId: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..f98cf68e7 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Paypal result = await project.UpdateOAuth2PaypalSandbox( + clientId: "", // optional + secretKey: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..cb2a010f3 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Paypal result = await project.UpdateOAuth2Paypal( + clientId: "", // optional + secretKey: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..1233e25b2 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Podio result = await project.UpdateOAuth2Podio( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..f87bb0186 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Salesforce result = await project.UpdateOAuth2Salesforce( + customerKey: "", // optional + customerSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..b3ac00842 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Slack result = await project.UpdateOAuth2Slack( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..22d7b4c15 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Spotify result = await project.UpdateOAuth2Spotify( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..fbe842ff7 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Stripe result = await project.UpdateOAuth2Stripe( + clientId: "", // optional + apiSecretKey: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..18d5644c8 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Tradeshift result = await project.UpdateOAuth2TradeshiftSandbox( + oauth2ClientId: "", // optional + oauth2ClientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..649f5590a --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Tradeshift result = await project.UpdateOAuth2Tradeshift( + oauth2ClientId: "", // optional + oauth2ClientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..30acec4af --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Twitch result = await project.UpdateOAuth2Twitch( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..40e387e86 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2WordPress result = await project.UpdateOAuth2WordPress( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..3fbc0b552 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Yahoo result = await project.UpdateOAuth2Yahoo( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..186d3a0cf --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Yandex result = await project.UpdateOAuth2Yandex( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..3ae358d75 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Zoho result = await project.UpdateOAuth2Zoho( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..3398abe7c --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2Zoom result = await project.UpdateOAuth2Zoom( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..e346ab5c7 --- /dev/null +++ b/examples/1.9.x/server-dotnet/examples/project/update-o-auth-2x.md @@ -0,0 +1,17 @@ +```csharp +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("") // Your project ID + .SetKey(""); // Your secret API key + +Project project = new Project(client); + +OAuth2X result = await project.UpdateOAuth2X( + customerKey: "", // optional + secretKey: "", // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-go/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-go/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..aa30ba957 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/create-ephemeral-key.md @@ -0,0 +1,22 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.CreateEphemeralKey( + []interface{}{}, + 1, +) +``` diff --git a/examples/1.9.x/server-go/examples/project/create-mock-phone.md b/examples/1.9.x/server-go/examples/project/create-mock-phone.md new file mode 100644 index 000000000..ff08bf1ed --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/create-mock-phone.md @@ -0,0 +1,22 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.CreateMockPhone( + "+12065550100", + "", +) +``` diff --git a/examples/1.9.x/server-go/examples/project/delete-mock-phone.md b/examples/1.9.x/server-go/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..a0c4c4090 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/delete-mock-phone.md @@ -0,0 +1,21 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.DeleteMockPhone( + "+12065550100", +) +``` diff --git a/examples/1.9.x/server-go/examples/project/delete.md b/examples/1.9.x/server-go/examples/project/delete.md new file mode 100644 index 000000000..20ce8535b --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/delete.md @@ -0,0 +1,19 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.Delete()) +``` diff --git a/examples/1.9.x/server-go/examples/project/get-mock-phone.md b/examples/1.9.x/server-go/examples/project/get-mock-phone.md new file mode 100644 index 000000000..37e91d265 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/get-mock-phone.md @@ -0,0 +1,21 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.GetMockPhone( + "+12065550100", +) +``` diff --git a/examples/1.9.x/server-go/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-go/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..87c3f32fe --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,21 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.GetOAuth2Provider( + "", +) +``` diff --git a/examples/1.9.x/server-go/examples/project/get-policy.md b/examples/1.9.x/server-go/examples/project/get-policy.md new file mode 100644 index 000000000..ac24a2ba6 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/get-policy.md @@ -0,0 +1,21 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.GetPolicy( + "password-dictionary", +) +``` diff --git a/examples/1.9.x/server-go/examples/project/list-email-templates.md b/examples/1.9.x/server-go/examples/project/list-email-templates.md new file mode 100644 index 000000000..3cd6052e7 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/list-email-templates.md @@ -0,0 +1,22 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.ListEmailTemplates( + project.WithListEmailTemplatesQueries([]interface{}{}), + project.WithListEmailTemplatesTotal(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/list-mock-phones.md b/examples/1.9.x/server-go/examples/project/list-mock-phones.md new file mode 100644 index 000000000..0db42b94c --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/list-mock-phones.md @@ -0,0 +1,22 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.ListMockPhones( + project.WithListMockPhonesQueries([]interface{}{}), + project.WithListMockPhonesTotal(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-go/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..3e7fbbc6a --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,19 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.ListOAuth2Providers()) +``` diff --git a/examples/1.9.x/server-go/examples/project/list-policies.md b/examples/1.9.x/server-go/examples/project/list-policies.md new file mode 100644 index 000000000..baf2aef75 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/list-policies.md @@ -0,0 +1,22 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.ListPolicies( + project.WithListPoliciesQueries([]interface{}{}), + project.WithListPoliciesTotal(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-auth-method.md b/examples/1.9.x/server-go/examples/project/update-auth-method.md new file mode 100644 index 000000000..6809ea9a5 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-auth-method.md @@ -0,0 +1,22 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateAuthMethod( + "email-password", + false, +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-mock-phone.md b/examples/1.9.x/server-go/examples/project/update-mock-phone.md new file mode 100644 index 000000000..e03b5c8d0 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-mock-phone.md @@ -0,0 +1,22 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateMockPhone( + "+12065550100", + "", +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..40f1328d5 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Amazon( + project.WithUpdateOAuth2AmazonClientId(""), + project.WithUpdateOAuth2AmazonClientSecret(""), + project.WithUpdateOAuth2AmazonEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..52a9a7eb3 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,25 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Apple( + project.WithUpdateOAuth2AppleServiceId(""), + project.WithUpdateOAuth2AppleKeyId(""), + project.WithUpdateOAuth2AppleTeamId(""), + project.WithUpdateOAuth2AppleP8File(""), + project.WithUpdateOAuth2AppleEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..a0af729e7 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,24 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Auth0( + project.WithUpdateOAuth2Auth0ClientId(""), + project.WithUpdateOAuth2Auth0ClientSecret(""), + project.WithUpdateOAuth2Auth0Endpoint(""), + project.WithUpdateOAuth2Auth0Enabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..adf50fca1 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,24 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Authentik( + project.WithUpdateOAuth2AuthentikClientId(""), + project.WithUpdateOAuth2AuthentikClientSecret(""), + project.WithUpdateOAuth2AuthentikEndpoint(""), + project.WithUpdateOAuth2AuthentikEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..5dc1b7a80 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Autodesk( + project.WithUpdateOAuth2AutodeskClientId(""), + project.WithUpdateOAuth2AutodeskClientSecret(""), + project.WithUpdateOAuth2AutodeskEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..e221a5cc7 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Bitbucket( + project.WithUpdateOAuth2BitbucketKey(""), + project.WithUpdateOAuth2BitbucketSecret(""), + project.WithUpdateOAuth2BitbucketEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..86e56a403 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Bitly( + project.WithUpdateOAuth2BitlyClientId(""), + project.WithUpdateOAuth2BitlyClientSecret(""), + project.WithUpdateOAuth2BitlyEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..eda503e76 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-box.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Box( + project.WithUpdateOAuth2BoxClientId(""), + project.WithUpdateOAuth2BoxClientSecret(""), + project.WithUpdateOAuth2BoxEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..a60b58ae5 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Dailymotion( + project.WithUpdateOAuth2DailymotionApiKey(""), + project.WithUpdateOAuth2DailymotionApiSecret(""), + project.WithUpdateOAuth2DailymotionEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..2aa0b489e --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Discord( + project.WithUpdateOAuth2DiscordClientId(""), + project.WithUpdateOAuth2DiscordClientSecret(""), + project.WithUpdateOAuth2DiscordEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..65cb257b8 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Disqus( + project.WithUpdateOAuth2DisqusPublicKey(""), + project.WithUpdateOAuth2DisqusSecretKey(""), + project.WithUpdateOAuth2DisqusEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..43449c156 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Dropbox( + project.WithUpdateOAuth2DropboxAppKey(""), + project.WithUpdateOAuth2DropboxAppSecret(""), + project.WithUpdateOAuth2DropboxEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..e27df0832 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Etsy( + project.WithUpdateOAuth2EtsyKeyString(""), + project.WithUpdateOAuth2EtsySharedSecret(""), + project.WithUpdateOAuth2EtsyEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..c71536358 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Facebook( + project.WithUpdateOAuth2FacebookAppId(""), + project.WithUpdateOAuth2FacebookAppSecret(""), + project.WithUpdateOAuth2FacebookEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..594f730de --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Figma( + project.WithUpdateOAuth2FigmaClientId(""), + project.WithUpdateOAuth2FigmaClientSecret(""), + project.WithUpdateOAuth2FigmaEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..4dcb531b2 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,24 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2FusionAuth( + project.WithUpdateOAuth2FusionAuthClientId(""), + project.WithUpdateOAuth2FusionAuthClientSecret(""), + project.WithUpdateOAuth2FusionAuthEndpoint(""), + project.WithUpdateOAuth2FusionAuthEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..ac141d817 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2GitHub( + project.WithUpdateOAuth2GitHubClientId(""), + project.WithUpdateOAuth2GitHubClientSecret(""), + project.WithUpdateOAuth2GitHubEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..0da520adf --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,24 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Gitlab( + project.WithUpdateOAuth2GitlabApplicationId(""), + project.WithUpdateOAuth2GitlabSecret(""), + project.WithUpdateOAuth2GitlabEndpoint("https://example.com"), + project.WithUpdateOAuth2GitlabEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..b6c9bc9de --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-google.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Google( + project.WithUpdateOAuth2GoogleClientId(""), + project.WithUpdateOAuth2GoogleClientSecret(""), + project.WithUpdateOAuth2GoogleEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..449b053c6 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,25 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Keycloak( + project.WithUpdateOAuth2KeycloakClientId(""), + project.WithUpdateOAuth2KeycloakClientSecret(""), + project.WithUpdateOAuth2KeycloakEndpoint(""), + project.WithUpdateOAuth2KeycloakRealmName(""), + project.WithUpdateOAuth2KeycloakEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..c074e7588 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Kick( + project.WithUpdateOAuth2KickClientId(""), + project.WithUpdateOAuth2KickClientSecret(""), + project.WithUpdateOAuth2KickEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..5dc25372b --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Linkedin( + project.WithUpdateOAuth2LinkedinClientId(""), + project.WithUpdateOAuth2LinkedinPrimaryClientSecret(""), + project.WithUpdateOAuth2LinkedinEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..993a4fb9e --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,24 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Microsoft( + project.WithUpdateOAuth2MicrosoftApplicationId(""), + project.WithUpdateOAuth2MicrosoftApplicationSecret(""), + project.WithUpdateOAuth2MicrosoftTenant(""), + project.WithUpdateOAuth2MicrosoftEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..6a38af4f4 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Notion( + project.WithUpdateOAuth2NotionOauthClientId(""), + project.WithUpdateOAuth2NotionOauthClientSecret(""), + project.WithUpdateOAuth2NotionEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..98e9abb44 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,27 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Oidc( + project.WithUpdateOAuth2OidcClientId(""), + project.WithUpdateOAuth2OidcClientSecret(""), + project.WithUpdateOAuth2OidcWellKnownURL("https://example.com"), + project.WithUpdateOAuth2OidcAuthorizationURL("https://example.com"), + project.WithUpdateOAuth2OidcTokenUrl("https://example.com"), + project.WithUpdateOAuth2OidcUserInfoUrl("https://example.com"), + project.WithUpdateOAuth2OidcEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..54b705ede --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,25 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Okta( + project.WithUpdateOAuth2OktaClientId(""), + project.WithUpdateOAuth2OktaClientSecret(""), + project.WithUpdateOAuth2OktaDomain(""), + project.WithUpdateOAuth2OktaAuthorizationServerId(""), + project.WithUpdateOAuth2OktaEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..e97df81db --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2PaypalSandbox( + project.WithUpdateOAuth2PaypalSandboxClientId(""), + project.WithUpdateOAuth2PaypalSandboxSecretKey(""), + project.WithUpdateOAuth2PaypalSandboxEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..b7eeb3197 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Paypal( + project.WithUpdateOAuth2PaypalClientId(""), + project.WithUpdateOAuth2PaypalSecretKey(""), + project.WithUpdateOAuth2PaypalEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..057f0369f --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Podio( + project.WithUpdateOAuth2PodioClientId(""), + project.WithUpdateOAuth2PodioClientSecret(""), + project.WithUpdateOAuth2PodioEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..9439a8e14 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Salesforce( + project.WithUpdateOAuth2SalesforceCustomerKey(""), + project.WithUpdateOAuth2SalesforceCustomerSecret(""), + project.WithUpdateOAuth2SalesforceEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..e9fb3f56f --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Slack( + project.WithUpdateOAuth2SlackClientId(""), + project.WithUpdateOAuth2SlackClientSecret(""), + project.WithUpdateOAuth2SlackEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..2e8548944 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Spotify( + project.WithUpdateOAuth2SpotifyClientId(""), + project.WithUpdateOAuth2SpotifyClientSecret(""), + project.WithUpdateOAuth2SpotifyEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..801b26ec4 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Stripe( + project.WithUpdateOAuth2StripeClientId(""), + project.WithUpdateOAuth2StripeApiSecretKey(""), + project.WithUpdateOAuth2StripeEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..93863ebb3 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2TradeshiftSandbox( + project.WithUpdateOAuth2TradeshiftSandboxOauth2ClientId(""), + project.WithUpdateOAuth2TradeshiftSandboxOauth2ClientSecret(""), + project.WithUpdateOAuth2TradeshiftSandboxEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..901b78d5e --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Tradeshift( + project.WithUpdateOAuth2TradeshiftOauth2ClientId(""), + project.WithUpdateOAuth2TradeshiftOauth2ClientSecret(""), + project.WithUpdateOAuth2TradeshiftEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..f79cc0860 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Twitch( + project.WithUpdateOAuth2TwitchClientId(""), + project.WithUpdateOAuth2TwitchClientSecret(""), + project.WithUpdateOAuth2TwitchEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..b9bd6a996 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2WordPress( + project.WithUpdateOAuth2WordPressClientId(""), + project.WithUpdateOAuth2WordPressClientSecret(""), + project.WithUpdateOAuth2WordPressEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..da70f7dae --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Yahoo( + project.WithUpdateOAuth2YahooClientId(""), + project.WithUpdateOAuth2YahooClientSecret(""), + project.WithUpdateOAuth2YahooEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..94955c321 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Yandex( + project.WithUpdateOAuth2YandexClientId(""), + project.WithUpdateOAuth2YandexClientSecret(""), + project.WithUpdateOAuth2YandexEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..62bc29041 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Zoho( + project.WithUpdateOAuth2ZohoClientId(""), + project.WithUpdateOAuth2ZohoClientSecret(""), + project.WithUpdateOAuth2ZohoEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..afc7519d3 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2Zoom( + project.WithUpdateOAuth2ZoomClientId(""), + project.WithUpdateOAuth2ZoomClientSecret(""), + project.WithUpdateOAuth2ZoomEnabled(false), +) +``` diff --git a/examples/1.9.x/server-go/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-go/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..596e626d9 --- /dev/null +++ b/examples/1.9.x/server-go/examples/project/update-o-auth-2x.md @@ -0,0 +1,23 @@ +```go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/v3/client" + "github.com/appwrite/sdk-for-go/v3/project" +) + +client := client.New( + client.WithEndpoint("https://.cloud.appwrite.io/v1") + client.WithProject("") + client.WithKey("") +) + +service := project.New(client) + +response, error := service.UpdateOAuth2X( + project.WithUpdateOAuth2XCustomerKey(""), + project.WithUpdateOAuth2XSecretKey(""), + project.WithUpdateOAuth2XEnabled(false), +) +``` diff --git a/examples/1.9.x/server-graphql/examples/functions/create-deployment.md b/examples/1.9.x/server-graphql/examples/functions/create-deployment.md index dc52095db..0d4d81258 100644 --- a/examples/1.9.x/server-graphql/examples/functions/create-deployment.md +++ b/examples/1.9.x/server-graphql/examples/functions/create-deployment.md @@ -2,7 +2,7 @@ POST /v1/functions/{functionId}/deployments HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: Content-Length: *Length of your entity body in bytes* diff --git a/examples/1.9.x/server-graphql/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-graphql/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..fb1731f29 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/create-ephemeral-key.md @@ -0,0 +1,18 @@ +```graphql +mutation { + projectCreateEphemeralKey( + scopes: [], + duration: 1 + ) { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/create-mock-phone.md b/examples/1.9.x/server-graphql/examples/project/create-mock-phone.md new file mode 100644 index 000000000..4c46c01bd --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/create-mock-phone.md @@ -0,0 +1,13 @@ +```graphql +mutation { + projectCreateMockPhone( + number: "+12065550100", + otp: "" + ) { + number + otp + _createdAt + _updatedAt + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/delete-mock-phone.md b/examples/1.9.x/server-graphql/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..0626a7d3c --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/delete-mock-phone.md @@ -0,0 +1,9 @@ +```graphql +mutation { + projectDeleteMockPhone( + number: "+12065550100" + ) { + status + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/delete.md b/examples/1.9.x/server-graphql/examples/project/delete.md new file mode 100644 index 000000000..aae98b628 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/delete.md @@ -0,0 +1,7 @@ +```graphql +mutation { + projectDelete { + status + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-mock-phone.md b/examples/1.9.x/server-graphql/examples/project/get-mock-phone.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/get-mock-phone.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-graphql/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.9.x/server-graphql/examples/project/get-policy.md b/examples/1.9.x/server-graphql/examples/project/get-policy.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/get-policy.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-email-templates.md b/examples/1.9.x/server-graphql/examples/project/list-email-templates.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/list-email-templates.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-mock-phones.md b/examples/1.9.x/server-graphql/examples/project/list-mock-phones.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/list-mock-phones.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-graphql/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.9.x/server-graphql/examples/project/list-policies.md b/examples/1.9.x/server-graphql/examples/project/list-policies.md new file mode 100644 index 000000000..d7962b96e --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/list-policies.md @@ -0,0 +1,2 @@ +```graphql +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-auth-method.md b/examples/1.9.x/server-graphql/examples/project/update-auth-method.md new file mode 100644 index 000000000..b641ba198 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-auth-method.md @@ -0,0 +1,154 @@ +```graphql +mutation { + projectUpdateAuthMethod( + methodId: "email-password", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + description + teamId + logo + url + legalName + legalCountry + legalState + legalCity + legalAddress + legalTaxId + authDuration + authLimit + authSessionsLimit + authPasswordHistory + authPasswordDictionary + authPersonalDataCheck + authDisposableEmails + authCanonicalEmails + authFreeEmails + authMockNumbers { + number + otp + _createdAt + _updatedAt + } + authSessionAlerts + authMembershipsUserName + authMembershipsUserEmail + authMembershipsMfa + authMembershipsUserId + authMembershipsUserPhone + authInvalidateSessions + oAuthProviders { + key + name + appId + secret + enabled + } + platforms + webhooks { + _id + _createdAt + _updatedAt + name + url + events + tls + authUsername + authPassword + secret + enabled + logs + attempts + } + keys { + _id + _createdAt + _updatedAt + name + expire + scopes + secret + accessedAt + sdks + } + devKeys { + _id + _createdAt + _updatedAt + name + expire + secret + accessedAt + sdks + } + smtpEnabled + smtpSenderName + smtpSenderEmail + smtpReplyToName + smtpReplyToEmail + smtpHost + smtpPort + smtpUsername + smtpPassword + smtpSecure + pingCount + pingedAt + labels + status + authEmailPassword + authUsersAuthMagicURL + authEmailOtp + authAnonymous + authInvites + authJWT + authPhone + serviceStatusForAccount + serviceStatusForAvatars + serviceStatusForDatabases + serviceStatusForTablesdb + serviceStatusForLocale + serviceStatusForHealth + serviceStatusForProject + serviceStatusForStorage + serviceStatusForTeams + serviceStatusForUsers + serviceStatusForVcs + serviceStatusForSites + serviceStatusForFunctions + serviceStatusForProxy + serviceStatusForGraphql + serviceStatusForMigrations + serviceStatusForMessaging + protocolStatusForRest + protocolStatusForGraphql + protocolStatusForWebsocket + region + billingLimits { + bandwidth + storage + users + executions + GBHours + imageTransformations + authPhone + budgetLimit + } + blocks { + _createdAt + resourceType + resourceId + reason + expiredAt + projectName + region + organizationName + organizationId + billingPlan + } + consoleAccessedAt + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-labels.md b/examples/1.9.x/server-graphql/examples/project/update-labels.md index 49a0a36c4..f5fb202c6 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-labels.md +++ b/examples/1.9.x/server-graphql/examples/project/update-labels.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-graphql/examples/project/update-membership-privacy-policy.md index 8e95070ab..e9f7ccf5c 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-membership-privacy-policy.md @@ -31,8 +31,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -143,6 +145,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-mock-phone.md b/examples/1.9.x/server-graphql/examples/project/update-mock-phone.md new file mode 100644 index 000000000..4194a6bb2 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-mock-phone.md @@ -0,0 +1,13 @@ +```graphql +mutation { + projectUpdateMockPhone( + number: "+12065550100", + otp: "" + ) { + number + otp + _createdAt + _updatedAt + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..96cfe2796 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Amazon( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..3d9c6f1a9 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,18 @@ +```graphql +mutation { + projectUpdateOAuth2Apple( + serviceId: "", + keyId: "", + teamId: "", + p8File: "", + enabled: false + ) { + _id + enabled + serviceId + keyId + teamId + p8File + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..746d0517f --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,16 @@ +```graphql +mutation { + projectUpdateOAuth2Auth0( + clientId: "", + clientSecret: "", + endpoint: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + endpoint + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..bee04673c --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,16 @@ +```graphql +mutation { + projectUpdateOAuth2Authentik( + clientId: "", + clientSecret: "", + endpoint: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + endpoint + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..d238ce1a0 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Autodesk( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..41139c2e1 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Bitbucket( + key: "", + secret: "", + enabled: false + ) { + _id + enabled + key + secret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..72c7707a1 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Bitly( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..faa83fc35 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-box.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Box( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..dad14b649 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Dailymotion( + apiKey: "", + apiSecret: "", + enabled: false + ) { + _id + enabled + apiKey + apiSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..0b3ed71c6 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Discord( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..34890edfa --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Disqus( + publicKey: "", + secretKey: "", + enabled: false + ) { + _id + enabled + publicKey + secretKey + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..1a78a1ffd --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Dropbox( + appKey: "", + appSecret: "", + enabled: false + ) { + _id + enabled + appKey + appSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..70ca5c82f --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Etsy( + keyString: "", + sharedSecret: "", + enabled: false + ) { + _id + enabled + keyString + sharedSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..e282290d1 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Facebook( + appId: "", + appSecret: "", + enabled: false + ) { + _id + enabled + appId + appSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..17d332abc --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Figma( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..e7447d1c8 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,16 @@ +```graphql +mutation { + projectUpdateOAuth2FusionAuth( + clientId: "", + clientSecret: "", + endpoint: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + endpoint + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..f5a3880bd --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2GitHub( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..7ff242b8e --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,16 @@ +```graphql +mutation { + projectUpdateOAuth2Gitlab( + applicationId: "", + secret: "", + endpoint: "https://example.com", + enabled: false + ) { + _id + enabled + applicationId + secret + endpoint + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..9d38e3693 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-google.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Google( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..881cb1d5c --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,18 @@ +```graphql +mutation { + projectUpdateOAuth2Keycloak( + clientId: "", + clientSecret: "", + endpoint: "", + realmName: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + endpoint + realmName + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..09d6779e1 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Kick( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..50f56f116 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Linkedin( + clientId: "", + primaryClientSecret: "", + enabled: false + ) { + _id + enabled + clientId + primaryClientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..b80848c01 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,16 @@ +```graphql +mutation { + projectUpdateOAuth2Microsoft( + applicationId: "", + applicationSecret: "", + tenant: "", + enabled: false + ) { + _id + enabled + applicationId + applicationSecret + tenant + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..be481aecd --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Notion( + oauthClientId: "", + oauthClientSecret: "", + enabled: false + ) { + _id + enabled + oauthClientId + oauthClientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..8bcad9164 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,22 @@ +```graphql +mutation { + projectUpdateOAuth2Oidc( + clientId: "", + clientSecret: "", + wellKnownURL: "https://example.com", + authorizationURL: "https://example.com", + tokenUrl: "https://example.com", + userInfoUrl: "https://example.com", + enabled: false + ) { + _id + enabled + clientId + clientSecret + wellKnownURL + authorizationURL + tokenUrl + userInfoUrl + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..0ce37992c --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,18 @@ +```graphql +mutation { + projectUpdateOAuth2Okta( + clientId: "", + clientSecret: "", + domain: "", + authorizationServerId: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + domain + authorizationServerId + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..9d22e49be --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2PaypalSandbox( + clientId: "", + secretKey: "", + enabled: false + ) { + _id + enabled + clientId + secretKey + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..d106a4ddb --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Paypal( + clientId: "", + secretKey: "", + enabled: false + ) { + _id + enabled + clientId + secretKey + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..41847a43f --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Podio( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..ab63ff525 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Salesforce( + customerKey: "", + customerSecret: "", + enabled: false + ) { + _id + enabled + customerKey + customerSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..cdee16942 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Slack( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..cd0b342ae --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Spotify( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..c34176870 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Stripe( + clientId: "", + apiSecretKey: "", + enabled: false + ) { + _id + enabled + clientId + apiSecretKey + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..6bcf5dc9b --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2TradeshiftSandbox( + oauth2ClientId: "", + oauth2ClientSecret: "", + enabled: false + ) { + _id + enabled + oauth2ClientId + oauth2ClientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..dda26edc9 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Tradeshift( + oauth2ClientId: "", + oauth2ClientSecret: "", + enabled: false + ) { + _id + enabled + oauth2ClientId + oauth2ClientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..60893d37a --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Twitch( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..2c1a90d4b --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2WordPress( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..0cebeb3bb --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Yahoo( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..e26e2c344 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Yandex( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..b71bd18d5 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Zoho( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..3ef225a46 --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2Zoom( + clientId: "", + clientSecret: "", + enabled: false + ) { + _id + enabled + clientId + clientSecret + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..79bb52c9a --- /dev/null +++ b/examples/1.9.x/server-graphql/examples/project/update-o-auth-2x.md @@ -0,0 +1,14 @@ +```graphql +mutation { + projectUpdateOAuth2X( + customerKey: "", + secretKey: "", + enabled: false + ) { + _id + enabled + customerKey + secretKey + } +} +``` diff --git a/examples/1.9.x/server-graphql/examples/project/update-password-dictionary-policy.md b/examples/1.9.x/server-graphql/examples/project/update-password-dictionary-policy.md index 25b70b1fd..5786e1989 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-password-dictionary-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-password-dictionary-policy.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-password-history-policy.md b/examples/1.9.x/server-graphql/examples/project/update-password-history-policy.md index e8eba785a..58da0aa2c 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-password-history-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-password-history-policy.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-password-personal-data-policy.md b/examples/1.9.x/server-graphql/examples/project/update-password-personal-data-policy.md index 8d5ea397c..d07fe54f3 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-password-personal-data-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-password-personal-data-policy.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-protocol.md b/examples/1.9.x/server-graphql/examples/project/update-protocol.md index 6ad0b53bb..ea513f535 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-protocol.md +++ b/examples/1.9.x/server-graphql/examples/project/update-protocol.md @@ -28,8 +28,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -140,6 +142,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-service.md b/examples/1.9.x/server-graphql/examples/project/update-service.md index 014ad9f85..c24784701 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-service.md +++ b/examples/1.9.x/server-graphql/examples/project/update-service.md @@ -28,8 +28,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -140,6 +142,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-session-alert-policy.md b/examples/1.9.x/server-graphql/examples/project/update-session-alert-policy.md index 9450c4c7e..463c228dd 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-session-alert-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-session-alert-policy.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-session-duration-policy.md b/examples/1.9.x/server-graphql/examples/project/update-session-duration-policy.md index 697e559b5..848a60cbd 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-session-duration-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-session-duration-policy.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-session-invalidation-policy.md b/examples/1.9.x/server-graphql/examples/project/update-session-invalidation-policy.md index 386aafdda..57e493720 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-session-invalidation-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-session-invalidation-policy.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-session-limit-policy.md b/examples/1.9.x/server-graphql/examples/project/update-session-limit-policy.md index 6282adfb9..b37b25d0a 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-session-limit-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-session-limit-policy.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-smtp.md b/examples/1.9.x/server-graphql/examples/project/update-smtp.md index f2225b9d4..21ab4ee0a 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-smtp.md +++ b/examples/1.9.x/server-graphql/examples/project/update-smtp.md @@ -36,8 +36,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -148,6 +150,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/project/update-user-limit-policy.md b/examples/1.9.x/server-graphql/examples/project/update-user-limit-policy.md index 98da248a7..7b2bf5323 100644 --- a/examples/1.9.x/server-graphql/examples/project/update-user-limit-policy.md +++ b/examples/1.9.x/server-graphql/examples/project/update-user-limit-policy.md @@ -27,8 +27,10 @@ mutation { authCanonicalEmails authFreeEmails authMockNumbers { - phone + number otp + _createdAt + _updatedAt } authSessionAlerts authMembershipsUserName @@ -139,6 +141,11 @@ mutation { resourceId reason expiredAt + projectName + region + organizationName + organizationId + billingPlan } consoleAccessedAt } diff --git a/examples/1.9.x/server-graphql/examples/sites/create-deployment.md b/examples/1.9.x/server-graphql/examples/sites/create-deployment.md index b49b557bd..2ce018679 100644 --- a/examples/1.9.x/server-graphql/examples/sites/create-deployment.md +++ b/examples/1.9.x/server-graphql/examples/sites/create-deployment.md @@ -2,7 +2,7 @@ POST /v1/sites/{siteId}/deployments HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: Content-Length: *Length of your entity body in bytes* diff --git a/examples/1.9.x/server-graphql/examples/storage/create-file.md b/examples/1.9.x/server-graphql/examples/storage/create-file.md index 04932fcf5..4eb9dd13d 100644 --- a/examples/1.9.x/server-graphql/examples/storage/create-file.md +++ b/examples/1.9.x/server-graphql/examples/storage/create-file.md @@ -2,7 +2,7 @@ POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-kotlin/java/functions/create.md b/examples/1.9.x/server-kotlin/java/functions/create.md index d423c66ba..4fbeee4a0 100644 --- a/examples/1.9.x/server-kotlin/java/functions/create.md +++ b/examples/1.9.x/server-kotlin/java/functions/create.md @@ -24,7 +24,7 @@ functions.create( false, // logging (optional) "", // entrypoint (optional) "", // commands (optional) - List.of(Scopes.SESSIONS_WRITE), // scopes (optional) + List.of(Scopes.PROJECT_READ), // scopes (optional) "", // installationId (optional) "", // providerRepositoryId (optional) "", // providerBranch (optional) diff --git a/examples/1.9.x/server-kotlin/java/functions/update.md b/examples/1.9.x/server-kotlin/java/functions/update.md index 5e7b5c890..09e3264d9 100644 --- a/examples/1.9.x/server-kotlin/java/functions/update.md +++ b/examples/1.9.x/server-kotlin/java/functions/update.md @@ -24,7 +24,7 @@ functions.update( false, // logging (optional) "", // entrypoint (optional) "", // commands (optional) - List.of(Scopes.SESSIONS_WRITE), // scopes (optional) + List.of(Scopes.PROJECT_READ), // scopes (optional) "", // installationId (optional) "", // providerRepositoryId (optional) "", // providerBranch (optional) diff --git a/examples/1.9.x/server-kotlin/java/project/create-ephemeral-key.md b/examples/1.9.x/server-kotlin/java/project/create-ephemeral-key.md new file mode 100644 index 000000000..0702c761e --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/create-ephemeral-key.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; +import io.appwrite.enums.Scopes; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.createEphemeralKey( + List.of(Scopes.PROJECT_READ), // scopes + 1, // duration + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/create-key.md b/examples/1.9.x/server-kotlin/java/project/create-key.md index 90c1becf0..2a0ec20ef 100644 --- a/examples/1.9.x/server-kotlin/java/project/create-key.md +++ b/examples/1.9.x/server-kotlin/java/project/create-key.md @@ -14,7 +14,7 @@ Project project = new Project(client); project.createKey( "", // keyId "", // name - List.of(Scopes.SESSIONS_WRITE), // scopes + List.of(Scopes.PROJECT_READ), // scopes "2020-10-15T06:38:00.000+00:00", // expire (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { diff --git a/examples/1.9.x/server-kotlin/java/project/create-mock-phone.md b/examples/1.9.x/server-kotlin/java/project/create-mock-phone.md new file mode 100644 index 000000000..44acac492 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/create-mock-phone.md @@ -0,0 +1,26 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.createMockPhone( + "+12065550100", // number + "", // otp + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/delete-mock-phone.md b/examples/1.9.x/server-kotlin/java/project/delete-mock-phone.md new file mode 100644 index 000000000..45bab07db --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/delete-mock-phone.md @@ -0,0 +1,25 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.deleteMockPhone( + "+12065550100", // number + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/delete.md b/examples/1.9.x/server-kotlin/java/project/delete.md new file mode 100644 index 000000000..14b750998 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/delete.md @@ -0,0 +1,21 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.delete(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); +``` diff --git a/examples/1.9.x/server-kotlin/java/project/get-mock-phone.md b/examples/1.9.x/server-kotlin/java/project/get-mock-phone.md new file mode 100644 index 000000000..3c7c98478 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/get-mock-phone.md @@ -0,0 +1,25 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.getMockPhone( + "+12065550100", // number + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/get-o-auth-2-provider.md b/examples/1.9.x/server-kotlin/java/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..a8b3dd697 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/get-o-auth-2-provider.md @@ -0,0 +1,25 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.getOAuth2Provider( + "", // provider + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/get-policy.md b/examples/1.9.x/server-kotlin/java/project/get-policy.md new file mode 100644 index 000000000..fdd245700 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/get-policy.md @@ -0,0 +1,26 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; +import io.appwrite.enums.PolicyId; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.getPolicy( + PolicyId.PASSWORD_DICTIONARY, // policyId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/list-email-templates.md b/examples/1.9.x/server-kotlin/java/project/list-email-templates.md new file mode 100644 index 000000000..98fb6835f --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/list-email-templates.md @@ -0,0 +1,26 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.listEmailTemplates( + List.of(), // queries (optional) + false, // total (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/list-mock-phones.md b/examples/1.9.x/server-kotlin/java/project/list-mock-phones.md new file mode 100644 index 000000000..9bcdde7aa --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/list-mock-phones.md @@ -0,0 +1,26 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.listMockPhones( + List.of(), // queries (optional) + false, // total (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/list-o-auth-2-providers.md b/examples/1.9.x/server-kotlin/java/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..976a6f103 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/list-o-auth-2-providers.md @@ -0,0 +1,21 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.listOAuth2Providers(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); +``` diff --git a/examples/1.9.x/server-kotlin/java/project/list-policies.md b/examples/1.9.x/server-kotlin/java/project/list-policies.md new file mode 100644 index 000000000..91757f4e3 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/list-policies.md @@ -0,0 +1,26 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.listPolicies( + List.of(), // queries (optional) + false, // total (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-auth-method.md b/examples/1.9.x/server-kotlin/java/project/update-auth-method.md new file mode 100644 index 000000000..80f4195d3 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-auth-method.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; +import io.appwrite.enums.MethodId; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateAuthMethod( + MethodId.EMAIL_PASSWORD, // methodId + false, // enabled + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-key.md b/examples/1.9.x/server-kotlin/java/project/update-key.md index 2d7cec3c5..aee5f2b94 100644 --- a/examples/1.9.x/server-kotlin/java/project/update-key.md +++ b/examples/1.9.x/server-kotlin/java/project/update-key.md @@ -14,7 +14,7 @@ Project project = new Project(client); project.updateKey( "", // keyId "", // name - List.of(Scopes.SESSIONS_WRITE), // scopes + List.of(Scopes.PROJECT_READ), // scopes "2020-10-15T06:38:00.000+00:00", // expire (optional) new CoroutineCallback<>((result, error) -> { if (error != null) { diff --git a/examples/1.9.x/server-kotlin/java/project/update-mock-phone.md b/examples/1.9.x/server-kotlin/java/project/update-mock-phone.md new file mode 100644 index 000000000..adc75fb9c --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-mock-phone.md @@ -0,0 +1,26 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateMockPhone( + "+12065550100", // number + "", // otp + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..b58b0114b --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-amazon.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Amazon( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-apple.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..9eeb9dd8a --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-apple.md @@ -0,0 +1,29 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Apple( + "", // serviceId (optional) + "", // keyId (optional) + "", // teamId (optional) + "", // p8File (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..c14a8ef5f --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-auth-0.md @@ -0,0 +1,28 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Auth0( + "", // clientId (optional) + "", // clientSecret (optional) + "", // endpoint (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..cfbe273a5 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-authentik.md @@ -0,0 +1,28 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Authentik( + "", // clientId (optional) + "", // clientSecret (optional) + "", // endpoint (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..605750d31 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-autodesk.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Autodesk( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..6fe51fd80 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Bitbucket( + "", // key (optional) + "", // secret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..a3c14ddc9 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-bitly.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Bitly( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-box.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-box.md new file mode 100644 index 000000000..03418f17e --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-box.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Box( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..0db1d9a05 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Dailymotion( + "", // apiKey (optional) + "", // apiSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-discord.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..82139314b --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-discord.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Discord( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..d29dc872a --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-disqus.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Disqus( + "", // publicKey (optional) + "", // secretKey (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..0545a5817 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-dropbox.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Dropbox( + "", // appKey (optional) + "", // appSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..9e64828ae --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-etsy.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Etsy( + "", // keyString (optional) + "", // sharedSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..abfc06375 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-facebook.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Facebook( + "", // appId (optional) + "", // appSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-figma.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..df58f04bc --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-figma.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Figma( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..ae251db37 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,28 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2FusionAuth( + "", // clientId (optional) + "", // clientSecret (optional) + "", // endpoint (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..e795770a5 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-git-hub.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2GitHub( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..f61e79736 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-gitlab.md @@ -0,0 +1,28 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Gitlab( + "", // applicationId (optional) + "", // secret (optional) + "https://example.com", // endpoint (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-google.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-google.md new file mode 100644 index 000000000..55a845750 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-google.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Google( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..bf5e16f70 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-keycloak.md @@ -0,0 +1,29 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Keycloak( + "", // clientId (optional) + "", // clientSecret (optional) + "", // endpoint (optional) + "", // realmName (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-kick.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..9c771b89f --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-kick.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Kick( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..4f7db46a2 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-linkedin.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Linkedin( + "", // clientId (optional) + "", // primaryClientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..801cc7c8a --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-microsoft.md @@ -0,0 +1,28 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Microsoft( + "", // applicationId (optional) + "", // applicationSecret (optional) + "", // tenant (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-notion.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..6f898dbe9 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-notion.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Notion( + "", // oauthClientId (optional) + "", // oauthClientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..9c6af904b --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-oidc.md @@ -0,0 +1,31 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Oidc( + "", // clientId (optional) + "", // clientSecret (optional) + "https://example.com", // wellKnownURL (optional) + "https://example.com", // authorizationURL (optional) + "https://example.com", // tokenUrl (optional) + "https://example.com", // userInfoUrl (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-okta.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..a8b31ef84 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-okta.md @@ -0,0 +1,29 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Okta( + "", // clientId (optional) + "", // clientSecret (optional) + "", // domain (optional) + "", // authorizationServerId (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..2e1b8a5d2 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2PaypalSandbox( + "", // clientId (optional) + "", // secretKey (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..6169ad05a --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-paypal.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Paypal( + "", // clientId (optional) + "", // secretKey (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-podio.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..40da7cabd --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-podio.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Podio( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..e6aa570af --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-salesforce.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Salesforce( + "", // customerKey (optional) + "", // customerSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-slack.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..c62f48bca --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-slack.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Slack( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..85eef6a3a --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-spotify.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Spotify( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..c6c8a7357 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-stripe.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Stripe( + "", // clientId (optional) + "", // apiSecretKey (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..ca9f55c03 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2TradeshiftSandbox( + "", // oauth2ClientId (optional) + "", // oauth2ClientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..9ab62a476 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Tradeshift( + "", // oauth2ClientId (optional) + "", // oauth2ClientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..4bc43d006 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-twitch.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Twitch( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..06a9745a7 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-word-press.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2WordPress( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..db93ec6e7 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-yahoo.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Yahoo( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..cf4c4500e --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-yandex.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Yandex( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..c8c5e1362 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-zoho.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Zoho( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..b809dc018 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2-zoom.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2Zoom( + "", // clientId (optional) + "", // clientSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/java/project/update-o-auth-2x.md b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2x.md new file mode 100644 index 000000000..d59ea9806 --- /dev/null +++ b/examples/1.9.x/server-kotlin/java/project/update-o-auth-2x.md @@ -0,0 +1,27 @@ +```java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey(""); // Your secret API key + +Project project = new Project(client); + +project.updateOAuth2X( + "", // customerKey (optional) + "", // secretKey (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/functions/create.md b/examples/1.9.x/server-kotlin/kotlin/functions/create.md index ce62e4037..c742bc55b 100644 --- a/examples/1.9.x/server-kotlin/kotlin/functions/create.md +++ b/examples/1.9.x/server-kotlin/kotlin/functions/create.md @@ -24,7 +24,7 @@ val response = functions.create( logging = false, // optional entrypoint = "", // optional commands = "", // optional - scopes = listOf(Scopes.SESSIONS_WRITE), // optional + scopes = listOf(Scopes.PROJECT_READ), // optional installationId = "", // optional providerRepositoryId = "", // optional providerBranch = "", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/functions/update.md b/examples/1.9.x/server-kotlin/kotlin/functions/update.md index a686091f8..002968245 100644 --- a/examples/1.9.x/server-kotlin/kotlin/functions/update.md +++ b/examples/1.9.x/server-kotlin/kotlin/functions/update.md @@ -24,7 +24,7 @@ val response = functions.update( logging = false, // optional entrypoint = "", // optional commands = "", // optional - scopes = listOf(Scopes.SESSIONS_WRITE), // optional + scopes = listOf(Scopes.PROJECT_READ), // optional installationId = "", // optional providerRepositoryId = "", // optional providerBranch = "", // optional diff --git a/examples/1.9.x/server-kotlin/kotlin/project/create-ephemeral-key.md b/examples/1.9.x/server-kotlin/kotlin/project/create-ephemeral-key.md new file mode 100644 index 000000000..6773194d7 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/create-ephemeral-key.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project +import io.appwrite.enums.Scopes + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.createEphemeralKey( + scopes = listOf(Scopes.PROJECT_READ), + duration = 1 +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/create-key.md b/examples/1.9.x/server-kotlin/kotlin/project/create-key.md index a475456ad..3334d97c0 100644 --- a/examples/1.9.x/server-kotlin/kotlin/project/create-key.md +++ b/examples/1.9.x/server-kotlin/kotlin/project/create-key.md @@ -14,7 +14,7 @@ val project = Project(client) val response = project.createKey( keyId = "", name = "", - scopes = listOf(Scopes.SESSIONS_WRITE), + scopes = listOf(Scopes.PROJECT_READ), expire = "2020-10-15T06:38:00.000+00:00" // optional ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/create-mock-phone.md b/examples/1.9.x/server-kotlin/kotlin/project/create-mock-phone.md new file mode 100644 index 000000000..e8babf68c --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/create-mock-phone.md @@ -0,0 +1,17 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.createMockPhone( + number = "+12065550100", + otp = "" +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/delete-mock-phone.md b/examples/1.9.x/server-kotlin/kotlin/project/delete-mock-phone.md new file mode 100644 index 000000000..963fbc981 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/delete-mock-phone.md @@ -0,0 +1,16 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.deleteMockPhone( + number = "+12065550100" +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/delete.md b/examples/1.9.x/server-kotlin/kotlin/project/delete.md new file mode 100644 index 000000000..29668a25c --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/delete.md @@ -0,0 +1,14 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.delete() +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/get-mock-phone.md b/examples/1.9.x/server-kotlin/kotlin/project/get-mock-phone.md new file mode 100644 index 000000000..3051539db --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/get-mock-phone.md @@ -0,0 +1,16 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.getMockPhone( + number = "+12065550100" +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/get-o-auth-2-provider.md b/examples/1.9.x/server-kotlin/kotlin/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..d07405d30 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/get-o-auth-2-provider.md @@ -0,0 +1,16 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.getOAuth2Provider( + provider = "" +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/get-policy.md b/examples/1.9.x/server-kotlin/kotlin/project/get-policy.md new file mode 100644 index 000000000..d3f58c94d --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/get-policy.md @@ -0,0 +1,17 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project +import io.appwrite.enums.PolicyId + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.getPolicy( + policyId = PolicyId.PASSWORD_DICTIONARY +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/list-email-templates.md b/examples/1.9.x/server-kotlin/kotlin/project/list-email-templates.md new file mode 100644 index 000000000..f1ced3985 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/list-email-templates.md @@ -0,0 +1,17 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.listEmailTemplates( + queries = listOf(), // optional + total = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/list-mock-phones.md b/examples/1.9.x/server-kotlin/kotlin/project/list-mock-phones.md new file mode 100644 index 000000000..6ac56a26d --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/list-mock-phones.md @@ -0,0 +1,17 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.listMockPhones( + queries = listOf(), // optional + total = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/list-o-auth-2-providers.md b/examples/1.9.x/server-kotlin/kotlin/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..a661513c6 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/list-o-auth-2-providers.md @@ -0,0 +1,14 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.listOAuth2Providers() +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/list-policies.md b/examples/1.9.x/server-kotlin/kotlin/project/list-policies.md new file mode 100644 index 000000000..bfad4f513 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/list-policies.md @@ -0,0 +1,17 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.listPolicies( + queries = listOf(), // optional + total = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-auth-method.md b/examples/1.9.x/server-kotlin/kotlin/project/update-auth-method.md new file mode 100644 index 000000000..527fbc685 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-auth-method.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project +import io.appwrite.enums.MethodId + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateAuthMethod( + methodId = MethodId.EMAIL_PASSWORD, + enabled = false +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-key.md b/examples/1.9.x/server-kotlin/kotlin/project/update-key.md index 4e611859a..4f80f5269 100644 --- a/examples/1.9.x/server-kotlin/kotlin/project/update-key.md +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-key.md @@ -14,7 +14,7 @@ val project = Project(client) val response = project.updateKey( keyId = "", name = "", - scopes = listOf(Scopes.SESSIONS_WRITE), + scopes = listOf(Scopes.PROJECT_READ), expire = "2020-10-15T06:38:00.000+00:00" // optional ) ``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-mock-phone.md b/examples/1.9.x/server-kotlin/kotlin/project/update-mock-phone.md new file mode 100644 index 000000000..54b132a33 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-mock-phone.md @@ -0,0 +1,17 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateMockPhone( + number = "+12065550100", + otp = "" +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..552ac2a0b --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-amazon.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Amazon( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-apple.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..9739c0bfe --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-apple.md @@ -0,0 +1,20 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Apple( + serviceId = "", // optional + keyId = "", // optional + teamId = "", // optional + p8File = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..da0419765 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-auth-0.md @@ -0,0 +1,19 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Auth0( + clientId = "", // optional + clientSecret = "", // optional + endpoint = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..8c3b47d37 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-authentik.md @@ -0,0 +1,19 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Authentik( + clientId = "", // optional + clientSecret = "", // optional + endpoint = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..7e0b6dfa3 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-autodesk.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Autodesk( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..6a38d096f --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Bitbucket( + key = "", // optional + secret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..eb6e346ad --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-bitly.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Bitly( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-box.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-box.md new file mode 100644 index 000000000..b77a82cd5 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-box.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Box( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..d45444122 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Dailymotion( + apiKey = "", // optional + apiSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-discord.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..a4d506b3f --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-discord.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Discord( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..83f0d6904 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-disqus.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Disqus( + publicKey = "", // optional + secretKey = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..0b36434ab --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-dropbox.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Dropbox( + appKey = "", // optional + appSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..edec5b5e3 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-etsy.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Etsy( + keyString = "", // optional + sharedSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..952151f25 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-facebook.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Facebook( + appId = "", // optional + appSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-figma.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..fb305af6a --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-figma.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Figma( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..0db1694e2 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,19 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2FusionAuth( + clientId = "", // optional + clientSecret = "", // optional + endpoint = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..e4070b396 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-git-hub.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2GitHub( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..b7779c832 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-gitlab.md @@ -0,0 +1,19 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Gitlab( + applicationId = "", // optional + secret = "", // optional + endpoint = "https://example.com", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-google.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-google.md new file mode 100644 index 000000000..5fb351d17 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-google.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Google( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..ac4012d7b --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-keycloak.md @@ -0,0 +1,20 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Keycloak( + clientId = "", // optional + clientSecret = "", // optional + endpoint = "", // optional + realmName = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-kick.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..1da5c8a09 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-kick.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Kick( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..99e404f4d --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-linkedin.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Linkedin( + clientId = "", // optional + primaryClientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..c44372a88 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-microsoft.md @@ -0,0 +1,19 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Microsoft( + applicationId = "", // optional + applicationSecret = "", // optional + tenant = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-notion.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..05dc95023 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-notion.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Notion( + oauthClientId = "", // optional + oauthClientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..1ab7cfa28 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-oidc.md @@ -0,0 +1,22 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Oidc( + clientId = "", // optional + clientSecret = "", // optional + wellKnownURL = "https://example.com", // optional + authorizationURL = "https://example.com", // optional + tokenUrl = "https://example.com", // optional + userInfoUrl = "https://example.com", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-okta.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..6bf4aeeca --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-okta.md @@ -0,0 +1,20 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Okta( + clientId = "", // optional + clientSecret = "", // optional + domain = "", // optional + authorizationServerId = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..bec13bde6 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2PaypalSandbox( + clientId = "", // optional + secretKey = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..7ceeaa6b4 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-paypal.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Paypal( + clientId = "", // optional + secretKey = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-podio.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..9cc859732 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-podio.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Podio( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..a8b1244b4 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-salesforce.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Salesforce( + customerKey = "", // optional + customerSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-slack.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..358611030 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-slack.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Slack( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..c1431e483 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-spotify.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Spotify( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..bad2cc42a --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-stripe.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Stripe( + clientId = "", // optional + apiSecretKey = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..aec834f93 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2TradeshiftSandbox( + oauth2ClientId = "", // optional + oauth2ClientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..ac5b816a0 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Tradeshift( + oauth2ClientId = "", // optional + oauth2ClientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..e8c1b957e --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-twitch.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Twitch( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..6fbe200d6 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-word-press.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2WordPress( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..c96e6fd7b --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-yahoo.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Yahoo( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..a48d01942 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-yandex.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Yandex( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..98f72a65f --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-zoho.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Zoho( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..c934edf05 --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2-zoom.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2Zoom( + clientId = "", // optional + clientSecret = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2x.md b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2x.md new file mode 100644 index 000000000..ebcc4543a --- /dev/null +++ b/examples/1.9.x/server-kotlin/kotlin/project/update-o-auth-2x.md @@ -0,0 +1,18 @@ +```kotlin +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +val project = Project(client) + +val response = project.updateOAuth2X( + customerKey = "", // optional + secretKey = "", // optional + enabled = false // optional +) +``` diff --git a/examples/1.9.x/server-nodejs/examples/functions/create.md b/examples/1.9.x/server-nodejs/examples/functions/create.md index b0004d85f..4e3d5e953 100644 --- a/examples/1.9.x/server-nodejs/examples/functions/create.md +++ b/examples/1.9.x/server-nodejs/examples/functions/create.md @@ -20,7 +20,7 @@ const result = await functions.create({ logging: false, // optional entrypoint: '', // optional commands: '', // optional - scopes: [sdk.Scopes.SessionsWrite], // optional + scopes: [sdk.Scopes.ProjectRead], // optional installationId: '', // optional providerRepositoryId: '', // optional providerBranch: '', // optional diff --git a/examples/1.9.x/server-nodejs/examples/functions/update.md b/examples/1.9.x/server-nodejs/examples/functions/update.md index 915037fff..fe60cad38 100644 --- a/examples/1.9.x/server-nodejs/examples/functions/update.md +++ b/examples/1.9.x/server-nodejs/examples/functions/update.md @@ -20,7 +20,7 @@ const result = await functions.update({ logging: false, // optional entrypoint: '', // optional commands: '', // optional - scopes: [sdk.Scopes.SessionsWrite], // optional + scopes: [sdk.Scopes.ProjectRead], // optional installationId: '', // optional providerRepositoryId: '', // optional providerBranch: '', // optional diff --git a/examples/1.9.x/server-nodejs/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-nodejs/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..a7cb2511e --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/create-ephemeral-key.md @@ -0,0 +1,15 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.createEphemeralKey({ + scopes: [sdk.Scopes.ProjectRead], + duration: 1 +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/create-key.md b/examples/1.9.x/server-nodejs/examples/project/create-key.md index b5274bfcd..03ba62716 100644 --- a/examples/1.9.x/server-nodejs/examples/project/create-key.md +++ b/examples/1.9.x/server-nodejs/examples/project/create-key.md @@ -11,7 +11,7 @@ const project = new sdk.Project(client); const result = await project.createKey({ keyId: '', name: '', - scopes: [sdk.Scopes.SessionsWrite], + scopes: [sdk.Scopes.ProjectRead], expire: '2020-10-15T06:38:00.000+00:00' // optional }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/project/create-mock-phone.md b/examples/1.9.x/server-nodejs/examples/project/create-mock-phone.md new file mode 100644 index 000000000..6bb2962cc --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/create-mock-phone.md @@ -0,0 +1,15 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.createMockPhone({ + number: '+12065550100', + otp: '' +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/delete-mock-phone.md b/examples/1.9.x/server-nodejs/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..94d341a70 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/delete-mock-phone.md @@ -0,0 +1,14 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.deleteMockPhone({ + number: '+12065550100' +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/delete.md b/examples/1.9.x/server-nodejs/examples/project/delete.md new file mode 100644 index 000000000..150939ed3 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/delete.md @@ -0,0 +1,12 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.delete(); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/get-mock-phone.md b/examples/1.9.x/server-nodejs/examples/project/get-mock-phone.md new file mode 100644 index 000000000..73082c436 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/get-mock-phone.md @@ -0,0 +1,14 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.getMockPhone({ + number: '+12065550100' +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-nodejs/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..32cd5d56d --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,14 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.getOAuth2Provider({ + provider: '' +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/get-policy.md b/examples/1.9.x/server-nodejs/examples/project/get-policy.md new file mode 100644 index 000000000..df5abb549 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/get-policy.md @@ -0,0 +1,14 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.getPolicy({ + policyId: sdk.PolicyId.PasswordDictionary +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/list-email-templates.md b/examples/1.9.x/server-nodejs/examples/project/list-email-templates.md new file mode 100644 index 000000000..34bc7778b --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/list-email-templates.md @@ -0,0 +1,15 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.listEmailTemplates({ + queries: [], // optional + total: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/list-mock-phones.md b/examples/1.9.x/server-nodejs/examples/project/list-mock-phones.md new file mode 100644 index 000000000..0816b18aa --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/list-mock-phones.md @@ -0,0 +1,15 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.listMockPhones({ + queries: [], // optional + total: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-nodejs/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..6a0ef643c --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,12 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.listOAuth2Providers(); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/list-policies.md b/examples/1.9.x/server-nodejs/examples/project/list-policies.md new file mode 100644 index 000000000..f7b6260f0 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/list-policies.md @@ -0,0 +1,15 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.listPolicies({ + queries: [], // optional + total: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-auth-method.md b/examples/1.9.x/server-nodejs/examples/project/update-auth-method.md new file mode 100644 index 000000000..d6b2c6ca1 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-auth-method.md @@ -0,0 +1,15 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateAuthMethod({ + methodId: sdk.MethodId.EmailPassword, + enabled: false +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-key.md b/examples/1.9.x/server-nodejs/examples/project/update-key.md index ad191f881..488fae13e 100644 --- a/examples/1.9.x/server-nodejs/examples/project/update-key.md +++ b/examples/1.9.x/server-nodejs/examples/project/update-key.md @@ -11,7 +11,7 @@ const project = new sdk.Project(client); const result = await project.updateKey({ keyId: '', name: '', - scopes: [sdk.Scopes.SessionsWrite], + scopes: [sdk.Scopes.ProjectRead], expire: '2020-10-15T06:38:00.000+00:00' // optional }); ``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-mock-phone.md b/examples/1.9.x/server-nodejs/examples/project/update-mock-phone.md new file mode 100644 index 000000000..a0c70abc1 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-mock-phone.md @@ -0,0 +1,15 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateMockPhone({ + number: '+12065550100', + otp: '' +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..12a535fff --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Amazon({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..ae985a4ad --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,18 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Apple({ + serviceId: '', // optional + keyId: '', // optional + teamId: '', // optional + p8File: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..37bf4a56f --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,17 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Auth0({ + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..e500466bb --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,17 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Authentik({ + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..0b8aabce3 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Autodesk({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..d3b5dc7b7 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Bitbucket({ + key: '', // optional + secret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..feecad272 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Bitly({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..c97246387 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-box.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Box({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..8d1763394 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Dailymotion({ + apiKey: '', // optional + apiSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..5469509f7 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Discord({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..c71bebfe0 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Disqus({ + publicKey: '', // optional + secretKey: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..9f2654dc6 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Dropbox({ + appKey: '', // optional + appSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..684c4243e --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Etsy({ + keyString: '', // optional + sharedSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..7fca48a62 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Facebook({ + appId: '', // optional + appSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..3b8057382 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Figma({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..654991c92 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,17 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2FusionAuth({ + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..cc2be084e --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2GitHub({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..40e1943ed --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,17 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Gitlab({ + applicationId: '', // optional + secret: '', // optional + endpoint: 'https://example.com', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..dce02e9c2 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-google.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Google({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..bce76ee5c --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,18 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Keycloak({ + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + realmName: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..1d5810522 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Kick({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..02c68d99b --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Linkedin({ + clientId: '', // optional + primaryClientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..cc5a8c272 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,17 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Microsoft({ + applicationId: '', // optional + applicationSecret: '', // optional + tenant: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..c32977994 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Notion({ + oauthClientId: '', // optional + oauthClientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..478faf4b4 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,20 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Oidc({ + clientId: '', // optional + clientSecret: '', // optional + wellKnownURL: 'https://example.com', // optional + authorizationURL: 'https://example.com', // optional + tokenUrl: 'https://example.com', // optional + userInfoUrl: 'https://example.com', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..a85c98093 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,18 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Okta({ + clientId: '', // optional + clientSecret: '', // optional + domain: '', // optional + authorizationServerId: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..e6b8de7fa --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2PaypalSandbox({ + clientId: '', // optional + secretKey: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..8f7162c74 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Paypal({ + clientId: '', // optional + secretKey: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..3d6c2c448 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Podio({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..a19376391 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Salesforce({ + customerKey: '', // optional + customerSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..6dab9092c --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Slack({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..72ffa64d9 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Spotify({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..1df015f1e --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Stripe({ + clientId: '', // optional + apiSecretKey: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..df090e922 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2TradeshiftSandbox({ + oauth2ClientId: '', // optional + oauth2ClientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..afddd8c04 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Tradeshift({ + oauth2ClientId: '', // optional + oauth2ClientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..ad096ea9e --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Twitch({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..597ccd5bc --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2WordPress({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..79b3b021a --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Yahoo({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..2f79c4484 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Yandex({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..031a28168 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Zoho({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..985400b10 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2Zoom({ + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..183e22570 --- /dev/null +++ b/examples/1.9.x/server-nodejs/examples/project/update-o-auth-2x.md @@ -0,0 +1,16 @@ +```javascript +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +const project = new sdk.Project(client); + +const result = await project.updateOAuth2X({ + customerKey: '', // optional + secretKey: '', // optional + enabled: false // optional +}); +``` diff --git a/examples/1.9.x/server-php/examples/functions/create.md b/examples/1.9.x/server-php/examples/functions/create.md index 958a4aa10..8f387dcba 100644 --- a/examples/1.9.x/server-php/examples/functions/create.md +++ b/examples/1.9.x/server-php/examples/functions/create.md @@ -25,7 +25,7 @@ $result = $functions->create( logging: false, // optional entrypoint: '', // optional commands: '', // optional - scopes: [Scopes::SESSIONSWRITE()], // optional + scopes: [Scopes::PROJECTREAD()], // optional installationId: '', // optional providerRepositoryId: '', // optional providerBranch: '', // optional diff --git a/examples/1.9.x/server-php/examples/functions/update.md b/examples/1.9.x/server-php/examples/functions/update.md index 56e66b57f..564428c93 100644 --- a/examples/1.9.x/server-php/examples/functions/update.md +++ b/examples/1.9.x/server-php/examples/functions/update.md @@ -25,7 +25,7 @@ $result = $functions->update( logging: false, // optional entrypoint: '', // optional commands: '', // optional - scopes: [Scopes::SESSIONSWRITE()], // optional + scopes: [Scopes::PROJECTREAD()], // optional installationId: '', // optional providerRepositoryId: '', // optional providerBranch: '', // optional diff --git a/examples/1.9.x/server-php/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-php/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..6541bab84 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/create-ephemeral-key.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->createEphemeralKey( + scopes: [Scopes::PROJECTREAD()], + duration: 1 +);``` diff --git a/examples/1.9.x/server-php/examples/project/create-key.md b/examples/1.9.x/server-php/examples/project/create-key.md index cd8020b03..9157fcef7 100644 --- a/examples/1.9.x/server-php/examples/project/create-key.md +++ b/examples/1.9.x/server-php/examples/project/create-key.md @@ -15,6 +15,6 @@ $project = new Project($client); $result = $project->createKey( keyId: '', name: '', - scopes: [Scopes::SESSIONSWRITE()], + scopes: [Scopes::PROJECTREAD()], expire: '2020-10-15T06:38:00.000+00:00' // optional );``` diff --git a/examples/1.9.x/server-php/examples/project/create-mock-phone.md b/examples/1.9.x/server-php/examples/project/create-mock-phone.md new file mode 100644 index 000000000..6d73a0b4a --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/create-mock-phone.md @@ -0,0 +1,17 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->createMockPhone( + number: '+12065550100', + otp: '' +);``` diff --git a/examples/1.9.x/server-php/examples/project/delete-mock-phone.md b/examples/1.9.x/server-php/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..6cdfcc1cc --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/delete-mock-phone.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->deleteMockPhone( + number: '+12065550100' +);``` diff --git a/examples/1.9.x/server-php/examples/project/delete.md b/examples/1.9.x/server-php/examples/project/delete.md new file mode 100644 index 000000000..adb632418 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/delete.md @@ -0,0 +1,15 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->delete(); +``` diff --git a/examples/1.9.x/server-php/examples/project/get-mock-phone.md b/examples/1.9.x/server-php/examples/project/get-mock-phone.md new file mode 100644 index 000000000..512d64c48 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/get-mock-phone.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->getMockPhone( + number: '+12065550100' +);``` diff --git a/examples/1.9.x/server-php/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-php/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..c422f8250 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->getOAuth2Provider( + provider: '' +);``` diff --git a/examples/1.9.x/server-php/examples/project/get-policy.md b/examples/1.9.x/server-php/examples/project/get-policy.md new file mode 100644 index 000000000..4698932a1 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/get-policy.md @@ -0,0 +1,17 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->getPolicy( + policyId: PolicyId::PASSWORDDICTIONARY() +);``` diff --git a/examples/1.9.x/server-php/examples/project/list-email-templates.md b/examples/1.9.x/server-php/examples/project/list-email-templates.md new file mode 100644 index 000000000..47c65c4d4 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/list-email-templates.md @@ -0,0 +1,17 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->listEmailTemplates( + queries: [], // optional + total: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/list-mock-phones.md b/examples/1.9.x/server-php/examples/project/list-mock-phones.md new file mode 100644 index 000000000..5ca11c281 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/list-mock-phones.md @@ -0,0 +1,17 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->listMockPhones( + queries: [], // optional + total: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-php/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..50de91dfc --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,15 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->listOAuth2Providers(); +``` diff --git a/examples/1.9.x/server-php/examples/project/list-policies.md b/examples/1.9.x/server-php/examples/project/list-policies.md new file mode 100644 index 000000000..59d49f3ee --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/list-policies.md @@ -0,0 +1,17 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->listPolicies( + queries: [], // optional + total: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-auth-method.md b/examples/1.9.x/server-php/examples/project/update-auth-method.md new file mode 100644 index 000000000..a63711ed6 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-auth-method.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateAuthMethod( + methodId: MethodId::EMAILPASSWORD(), + enabled: false +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-key.md b/examples/1.9.x/server-php/examples/project/update-key.md index 589f018a6..1d1e6fd62 100644 --- a/examples/1.9.x/server-php/examples/project/update-key.md +++ b/examples/1.9.x/server-php/examples/project/update-key.md @@ -15,6 +15,6 @@ $project = new Project($client); $result = $project->updateKey( keyId: '', name: '', - scopes: [Scopes::SESSIONSWRITE()], + scopes: [Scopes::PROJECTREAD()], expire: '2020-10-15T06:38:00.000+00:00' // optional );``` diff --git a/examples/1.9.x/server-php/examples/project/update-mock-phone.md b/examples/1.9.x/server-php/examples/project/update-mock-phone.md new file mode 100644 index 000000000..f157343f0 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-mock-phone.md @@ -0,0 +1,17 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateMockPhone( + number: '+12065550100', + otp: '' +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..8a473860f --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Amazon( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..3f4516c30 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,20 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Apple( + serviceId: '', // optional + keyId: '', // optional + teamId: '', // optional + p8File: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..d9f17f78d --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,19 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Auth0( + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..b5c7e27e7 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,19 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Authentik( + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..e85b9bb92 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Autodesk( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..4985215c5 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Bitbucket( + key: '', // optional + secret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..b8c00ecdd --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Bitly( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..ba88f5613 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-box.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Box( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..44634caad --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Dailymotion( + apiKey: '', // optional + apiSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..d323c92d6 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Discord( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..302818624 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Disqus( + publicKey: '', // optional + secretKey: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..59575cdc8 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Dropbox( + appKey: '', // optional + appSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..19aab9617 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Etsy( + keyString: '', // optional + sharedSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..8f76d065b --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Facebook( + appId: '', // optional + appSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..71d36ebfa --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Figma( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..0b3709b22 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,19 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2FusionAuth( + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..62871aa6a --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2GitHub( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..2532af0c7 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,19 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Gitlab( + applicationId: '', // optional + secret: '', // optional + endpoint: 'https://example.com', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..06fc6b628 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-google.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Google( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..3604e4b61 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,20 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Keycloak( + clientId: '', // optional + clientSecret: '', // optional + endpoint: '', // optional + realmName: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..02c876fcd --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Kick( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..06451e149 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Linkedin( + clientId: '', // optional + primaryClientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..f5a0af73d --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,19 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Microsoft( + applicationId: '', // optional + applicationSecret: '', // optional + tenant: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..abf0b430d --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Notion( + oauthClientId: '', // optional + oauthClientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..0543b3550 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,22 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Oidc( + clientId: '', // optional + clientSecret: '', // optional + wellKnownURL: 'https://example.com', // optional + authorizationURL: 'https://example.com', // optional + tokenUrl: 'https://example.com', // optional + userInfoUrl: 'https://example.com', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..4de41d226 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,20 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Okta( + clientId: '', // optional + clientSecret: '', // optional + domain: '', // optional + authorizationServerId: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..5cb43b6d5 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2PaypalSandbox( + clientId: '', // optional + secretKey: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..51e8935f3 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Paypal( + clientId: '', // optional + secretKey: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..1c6076607 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Podio( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..8e0ab0444 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Salesforce( + customerKey: '', // optional + customerSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..858113c88 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Slack( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..44f22c334 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Spotify( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..9b2276c68 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Stripe( + clientId: '', // optional + apiSecretKey: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..247777041 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2TradeshiftSandbox( + oauth2ClientId: '', // optional + oauth2ClientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..72177e623 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Tradeshift( + oauth2ClientId: '', // optional + oauth2ClientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..a3cf258dc --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Twitch( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..3380007c1 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2WordPress( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..588c9926f --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Yahoo( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..c1e5b24d8 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Yandex( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..08a9b1e18 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Zoho( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..e30af5ba3 --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2Zoom( + clientId: '', // optional + clientSecret: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-php/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-php/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..86ee07f1c --- /dev/null +++ b/examples/1.9.x/server-php/examples/project/update-o-auth-2x.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$project = new Project($client); + +$result = $project->updateOAuth2X( + customerKey: '', // optional + secretKey: '', // optional + enabled: false // optional +);``` diff --git a/examples/1.9.x/server-python/examples/functions/create.md b/examples/1.9.x/server-python/examples/functions/create.md index 235df7050..fdded0ed8 100644 --- a/examples/1.9.x/server-python/examples/functions/create.md +++ b/examples/1.9.x/server-python/examples/functions/create.md @@ -24,7 +24,7 @@ result: Function = functions.create( logging = False, # optional entrypoint = '', # optional commands = '', # optional - scopes = [Scopes.SESSIONS_WRITE], # optional + scopes = [Scopes.PROJECT_READ], # optional installation_id = '', # optional provider_repository_id = '', # optional provider_branch = '', # optional diff --git a/examples/1.9.x/server-python/examples/functions/update.md b/examples/1.9.x/server-python/examples/functions/update.md index 181626c45..ab634e5e2 100644 --- a/examples/1.9.x/server-python/examples/functions/update.md +++ b/examples/1.9.x/server-python/examples/functions/update.md @@ -24,7 +24,7 @@ result: Function = functions.update( logging = False, # optional entrypoint = '', # optional commands = '', # optional - scopes = [Scopes.SESSIONS_WRITE], # optional + scopes = [Scopes.PROJECT_READ], # optional installation_id = '', # optional provider_repository_id = '', # optional provider_branch = '', # optional diff --git a/examples/1.9.x/server-python/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-python/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..a9bba6d6c --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/create-ephemeral-key.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import EphemeralKey +from appwrite.enums import Scopes + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: EphemeralKey = project.create_ephemeral_key( + scopes = [Scopes.PROJECT_READ], + duration = 1 +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/create-key.md b/examples/1.9.x/server-python/examples/project/create-key.md index 17989e505..bca74d671 100644 --- a/examples/1.9.x/server-python/examples/project/create-key.md +++ b/examples/1.9.x/server-python/examples/project/create-key.md @@ -14,7 +14,7 @@ project = Project(client) result: Key = project.create_key( key_id = '', name = '', - scopes = [Scopes.SESSIONS_WRITE], + scopes = [Scopes.PROJECT_READ], expire = '2020-10-15T06:38:00.000+00:00' # optional ) diff --git a/examples/1.9.x/server-python/examples/project/create-mock-phone.md b/examples/1.9.x/server-python/examples/project/create-mock-phone.md new file mode 100644 index 000000000..6ad457df8 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/create-mock-phone.md @@ -0,0 +1,19 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import MockNumber + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: MockNumber = project.create_mock_phone( + number = '+12065550100', + otp = '' +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/delete-mock-phone.md b/examples/1.9.x/server-python/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..5ce79db59 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/delete-mock-phone.md @@ -0,0 +1,15 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result = project.delete_mock_phone( + number = '+12065550100' +) +``` diff --git a/examples/1.9.x/server-python/examples/project/delete.md b/examples/1.9.x/server-python/examples/project/delete.md new file mode 100644 index 000000000..0c74d3116 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/delete.md @@ -0,0 +1,13 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result = project.delete() +``` diff --git a/examples/1.9.x/server-python/examples/project/get-mock-phone.md b/examples/1.9.x/server-python/examples/project/get-mock-phone.md new file mode 100644 index 000000000..e35dffdde --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/get-mock-phone.md @@ -0,0 +1,18 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import MockNumber + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: MockNumber = project.get_mock_phone( + number = '+12065550100' +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-python/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..98d284589 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,58 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Github +from appwrite.models import OAuth2Discord +from appwrite.models import OAuth2Figma +from appwrite.models import OAuth2Dropbox +from appwrite.models import OAuth2Dailymotion +from appwrite.models import OAuth2Bitbucket +from appwrite.models import OAuth2Bitly +from appwrite.models import OAuth2Box +from appwrite.models import OAuth2Autodesk +from appwrite.models import OAuth2Google +from appwrite.models import OAuth2Zoom +from appwrite.models import OAuth2Zoho +from appwrite.models import OAuth2Yandex +from appwrite.models import OAuth2X +from appwrite.models import OAuth2WordPress +from appwrite.models import OAuth2Twitch +from appwrite.models import OAuth2Stripe +from appwrite.models import OAuth2Spotify +from appwrite.models import OAuth2Slack +from appwrite.models import OAuth2Podio +from appwrite.models import OAuth2Notion +from appwrite.models import OAuth2Salesforce +from appwrite.models import OAuth2Yahoo +from appwrite.models import OAuth2Linkedin +from appwrite.models import OAuth2Disqus +from appwrite.models import OAuth2Amazon +from appwrite.models import OAuth2Etsy +from appwrite.models import OAuth2Facebook +from appwrite.models import OAuth2Tradeshift +from appwrite.models import OAuth2Paypal +from appwrite.models import OAuth2Gitlab +from appwrite.models import OAuth2Authentik +from appwrite.models import OAuth2Auth0 +from appwrite.models import OAuth2FusionAuth +from appwrite.models import OAuth2Keycloak +from appwrite.models import OAuth2Oidc +from appwrite.models import OAuth2Apple +from appwrite.models import OAuth2Okta +from appwrite.models import OAuth2Kick +from appwrite.models import OAuth2Microsoft +from typing import Union + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: Union[OAuth2Github, OAuth2Discord, OAuth2Figma, OAuth2Dropbox, OAuth2Dailymotion, OAuth2Bitbucket, OAuth2Bitly, OAuth2Box, OAuth2Autodesk, OAuth2Google, OAuth2Zoom, OAuth2Zoho, OAuth2Yandex, OAuth2X, OAuth2WordPress, OAuth2Twitch, OAuth2Stripe, OAuth2Spotify, OAuth2Slack, OAuth2Podio, OAuth2Notion, OAuth2Salesforce, OAuth2Yahoo, OAuth2Linkedin, OAuth2Disqus, OAuth2Amazon, OAuth2Etsy, OAuth2Facebook, OAuth2Tradeshift, OAuth2Paypal, OAuth2Gitlab, OAuth2Authentik, OAuth2Auth0, OAuth2FusionAuth, OAuth2Keycloak, OAuth2Oidc, OAuth2Apple, OAuth2Okta, OAuth2Kick, OAuth2Microsoft] = project.get_o_auth2_provider( + provider = '' +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/get-policy.md b/examples/1.9.x/server-python/examples/project/get-policy.md new file mode 100644 index 000000000..425724af8 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/get-policy.md @@ -0,0 +1,28 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import PolicyPasswordDictionary +from appwrite.models import PolicyPasswordHistory +from appwrite.models import PolicyPasswordPersonalData +from appwrite.models import PolicySessionAlert +from appwrite.models import PolicySessionDuration +from appwrite.models import PolicySessionInvalidation +from appwrite.models import PolicySessionLimit +from appwrite.models import PolicyUserLimit +from appwrite.models import PolicyMembershipPrivacy +from typing import Union +from appwrite.enums import PolicyId + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: Union[PolicyPasswordDictionary, PolicyPasswordHistory, PolicyPasswordPersonalData, PolicySessionAlert, PolicySessionDuration, PolicySessionInvalidation, PolicySessionLimit, PolicyUserLimit, PolicyMembershipPrivacy] = project.get_policy( + policy_id = PolicyId.PASSWORD_DICTIONARY +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/list-email-templates.md b/examples/1.9.x/server-python/examples/project/list-email-templates.md new file mode 100644 index 000000000..293bae738 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/list-email-templates.md @@ -0,0 +1,19 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import EmailTemplateList + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: EmailTemplateList = project.list_email_templates( + queries = [], # optional + total = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/list-mock-phones.md b/examples/1.9.x/server-python/examples/project/list-mock-phones.md new file mode 100644 index 000000000..6a73776b9 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/list-mock-phones.md @@ -0,0 +1,19 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import MockNumberList + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: MockNumberList = project.list_mock_phones( + queries = [], # optional + total = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-python/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..a7b16ae9b --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,16 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2ProviderList + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2ProviderList = project.list_o_auth2_providers() + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/list-policies.md b/examples/1.9.x/server-python/examples/project/list-policies.md new file mode 100644 index 000000000..e150a3f6c --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/list-policies.md @@ -0,0 +1,19 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import PolicyList + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: PolicyList = project.list_policies( + queries = [], # optional + total = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-auth-method.md b/examples/1.9.x/server-python/examples/project/update-auth-method.md new file mode 100644 index 000000000..535503c76 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-auth-method.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import Project as ProjectModel +from appwrite.enums import MethodId + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: ProjectModel = project.update_auth_method( + method_id = MethodId.EMAIL_PASSWORD, + enabled = False +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-key.md b/examples/1.9.x/server-python/examples/project/update-key.md index 3199fd443..88f6c0a94 100644 --- a/examples/1.9.x/server-python/examples/project/update-key.md +++ b/examples/1.9.x/server-python/examples/project/update-key.md @@ -14,7 +14,7 @@ project = Project(client) result: Key = project.update_key( key_id = '', name = '', - scopes = [Scopes.SESSIONS_WRITE], + scopes = [Scopes.PROJECT_READ], expire = '2020-10-15T06:38:00.000+00:00' # optional ) diff --git a/examples/1.9.x/server-python/examples/project/update-mock-phone.md b/examples/1.9.x/server-python/examples/project/update-mock-phone.md new file mode 100644 index 000000000..8a9a96c36 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-mock-phone.md @@ -0,0 +1,19 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import MockNumber + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: MockNumber = project.update_mock_phone( + number = '+12065550100', + otp = '' +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..61459693a --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Amazon + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Amazon = project.update_o_auth2_amazon( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..2619115ee --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,22 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Apple + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Apple = project.update_o_auth2_apple( + service_id = '', # optional + key_id = '', # optional + team_id = '', # optional + p8_file = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..568bb9bb4 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,21 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Auth0 + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Auth0 = project.update_o_auth2_auth0( + client_id = '', # optional + client_secret = '', # optional + endpoint = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..2fbc09900 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,21 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Authentik + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Authentik = project.update_o_auth2_authentik( + client_id = '', # optional + client_secret = '', # optional + endpoint = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..cff31e1ef --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Autodesk + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Autodesk = project.update_o_auth2_autodesk( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..a2099d1bd --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Bitbucket + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Bitbucket = project.update_o_auth2_bitbucket( + key = '', # optional + secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..1f026038e --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Bitly + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Bitly = project.update_o_auth2_bitly( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..363cd0609 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-box.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Box + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Box = project.update_o_auth2_box( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..53449cd1b --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Dailymotion + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Dailymotion = project.update_o_auth2_dailymotion( + api_key = '', # optional + api_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..a95cc4961 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Discord + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Discord = project.update_o_auth2_discord( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..f2af447f9 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Disqus + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Disqus = project.update_o_auth2_disqus( + public_key = '', # optional + secret_key = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..50e301197 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Dropbox + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Dropbox = project.update_o_auth2_dropbox( + app_key = '', # optional + app_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..4a0a20eaa --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Etsy + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Etsy = project.update_o_auth2_etsy( + key_string = '', # optional + shared_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..5b536dbbf --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Facebook + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Facebook = project.update_o_auth2_facebook( + app_id = '', # optional + app_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..eb2a2d252 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Figma + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Figma = project.update_o_auth2_figma( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..fb4d25dff --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,21 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2FusionAuth + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2FusionAuth = project.update_o_auth2_fusion_auth( + client_id = '', # optional + client_secret = '', # optional + endpoint = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..36664b851 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Github + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Github = project.update_o_auth2_git_hub( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..05905fdce --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,21 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Gitlab + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Gitlab = project.update_o_auth2_gitlab( + application_id = '', # optional + secret = '', # optional + endpoint = 'https://example.com', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..865e81f51 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-google.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Google + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Google = project.update_o_auth2_google( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..11a0defb5 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,22 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Keycloak + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Keycloak = project.update_o_auth2_keycloak( + client_id = '', # optional + client_secret = '', # optional + endpoint = '', # optional + realm_name = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..bc73e0637 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Kick + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Kick = project.update_o_auth2_kick( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..4b6eec3be --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Linkedin + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Linkedin = project.update_o_auth2_linkedin( + client_id = '', # optional + primary_client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..aeeefa9ec --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,21 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Microsoft + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Microsoft = project.update_o_auth2_microsoft( + application_id = '', # optional + application_secret = '', # optional + tenant = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..0ba765ea9 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Notion + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Notion = project.update_o_auth2_notion( + oauth_client_id = '', # optional + oauth_client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..3913262de --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,24 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Oidc + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Oidc = project.update_o_auth2_oidc( + client_id = '', # optional + client_secret = '', # optional + well_known_url = 'https://example.com', # optional + authorization_url = 'https://example.com', # optional + token_url = 'https://example.com', # optional + user_info_url = 'https://example.com', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..1bd2e96df --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,22 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Okta + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Okta = project.update_o_auth2_okta( + client_id = '', # optional + client_secret = '', # optional + domain = '', # optional + authorization_server_id = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..f31dc2855 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Paypal + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Paypal = project.update_o_auth2_paypal_sandbox( + client_id = '', # optional + secret_key = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..450e95925 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Paypal + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Paypal = project.update_o_auth2_paypal( + client_id = '', # optional + secret_key = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..992ecdcea --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Podio + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Podio = project.update_o_auth2_podio( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..a3cb63772 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Salesforce + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Salesforce = project.update_o_auth2_salesforce( + customer_key = '', # optional + customer_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..65cc30995 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Slack + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Slack = project.update_o_auth2_slack( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..257f45d04 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Spotify + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Spotify = project.update_o_auth2_spotify( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..7207a897e --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Stripe + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Stripe = project.update_o_auth2_stripe( + client_id = '', # optional + api_secret_key = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..2aaf7e642 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Tradeshift + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Tradeshift = project.update_o_auth2_tradeshift_sandbox( + oauth2_client_id = '', # optional + oauth2_client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..6ed5baccd --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Tradeshift + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Tradeshift = project.update_o_auth2_tradeshift( + oauth2_client_id = '', # optional + oauth2_client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..7c4027897 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Twitch + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Twitch = project.update_o_auth2_twitch( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..c7b406b95 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2WordPress + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2WordPress = project.update_o_auth2_word_press( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..6ea825b57 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Yahoo + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Yahoo = project.update_o_auth2_yahoo( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..c8604ede3 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Yandex + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Yandex = project.update_o_auth2_yandex( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..069a9645b --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Zoho + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Zoho = project.update_o_auth2_zoho( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..e779a0c09 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2Zoom + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2Zoom = project.update_o_auth2_zoom( + client_id = '', # optional + client_secret = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-python/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-python/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..5637fd6a7 --- /dev/null +++ b/examples/1.9.x/server-python/examples/project/update-o-auth-2x.md @@ -0,0 +1,20 @@ +```python +from appwrite.client import Client +from appwrite.services.project import Project +from appwrite.models import OAuth2X + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('') # Your project ID +client.set_key('') # Your secret API key + +project = Project(client) + +result: OAuth2X = project.update_o_auth2_x( + customer_key = '', # optional + secret_key = '', # optional + enabled = False # optional +) + +print(result.model_dump()) +``` diff --git a/examples/1.9.x/server-rest/examples/account/create-anonymous-session.md b/examples/1.9.x/server-rest/examples/account/create-anonymous-session.md index abb31c52b..633d10862 100644 --- a/examples/1.9.x/server-rest/examples/account/create-anonymous-session.md +++ b/examples/1.9.x/server-rest/examples/account/create-anonymous-session.md @@ -2,7 +2,7 @@ POST /v1/account/sessions/anonymous HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-email-password-session.md b/examples/1.9.x/server-rest/examples/account/create-email-password-session.md index fc3b785b1..0b93f1722 100644 --- a/examples/1.9.x/server-rest/examples/account/create-email-password-session.md +++ b/examples/1.9.x/server-rest/examples/account/create-email-password-session.md @@ -2,7 +2,7 @@ POST /v1/account/sessions/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-email-token.md b/examples/1.9.x/server-rest/examples/account/create-email-token.md index 9d5487edf..67deaa2a2 100644 --- a/examples/1.9.x/server-rest/examples/account/create-email-token.md +++ b/examples/1.9.x/server-rest/examples/account/create-email-token.md @@ -2,7 +2,7 @@ POST /v1/account/tokens/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-email-verification.md b/examples/1.9.x/server-rest/examples/account/create-email-verification.md index 278e27d4b..aedb22614 100644 --- a/examples/1.9.x/server-rest/examples/account/create-email-verification.md +++ b/examples/1.9.x/server-rest/examples/account/create-email-verification.md @@ -2,7 +2,7 @@ POST /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-jwt.md b/examples/1.9.x/server-rest/examples/account/create-jwt.md index 2f338bd42..5c95f61cf 100644 --- a/examples/1.9.x/server-rest/examples/account/create-jwt.md +++ b/examples/1.9.x/server-rest/examples/account/create-jwt.md @@ -2,7 +2,7 @@ POST /v1/account/jwts HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-magic-url-token.md b/examples/1.9.x/server-rest/examples/account/create-magic-url-token.md index 4a2fb939d..6e14589fe 100644 --- a/examples/1.9.x/server-rest/examples/account/create-magic-url-token.md +++ b/examples/1.9.x/server-rest/examples/account/create-magic-url-token.md @@ -2,7 +2,7 @@ POST /v1/account/tokens/magic-url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-mfa-authenticator.md b/examples/1.9.x/server-rest/examples/account/create-mfa-authenticator.md index 74dc6618b..c7d937009 100644 --- a/examples/1.9.x/server-rest/examples/account/create-mfa-authenticator.md +++ b/examples/1.9.x/server-rest/examples/account/create-mfa-authenticator.md @@ -2,7 +2,7 @@ POST /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-mfa-challenge.md b/examples/1.9.x/server-rest/examples/account/create-mfa-challenge.md index d4d65e323..a1bc7eeb6 100644 --- a/examples/1.9.x/server-rest/examples/account/create-mfa-challenge.md +++ b/examples/1.9.x/server-rest/examples/account/create-mfa-challenge.md @@ -2,7 +2,7 @@ POST /v1/account/mfa/challenges HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/account/create-mfa-recovery-codes.md index 9a2e0b422..34a9cc030 100644 --- a/examples/1.9.x/server-rest/examples/account/create-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/account/create-mfa-recovery-codes.md @@ -2,7 +2,7 @@ POST /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-o-auth-2-token.md b/examples/1.9.x/server-rest/examples/account/create-o-auth-2-token.md index 257373c0b..baa48cd3c 100644 --- a/examples/1.9.x/server-rest/examples/account/create-o-auth-2-token.md +++ b/examples/1.9.x/server-rest/examples/account/create-o-auth-2-token.md @@ -1,7 +1,7 @@ ```http GET /v1/account/tokens/oauth2/{provider} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-phone-token.md b/examples/1.9.x/server-rest/examples/account/create-phone-token.md index be258f568..4392617e9 100644 --- a/examples/1.9.x/server-rest/examples/account/create-phone-token.md +++ b/examples/1.9.x/server-rest/examples/account/create-phone-token.md @@ -2,7 +2,7 @@ POST /v1/account/tokens/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-phone-verification.md b/examples/1.9.x/server-rest/examples/account/create-phone-verification.md index 8c909ba24..2543da46e 100644 --- a/examples/1.9.x/server-rest/examples/account/create-phone-verification.md +++ b/examples/1.9.x/server-rest/examples/account/create-phone-verification.md @@ -2,7 +2,7 @@ POST /v1/account/verifications/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-recovery.md b/examples/1.9.x/server-rest/examples/account/create-recovery.md index 9c6e1500e..7db763019 100644 --- a/examples/1.9.x/server-rest/examples/account/create-recovery.md +++ b/examples/1.9.x/server-rest/examples/account/create-recovery.md @@ -2,7 +2,7 @@ POST /v1/account/recovery HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-session.md b/examples/1.9.x/server-rest/examples/account/create-session.md index 0dd0eb2ca..7380aab0a 100644 --- a/examples/1.9.x/server-rest/examples/account/create-session.md +++ b/examples/1.9.x/server-rest/examples/account/create-session.md @@ -2,7 +2,7 @@ POST /v1/account/sessions/token HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create-verification.md b/examples/1.9.x/server-rest/examples/account/create-verification.md index 278e27d4b..aedb22614 100644 --- a/examples/1.9.x/server-rest/examples/account/create-verification.md +++ b/examples/1.9.x/server-rest/examples/account/create-verification.md @@ -2,7 +2,7 @@ POST /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/create.md b/examples/1.9.x/server-rest/examples/account/create.md index db3430111..5c216e5ad 100644 --- a/examples/1.9.x/server-rest/examples/account/create.md +++ b/examples/1.9.x/server-rest/examples/account/create.md @@ -2,7 +2,7 @@ POST /v1/account HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/delete-identity.md b/examples/1.9.x/server-rest/examples/account/delete-identity.md index f740ba15a..6d5f59c13 100644 --- a/examples/1.9.x/server-rest/examples/account/delete-identity.md +++ b/examples/1.9.x/server-rest/examples/account/delete-identity.md @@ -2,7 +2,7 @@ DELETE /v1/account/identities/{identityId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/delete-mfa-authenticator.md b/examples/1.9.x/server-rest/examples/account/delete-mfa-authenticator.md index 144e1ed8a..8401f4b45 100644 --- a/examples/1.9.x/server-rest/examples/account/delete-mfa-authenticator.md +++ b/examples/1.9.x/server-rest/examples/account/delete-mfa-authenticator.md @@ -2,7 +2,7 @@ DELETE /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/delete-session.md b/examples/1.9.x/server-rest/examples/account/delete-session.md index 0d1b5685a..0f74214d1 100644 --- a/examples/1.9.x/server-rest/examples/account/delete-session.md +++ b/examples/1.9.x/server-rest/examples/account/delete-session.md @@ -2,7 +2,7 @@ DELETE /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/delete-sessions.md b/examples/1.9.x/server-rest/examples/account/delete-sessions.md index d9f45ae82..821f826b7 100644 --- a/examples/1.9.x/server-rest/examples/account/delete-sessions.md +++ b/examples/1.9.x/server-rest/examples/account/delete-sessions.md @@ -2,7 +2,7 @@ DELETE /v1/account/sessions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/get-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/account/get-mfa-recovery-codes.md index 69ce0a460..2c69f412c 100644 --- a/examples/1.9.x/server-rest/examples/account/get-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/account/get-mfa-recovery-codes.md @@ -1,7 +1,7 @@ ```http GET /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/get-prefs.md b/examples/1.9.x/server-rest/examples/account/get-prefs.md index 4a69ac91f..53ece5f7a 100644 --- a/examples/1.9.x/server-rest/examples/account/get-prefs.md +++ b/examples/1.9.x/server-rest/examples/account/get-prefs.md @@ -1,7 +1,7 @@ ```http GET /v1/account/prefs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/get-session.md b/examples/1.9.x/server-rest/examples/account/get-session.md index 662afe426..f35e063b0 100644 --- a/examples/1.9.x/server-rest/examples/account/get-session.md +++ b/examples/1.9.x/server-rest/examples/account/get-session.md @@ -1,7 +1,7 @@ ```http GET /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/get.md b/examples/1.9.x/server-rest/examples/account/get.md index 6a5d65f9f..310803497 100644 --- a/examples/1.9.x/server-rest/examples/account/get.md +++ b/examples/1.9.x/server-rest/examples/account/get.md @@ -1,7 +1,7 @@ ```http GET /v1/account HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/list-identities.md b/examples/1.9.x/server-rest/examples/account/list-identities.md index f9ca73bd6..fbe54ee18 100644 --- a/examples/1.9.x/server-rest/examples/account/list-identities.md +++ b/examples/1.9.x/server-rest/examples/account/list-identities.md @@ -1,7 +1,7 @@ ```http GET /v1/account/identities HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/list-logs.md b/examples/1.9.x/server-rest/examples/account/list-logs.md index 8298a0441..1ed8b116c 100644 --- a/examples/1.9.x/server-rest/examples/account/list-logs.md +++ b/examples/1.9.x/server-rest/examples/account/list-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/account/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/list-mfa-factors.md b/examples/1.9.x/server-rest/examples/account/list-mfa-factors.md index d84aeeba7..f2f5fbbcd 100644 --- a/examples/1.9.x/server-rest/examples/account/list-mfa-factors.md +++ b/examples/1.9.x/server-rest/examples/account/list-mfa-factors.md @@ -1,7 +1,7 @@ ```http GET /v1/account/mfa/factors HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/list-sessions.md b/examples/1.9.x/server-rest/examples/account/list-sessions.md index 4016f0881..b1da2d3f1 100644 --- a/examples/1.9.x/server-rest/examples/account/list-sessions.md +++ b/examples/1.9.x/server-rest/examples/account/list-sessions.md @@ -1,7 +1,7 @@ ```http GET /v1/account/sessions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-email-verification.md b/examples/1.9.x/server-rest/examples/account/update-email-verification.md index 6808a712c..514b3db2a 100644 --- a/examples/1.9.x/server-rest/examples/account/update-email-verification.md +++ b/examples/1.9.x/server-rest/examples/account/update-email-verification.md @@ -2,7 +2,7 @@ PUT /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-email.md b/examples/1.9.x/server-rest/examples/account/update-email.md index bbef632ad..310dc18cf 100644 --- a/examples/1.9.x/server-rest/examples/account/update-email.md +++ b/examples/1.9.x/server-rest/examples/account/update-email.md @@ -2,7 +2,7 @@ PATCH /v1/account/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-magic-url-session.md b/examples/1.9.x/server-rest/examples/account/update-magic-url-session.md index c56ab9cbb..1d2663167 100644 --- a/examples/1.9.x/server-rest/examples/account/update-magic-url-session.md +++ b/examples/1.9.x/server-rest/examples/account/update-magic-url-session.md @@ -2,7 +2,7 @@ PUT /v1/account/sessions/magic-url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-mfa-authenticator.md b/examples/1.9.x/server-rest/examples/account/update-mfa-authenticator.md index 92df4df4b..193935c69 100644 --- a/examples/1.9.x/server-rest/examples/account/update-mfa-authenticator.md +++ b/examples/1.9.x/server-rest/examples/account/update-mfa-authenticator.md @@ -2,7 +2,7 @@ PUT /v1/account/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-mfa-challenge.md b/examples/1.9.x/server-rest/examples/account/update-mfa-challenge.md index 02f8ecac6..0a226266b 100644 --- a/examples/1.9.x/server-rest/examples/account/update-mfa-challenge.md +++ b/examples/1.9.x/server-rest/examples/account/update-mfa-challenge.md @@ -2,7 +2,7 @@ PUT /v1/account/mfa/challenges HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/account/update-mfa-recovery-codes.md index fe197ec6b..b96489da1 100644 --- a/examples/1.9.x/server-rest/examples/account/update-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/account/update-mfa-recovery-codes.md @@ -2,7 +2,7 @@ PATCH /v1/account/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-mfa.md b/examples/1.9.x/server-rest/examples/account/update-mfa.md index 6c7d2f325..4518a3e1d 100644 --- a/examples/1.9.x/server-rest/examples/account/update-mfa.md +++ b/examples/1.9.x/server-rest/examples/account/update-mfa.md @@ -2,7 +2,7 @@ PATCH /v1/account/mfa HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-name.md b/examples/1.9.x/server-rest/examples/account/update-name.md index b4877c831..2b92e524e 100644 --- a/examples/1.9.x/server-rest/examples/account/update-name.md +++ b/examples/1.9.x/server-rest/examples/account/update-name.md @@ -2,7 +2,7 @@ PATCH /v1/account/name HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-password.md b/examples/1.9.x/server-rest/examples/account/update-password.md index f36bc1128..ed3a1a678 100644 --- a/examples/1.9.x/server-rest/examples/account/update-password.md +++ b/examples/1.9.x/server-rest/examples/account/update-password.md @@ -2,7 +2,7 @@ PATCH /v1/account/password HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-phone-session.md b/examples/1.9.x/server-rest/examples/account/update-phone-session.md index 3b212d099..2e33ddd98 100644 --- a/examples/1.9.x/server-rest/examples/account/update-phone-session.md +++ b/examples/1.9.x/server-rest/examples/account/update-phone-session.md @@ -2,7 +2,7 @@ PUT /v1/account/sessions/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-phone-verification.md b/examples/1.9.x/server-rest/examples/account/update-phone-verification.md index d2de6a841..a9bcf32c7 100644 --- a/examples/1.9.x/server-rest/examples/account/update-phone-verification.md +++ b/examples/1.9.x/server-rest/examples/account/update-phone-verification.md @@ -2,7 +2,7 @@ PUT /v1/account/verifications/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-phone.md b/examples/1.9.x/server-rest/examples/account/update-phone.md index 11e14f6cf..1f3c62d09 100644 --- a/examples/1.9.x/server-rest/examples/account/update-phone.md +++ b/examples/1.9.x/server-rest/examples/account/update-phone.md @@ -2,7 +2,7 @@ PATCH /v1/account/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-prefs.md b/examples/1.9.x/server-rest/examples/account/update-prefs.md index 45ed9d7f7..045158548 100644 --- a/examples/1.9.x/server-rest/examples/account/update-prefs.md +++ b/examples/1.9.x/server-rest/examples/account/update-prefs.md @@ -2,7 +2,7 @@ PATCH /v1/account/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-recovery.md b/examples/1.9.x/server-rest/examples/account/update-recovery.md index b3e531a1a..6dd79f223 100644 --- a/examples/1.9.x/server-rest/examples/account/update-recovery.md +++ b/examples/1.9.x/server-rest/examples/account/update-recovery.md @@ -2,7 +2,7 @@ PUT /v1/account/recovery HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-session.md b/examples/1.9.x/server-rest/examples/account/update-session.md index 506e3af86..2b956d23b 100644 --- a/examples/1.9.x/server-rest/examples/account/update-session.md +++ b/examples/1.9.x/server-rest/examples/account/update-session.md @@ -2,7 +2,7 @@ PATCH /v1/account/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-status.md b/examples/1.9.x/server-rest/examples/account/update-status.md index 57b8c77fd..1c3f02237 100644 --- a/examples/1.9.x/server-rest/examples/account/update-status.md +++ b/examples/1.9.x/server-rest/examples/account/update-status.md @@ -2,7 +2,7 @@ PATCH /v1/account/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/account/update-verification.md b/examples/1.9.x/server-rest/examples/account/update-verification.md index 6808a712c..514b3db2a 100644 --- a/examples/1.9.x/server-rest/examples/account/update-verification.md +++ b/examples/1.9.x/server-rest/examples/account/update-verification.md @@ -2,7 +2,7 @@ PUT /v1/account/verifications/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/activities/get-event.md b/examples/1.9.x/server-rest/examples/activities/get-event.md index 0bef15d45..caec3a8bc 100644 --- a/examples/1.9.x/server-rest/examples/activities/get-event.md +++ b/examples/1.9.x/server-rest/examples/activities/get-event.md @@ -1,7 +1,7 @@ ```http GET /v1/activities/events/{eventId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/activities/list-events.md b/examples/1.9.x/server-rest/examples/activities/list-events.md index e6f0193ef..728d5b2ae 100644 --- a/examples/1.9.x/server-rest/examples/activities/list-events.md +++ b/examples/1.9.x/server-rest/examples/activities/list-events.md @@ -1,7 +1,7 @@ ```http GET /v1/activities/events HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/avatars/get-browser.md b/examples/1.9.x/server-rest/examples/avatars/get-browser.md index f45267a57..f9924353b 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-browser.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-browser.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/browsers/{code} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/avatars/get-credit-card.md b/examples/1.9.x/server-rest/examples/avatars/get-credit-card.md index 589ec9560..57590d5eb 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-credit-card.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-credit-card.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/credit-cards/{code} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/avatars/get-favicon.md b/examples/1.9.x/server-rest/examples/avatars/get-favicon.md index eedb4cd06..974c70eca 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-favicon.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-favicon.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/favicon HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/avatars/get-flag.md b/examples/1.9.x/server-rest/examples/avatars/get-flag.md index f1c8ea0d4..ec5c4965f 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-flag.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-flag.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/flags/{code} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/avatars/get-image.md b/examples/1.9.x/server-rest/examples/avatars/get-image.md index 0de889d36..7d575b31e 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-image.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-image.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/image HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/avatars/get-initials.md b/examples/1.9.x/server-rest/examples/avatars/get-initials.md index c084f9b52..06bfa6d9f 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-initials.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-initials.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/initials HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/avatars/get-qr.md b/examples/1.9.x/server-rest/examples/avatars/get-qr.md index 42719058c..bd4d3845b 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-qr.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-qr.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/qr HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/avatars/get-screenshot.md b/examples/1.9.x/server-rest/examples/avatars/get-screenshot.md index 9181dd0fb..86648bc37 100644 --- a/examples/1.9.x/server-rest/examples/avatars/get-screenshot.md +++ b/examples/1.9.x/server-rest/examples/avatars/get-screenshot.md @@ -1,7 +1,7 @@ ```http GET /v1/avatars/screenshots HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/backups/create-archive.md b/examples/1.9.x/server-rest/examples/backups/create-archive.md index e157dad38..a4a49f011 100644 --- a/examples/1.9.x/server-rest/examples/backups/create-archive.md +++ b/examples/1.9.x/server-rest/examples/backups/create-archive.md @@ -2,7 +2,7 @@ POST /v1/backups/archives HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/backups/create-policy.md b/examples/1.9.x/server-rest/examples/backups/create-policy.md index e044699c4..5b3726746 100644 --- a/examples/1.9.x/server-rest/examples/backups/create-policy.md +++ b/examples/1.9.x/server-rest/examples/backups/create-policy.md @@ -2,7 +2,7 @@ POST /v1/backups/policies HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/backups/create-restoration.md b/examples/1.9.x/server-rest/examples/backups/create-restoration.md index 5eafba8bd..082ad1f0d 100644 --- a/examples/1.9.x/server-rest/examples/backups/create-restoration.md +++ b/examples/1.9.x/server-rest/examples/backups/create-restoration.md @@ -2,7 +2,7 @@ POST /v1/backups/restoration HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/backups/delete-archive.md b/examples/1.9.x/server-rest/examples/backups/delete-archive.md index 831a12e74..19840a2d0 100644 --- a/examples/1.9.x/server-rest/examples/backups/delete-archive.md +++ b/examples/1.9.x/server-rest/examples/backups/delete-archive.md @@ -2,7 +2,7 @@ DELETE /v1/backups/archives/{archiveId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/backups/delete-policy.md b/examples/1.9.x/server-rest/examples/backups/delete-policy.md index 951c6a4b5..9cb34e9ad 100644 --- a/examples/1.9.x/server-rest/examples/backups/delete-policy.md +++ b/examples/1.9.x/server-rest/examples/backups/delete-policy.md @@ -2,7 +2,7 @@ DELETE /v1/backups/policies/{policyId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/backups/get-archive.md b/examples/1.9.x/server-rest/examples/backups/get-archive.md index 565868988..71909b2f2 100644 --- a/examples/1.9.x/server-rest/examples/backups/get-archive.md +++ b/examples/1.9.x/server-rest/examples/backups/get-archive.md @@ -1,7 +1,7 @@ ```http GET /v1/backups/archives/{archiveId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/backups/get-policy.md b/examples/1.9.x/server-rest/examples/backups/get-policy.md index 0437cad1c..e0ce42da4 100644 --- a/examples/1.9.x/server-rest/examples/backups/get-policy.md +++ b/examples/1.9.x/server-rest/examples/backups/get-policy.md @@ -1,7 +1,7 @@ ```http GET /v1/backups/policies/{policyId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/backups/get-restoration.md b/examples/1.9.x/server-rest/examples/backups/get-restoration.md index 63ca46bef..c46f5cf2e 100644 --- a/examples/1.9.x/server-rest/examples/backups/get-restoration.md +++ b/examples/1.9.x/server-rest/examples/backups/get-restoration.md @@ -1,7 +1,7 @@ ```http GET /v1/backups/restorations/{restorationId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/backups/list-archives.md b/examples/1.9.x/server-rest/examples/backups/list-archives.md index 47136b36e..d03e4dc0c 100644 --- a/examples/1.9.x/server-rest/examples/backups/list-archives.md +++ b/examples/1.9.x/server-rest/examples/backups/list-archives.md @@ -1,7 +1,7 @@ ```http GET /v1/backups/archives HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/backups/list-policies.md b/examples/1.9.x/server-rest/examples/backups/list-policies.md index f796a5b27..5e06a23f2 100644 --- a/examples/1.9.x/server-rest/examples/backups/list-policies.md +++ b/examples/1.9.x/server-rest/examples/backups/list-policies.md @@ -1,7 +1,7 @@ ```http GET /v1/backups/policies HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/backups/list-restorations.md b/examples/1.9.x/server-rest/examples/backups/list-restorations.md index 44eb09d51..06a0bbdf2 100644 --- a/examples/1.9.x/server-rest/examples/backups/list-restorations.md +++ b/examples/1.9.x/server-rest/examples/backups/list-restorations.md @@ -1,7 +1,7 @@ ```http GET /v1/backups/restorations HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/backups/update-policy.md b/examples/1.9.x/server-rest/examples/backups/update-policy.md index 45dc25f1a..802d8c73d 100644 --- a/examples/1.9.x/server-rest/examples/backups/update-policy.md +++ b/examples/1.9.x/server-rest/examples/backups/update-policy.md @@ -2,7 +2,7 @@ PATCH /v1/backups/policies/{policyId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-boolean-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-boolean-attribute.md index cc25bf080..d75c83def 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-boolean-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-boolean-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-collection.md b/examples/1.9.x/server-rest/examples/databases/create-collection.md index 0cd538c95..4a7f1765f 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-collection.md +++ b/examples/1.9.x/server-rest/examples/databases/create-collection.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-datetime-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-datetime-attribute.md index 454130c46..378323e96 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-datetime-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-datetime-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-document.md b/examples/1.9.x/server-rest/examples/databases/create-document.md index e5879ff71..434b9ae43 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-document.md +++ b/examples/1.9.x/server-rest/examples/databases/create-document.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-documents.md b/examples/1.9.x/server-rest/examples/databases/create-documents.md index bb1b431de..318f74114 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/create-documents.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-email-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-email-attribute.md index 9e61ffea5..a88d8af20 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-email-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-email-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-enum-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-enum-attribute.md index 5e9455192..eed35a4c8 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-enum-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-enum-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-float-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-float-attribute.md index a17eca7fc..352c0e1d8 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-float-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-float-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/float HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-index.md b/examples/1.9.x/server-rest/examples/databases/create-index.md index ed3f425b2..4be61f997 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-index.md +++ b/examples/1.9.x/server-rest/examples/databases/create-index.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-integer-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-integer-attribute.md index aca144471..2bd46bd6b 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-integer-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-integer-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-ip-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-ip-attribute.md index 8aca8008a..7935a1f5a 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-ip-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-ip-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-line-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-line-attribute.md index 41ce7a36e..4b2a2c6c5 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-line-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-line-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/line HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-longtext-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-longtext-attribute.md index f76f39b63..402051b6e 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-longtext-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-longtext-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/longtext HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-mediumtext-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-mediumtext-attribute.md index 3c2bc16ea..31146211c 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-mediumtext-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-mediumtext-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-operations.md b/examples/1.9.x/server-rest/examples/databases/create-operations.md index 7ff26757a..88c3e6099 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-operations.md +++ b/examples/1.9.x/server-rest/examples/databases/create-operations.md @@ -2,7 +2,7 @@ POST /v1/databases/transactions/{transactionId}/operations HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/databases/create-point-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-point-attribute.md index 36e6b008f..cc5c62976 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-point-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-point-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/point HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-polygon-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-polygon-attribute.md index 9064be9e4..722d9f124 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-polygon-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-polygon-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/polygon HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-relationship-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-relationship-attribute.md index 3c91a64d3..b5a0ed744 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-relationship-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-relationship-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-string-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-string-attribute.md index 7dd1d89c9..d55289f5f 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-string-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-string-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/string HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-text-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-text-attribute.md index ae8b3fa9f..b2c11d6bb 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-text-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-text-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/text HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-transaction.md b/examples/1.9.x/server-rest/examples/databases/create-transaction.md index 1b8a3e7c4..6ffb8f72b 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-transaction.md +++ b/examples/1.9.x/server-rest/examples/databases/create-transaction.md @@ -2,7 +2,7 @@ POST /v1/databases/transactions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/databases/create-url-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-url-attribute.md index e6f6065e8..1702b5375 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-url-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-url-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create-varchar-attribute.md b/examples/1.9.x/server-rest/examples/databases/create-varchar-attribute.md index 3b9602b39..5fb21ee1c 100644 --- a/examples/1.9.x/server-rest/examples/databases/create-varchar-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/create-varchar-attribute.md @@ -2,7 +2,7 @@ POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/varchar HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/create.md b/examples/1.9.x/server-rest/examples/databases/create.md index e053a131b..132fdb0f2 100644 --- a/examples/1.9.x/server-rest/examples/databases/create.md +++ b/examples/1.9.x/server-rest/examples/databases/create.md @@ -2,7 +2,7 @@ POST /v1/databases HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/decrement-document-attribute.md b/examples/1.9.x/server-rest/examples/databases/decrement-document-attribute.md index 7b684f4f5..b29109b26 100644 --- a/examples/1.9.x/server-rest/examples/databases/decrement-document-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/decrement-document-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/databases/delete-attribute.md b/examples/1.9.x/server-rest/examples/databases/delete-attribute.md index ba2c89264..7834f8247 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-attribute.md @@ -2,7 +2,7 @@ DELETE /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/delete-collection.md b/examples/1.9.x/server-rest/examples/databases/delete-collection.md index 4a143cb3c..9bf613a76 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-collection.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-collection.md @@ -2,7 +2,7 @@ DELETE /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/delete-document.md b/examples/1.9.x/server-rest/examples/databases/delete-document.md index 1efe1de76..a2e8b0158 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-document.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-document.md @@ -2,7 +2,7 @@ DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/delete-documents.md b/examples/1.9.x/server-rest/examples/databases/delete-documents.md index 9a6dc141a..a8d2b2f3d 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-documents.md @@ -2,7 +2,7 @@ DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/delete-index.md b/examples/1.9.x/server-rest/examples/databases/delete-index.md index d1966c4e3..a6d59d929 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-index.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-index.md @@ -2,7 +2,7 @@ DELETE /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/delete-transaction.md b/examples/1.9.x/server-rest/examples/databases/delete-transaction.md index cead0ad12..141f8d31e 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-transaction.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-transaction.md @@ -2,7 +2,7 @@ DELETE /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/databases/delete.md b/examples/1.9.x/server-rest/examples/databases/delete.md index d7249083c..676dfb434 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete.md +++ b/examples/1.9.x/server-rest/examples/databases/delete.md @@ -2,7 +2,7 @@ DELETE /v1/databases/{databaseId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/get-attribute.md b/examples/1.9.x/server-rest/examples/databases/get-attribute.md index 900e7b978..a08a89252 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/get-attribute.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get-collection.md b/examples/1.9.x/server-rest/examples/databases/get-collection.md index efac8bad1..9b740be1b 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-collection.md +++ b/examples/1.9.x/server-rest/examples/databases/get-collection.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get-document.md b/examples/1.9.x/server-rest/examples/databases/get-document.md index 6a7083c7f..30bf46d27 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-document.md +++ b/examples/1.9.x/server-rest/examples/databases/get-document.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/get-index.md b/examples/1.9.x/server-rest/examples/databases/get-index.md index 53bfd27e6..9c93cbab9 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-index.md +++ b/examples/1.9.x/server-rest/examples/databases/get-index.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/databases/get-transaction.md b/examples/1.9.x/server-rest/examples/databases/get-transaction.md index 3287c5efd..2b6bf9644 100644 --- a/examples/1.9.x/server-rest/examples/databases/get-transaction.md +++ b/examples/1.9.x/server-rest/examples/databases/get-transaction.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/databases/get.md b/examples/1.9.x/server-rest/examples/databases/get.md index 4726d023a..42bfc9639 100644 --- a/examples/1.9.x/server-rest/examples/databases/get.md +++ b/examples/1.9.x/server-rest/examples/databases/get.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/databases/increment-document-attribute.md b/examples/1.9.x/server-rest/examples/databases/increment-document-attribute.md index ee43a0e79..32fc8d91c 100644 --- a/examples/1.9.x/server-rest/examples/databases/increment-document-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/increment-document-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/databases/list-attributes.md b/examples/1.9.x/server-rest/examples/databases/list-attributes.md index de7b35f37..0cc7014bc 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-attributes.md +++ b/examples/1.9.x/server-rest/examples/databases/list-attributes.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/attributes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/databases/list-collections.md b/examples/1.9.x/server-rest/examples/databases/list-collections.md index 15cfd310d..b3d7b856d 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-collections.md +++ b/examples/1.9.x/server-rest/examples/databases/list-collections.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/databases/list-documents.md b/examples/1.9.x/server-rest/examples/databases/list-documents.md index d41ee811a..45b8b833c 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/list-documents.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/list-indexes.md b/examples/1.9.x/server-rest/examples/databases/list-indexes.md index 6d1e3234a..8359162cf 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-indexes.md +++ b/examples/1.9.x/server-rest/examples/databases/list-indexes.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/databases/list-transactions.md b/examples/1.9.x/server-rest/examples/databases/list-transactions.md index e75f36828..b473b2bd9 100644 --- a/examples/1.9.x/server-rest/examples/databases/list-transactions.md +++ b/examples/1.9.x/server-rest/examples/databases/list-transactions.md @@ -1,7 +1,7 @@ ```http GET /v1/databases/transactions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/databases/list.md b/examples/1.9.x/server-rest/examples/databases/list.md index d77f02f20..5a78ec200 100644 --- a/examples/1.9.x/server-rest/examples/databases/list.md +++ b/examples/1.9.x/server-rest/examples/databases/list.md @@ -1,7 +1,7 @@ ```http GET /v1/databases HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/databases/update-boolean-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-boolean-attribute.md index e2e243522..3040b0a79 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-boolean-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-boolean-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-collection.md b/examples/1.9.x/server-rest/examples/databases/update-collection.md index cffa122e6..fe948f097 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-collection.md +++ b/examples/1.9.x/server-rest/examples/databases/update-collection.md @@ -2,7 +2,7 @@ PUT /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-datetime-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-datetime-attribute.md index cdb16dbb5..650da4a3e 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-datetime-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-datetime-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-document.md b/examples/1.9.x/server-rest/examples/databases/update-document.md index 0afdc6a85..cdd53ea6d 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-document.md +++ b/examples/1.9.x/server-rest/examples/databases/update-document.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-documents.md b/examples/1.9.x/server-rest/examples/databases/update-documents.md index 5f7d07fc3..b1d220476 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/update-documents.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-email-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-email-attribute.md index 397f9de61..d82e28118 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-email-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-email-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/email/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-enum-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-enum-attribute.md index e8da416b1..c20760b9d 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-enum-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-enum-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-float-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-float-attribute.md index d2a540cf1..b7706aaf7 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-float-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-float-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/float/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-integer-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-integer-attribute.md index 0ba1e67a0..acf832ebd 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-integer-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-integer-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-ip-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-ip-attribute.md index 91c91cfc2..a8cea3287 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-ip-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-ip-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-line-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-line-attribute.md index 3616322d9..60d0f3fcc 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-line-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-line-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/line/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-longtext-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-longtext-attribute.md index a1404b487..d48e9c25e 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-longtext-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-longtext-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/longtext/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-mediumtext-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-mediumtext-attribute.md index a21c70f6b..f19a460a3 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-mediumtext-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-mediumtext-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-point-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-point-attribute.md index 04cc49cb8..20941c74c 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-point-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-point-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/point/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-polygon-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-polygon-attribute.md index d33cbf874..11ea5564e 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-polygon-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-polygon-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/polygon/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-relationship-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-relationship-attribute.md index 2377571d3..5f2acd900 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-relationship-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-relationship-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-string-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-string-attribute.md index 4a0f9b438..2f1708b41 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-string-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-string-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/string/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-text-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-text-attribute.md index 43840ecfb..258e3aac9 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-text-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-text-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/text/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-transaction.md b/examples/1.9.x/server-rest/examples/databases/update-transaction.md index acecfaead..950f41658 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-transaction.md +++ b/examples/1.9.x/server-rest/examples/databases/update-transaction.md @@ -2,7 +2,7 @@ PATCH /v1/databases/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/databases/update-url-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-url-attribute.md index daf1c5c7d..22ef00316 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-url-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-url-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/url/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update-varchar-attribute.md b/examples/1.9.x/server-rest/examples/databases/update-varchar-attribute.md index 736856cb3..e094ebb61 100644 --- a/examples/1.9.x/server-rest/examples/databases/update-varchar-attribute.md +++ b/examples/1.9.x/server-rest/examples/databases/update-varchar-attribute.md @@ -2,7 +2,7 @@ PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/varchar/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/update.md b/examples/1.9.x/server-rest/examples/databases/update.md index db5b4b033..dfc9dc330 100644 --- a/examples/1.9.x/server-rest/examples/databases/update.md +++ b/examples/1.9.x/server-rest/examples/databases/update.md @@ -2,7 +2,7 @@ PUT /v1/databases/{databaseId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/upsert-document.md b/examples/1.9.x/server-rest/examples/databases/upsert-document.md index efa6a7825..f358d8eae 100644 --- a/examples/1.9.x/server-rest/examples/databases/upsert-document.md +++ b/examples/1.9.x/server-rest/examples/databases/upsert-document.md @@ -2,7 +2,7 @@ PUT /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/databases/upsert-documents.md b/examples/1.9.x/server-rest/examples/databases/upsert-documents.md index 22dc7897a..eaaa3d9e4 100644 --- a/examples/1.9.x/server-rest/examples/databases/upsert-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/upsert-documents.md @@ -2,7 +2,7 @@ PUT /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/create-deployment.md b/examples/1.9.x/server-rest/examples/functions/create-deployment.md index c0bed23c8..d2620e285 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/create-deployment.md @@ -2,7 +2,7 @@ POST /v1/functions/{functionId}/deployments HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: Content-Length: *Length of your entity body in bytes* diff --git a/examples/1.9.x/server-rest/examples/functions/create-duplicate-deployment.md b/examples/1.9.x/server-rest/examples/functions/create-duplicate-deployment.md index 703460d08..050dcd44d 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-duplicate-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/create-duplicate-deployment.md @@ -2,7 +2,7 @@ POST /v1/functions/{functionId}/deployments/duplicate HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/create-execution.md b/examples/1.9.x/server-rest/examples/functions/create-execution.md index 1e310ad17..7a21d3ec6 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-execution.md +++ b/examples/1.9.x/server-rest/examples/functions/create-execution.md @@ -2,7 +2,7 @@ POST /v1/functions/{functionId}/executions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/create-template-deployment.md b/examples/1.9.x/server-rest/examples/functions/create-template-deployment.md index 7bba9882a..dde5f1d92 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-template-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/create-template-deployment.md @@ -2,7 +2,7 @@ POST /v1/functions/{functionId}/deployments/template HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/create-variable.md b/examples/1.9.x/server-rest/examples/functions/create-variable.md index a522db8a8..9ec3879c5 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-variable.md +++ b/examples/1.9.x/server-rest/examples/functions/create-variable.md @@ -2,7 +2,7 @@ POST /v1/functions/{functionId}/variables HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/create-vcs-deployment.md b/examples/1.9.x/server-rest/examples/functions/create-vcs-deployment.md index c75e666f3..a46998ce7 100644 --- a/examples/1.9.x/server-rest/examples/functions/create-vcs-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/create-vcs-deployment.md @@ -2,7 +2,7 @@ POST /v1/functions/{functionId}/deployments/vcs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/create.md b/examples/1.9.x/server-rest/examples/functions/create.md index 85065bec5..b6355ca36 100644 --- a/examples/1.9.x/server-rest/examples/functions/create.md +++ b/examples/1.9.x/server-rest/examples/functions/create.md @@ -2,7 +2,7 @@ POST /v1/functions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/delete-deployment.md b/examples/1.9.x/server-rest/examples/functions/delete-deployment.md index b27edde05..ac91387d5 100644 --- a/examples/1.9.x/server-rest/examples/functions/delete-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/delete-deployment.md @@ -2,7 +2,7 @@ DELETE /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/delete-execution.md b/examples/1.9.x/server-rest/examples/functions/delete-execution.md index aee9b2e4c..f73bac1f5 100644 --- a/examples/1.9.x/server-rest/examples/functions/delete-execution.md +++ b/examples/1.9.x/server-rest/examples/functions/delete-execution.md @@ -2,7 +2,7 @@ DELETE /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/delete-variable.md b/examples/1.9.x/server-rest/examples/functions/delete-variable.md index 91d6ec357..befe73112 100644 --- a/examples/1.9.x/server-rest/examples/functions/delete-variable.md +++ b/examples/1.9.x/server-rest/examples/functions/delete-variable.md @@ -2,7 +2,7 @@ DELETE /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/delete.md b/examples/1.9.x/server-rest/examples/functions/delete.md index e23d7af1b..3ec5b362b 100644 --- a/examples/1.9.x/server-rest/examples/functions/delete.md +++ b/examples/1.9.x/server-rest/examples/functions/delete.md @@ -2,7 +2,7 @@ DELETE /v1/functions/{functionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/get-deployment-download.md b/examples/1.9.x/server-rest/examples/functions/get-deployment-download.md index ce2cf041f..0c53d579d 100644 --- a/examples/1.9.x/server-rest/examples/functions/get-deployment-download.md +++ b/examples/1.9.x/server-rest/examples/functions/get-deployment-download.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/deployments/{deploymentId}/download HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/functions/get-deployment.md b/examples/1.9.x/server-rest/examples/functions/get-deployment.md index 38de2bf9c..c2621e777 100644 --- a/examples/1.9.x/server-rest/examples/functions/get-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/get-deployment.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/functions/get-execution.md b/examples/1.9.x/server-rest/examples/functions/get-execution.md index 49a8fcac4..9518ac29a 100644 --- a/examples/1.9.x/server-rest/examples/functions/get-execution.md +++ b/examples/1.9.x/server-rest/examples/functions/get-execution.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/get-variable.md b/examples/1.9.x/server-rest/examples/functions/get-variable.md index ee94bc85a..4a313a1f3 100644 --- a/examples/1.9.x/server-rest/examples/functions/get-variable.md +++ b/examples/1.9.x/server-rest/examples/functions/get-variable.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/functions/get.md b/examples/1.9.x/server-rest/examples/functions/get.md index d252c4ad7..71120af76 100644 --- a/examples/1.9.x/server-rest/examples/functions/get.md +++ b/examples/1.9.x/server-rest/examples/functions/get.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-deployments.md b/examples/1.9.x/server-rest/examples/functions/list-deployments.md index fdbc1f05e..ba5b35892 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-deployments.md +++ b/examples/1.9.x/server-rest/examples/functions/list-deployments.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/deployments HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-executions.md b/examples/1.9.x/server-rest/examples/functions/list-executions.md index e74529a80..d75790ca8 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-executions.md +++ b/examples/1.9.x/server-rest/examples/functions/list-executions.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/executions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/list-runtimes.md b/examples/1.9.x/server-rest/examples/functions/list-runtimes.md index c2a9bf60e..e9ca8ff3e 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-runtimes.md +++ b/examples/1.9.x/server-rest/examples/functions/list-runtimes.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/runtimes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-specifications.md b/examples/1.9.x/server-rest/examples/functions/list-specifications.md index 638b8c8d3..b3de66164 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-specifications.md +++ b/examples/1.9.x/server-rest/examples/functions/list-specifications.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/specifications HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list-variables.md b/examples/1.9.x/server-rest/examples/functions/list-variables.md index 04cda650b..0a26292a8 100644 --- a/examples/1.9.x/server-rest/examples/functions/list-variables.md +++ b/examples/1.9.x/server-rest/examples/functions/list-variables.md @@ -1,7 +1,7 @@ ```http GET /v1/functions/{functionId}/variables HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/functions/list.md b/examples/1.9.x/server-rest/examples/functions/list.md index 3fe4ecffe..8ce5d7861 100644 --- a/examples/1.9.x/server-rest/examples/functions/list.md +++ b/examples/1.9.x/server-rest/examples/functions/list.md @@ -1,7 +1,7 @@ ```http GET /v1/functions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/functions/update-deployment-status.md b/examples/1.9.x/server-rest/examples/functions/update-deployment-status.md index e039d7dc0..f0513bb71 100644 --- a/examples/1.9.x/server-rest/examples/functions/update-deployment-status.md +++ b/examples/1.9.x/server-rest/examples/functions/update-deployment-status.md @@ -2,7 +2,7 @@ PATCH /v1/functions/{functionId}/deployments/{deploymentId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/update-function-deployment.md b/examples/1.9.x/server-rest/examples/functions/update-function-deployment.md index 535d4ee7f..1ce58479e 100644 --- a/examples/1.9.x/server-rest/examples/functions/update-function-deployment.md +++ b/examples/1.9.x/server-rest/examples/functions/update-function-deployment.md @@ -2,7 +2,7 @@ PATCH /v1/functions/{functionId}/deployment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/update-variable.md b/examples/1.9.x/server-rest/examples/functions/update-variable.md index 0457115ea..5e37be6d4 100644 --- a/examples/1.9.x/server-rest/examples/functions/update-variable.md +++ b/examples/1.9.x/server-rest/examples/functions/update-variable.md @@ -2,7 +2,7 @@ PUT /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/functions/update.md b/examples/1.9.x/server-rest/examples/functions/update.md index ded06d80b..567f8f417 100644 --- a/examples/1.9.x/server-rest/examples/functions/update.md +++ b/examples/1.9.x/server-rest/examples/functions/update.md @@ -2,7 +2,7 @@ PUT /v1/functions/{functionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/graphql/mutation.md b/examples/1.9.x/server-rest/examples/graphql/mutation.md index 4dc226175..3fc05e435 100644 --- a/examples/1.9.x/server-rest/examples/graphql/mutation.md +++ b/examples/1.9.x/server-rest/examples/graphql/mutation.md @@ -3,7 +3,7 @@ POST /v1/graphql/mutation HTTP/1.1 Host: cloud.appwrite.io X-Sdk-Graphql: true Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/graphql/query.md b/examples/1.9.x/server-rest/examples/graphql/query.md index ad9295355..82e7e9bed 100644 --- a/examples/1.9.x/server-rest/examples/graphql/query.md +++ b/examples/1.9.x/server-rest/examples/graphql/query.md @@ -3,7 +3,7 @@ POST /v1/graphql HTTP/1.1 Host: cloud.appwrite.io X-Sdk-Graphql: true Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/health/get-antivirus.md b/examples/1.9.x/server-rest/examples/health/get-antivirus.md index a8937ebad..8a87c2e06 100644 --- a/examples/1.9.x/server-rest/examples/health/get-antivirus.md +++ b/examples/1.9.x/server-rest/examples/health/get-antivirus.md @@ -1,7 +1,7 @@ ```http GET /v1/health/anti-virus HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-cache.md b/examples/1.9.x/server-rest/examples/health/get-cache.md index dd5268c8f..7c3904715 100644 --- a/examples/1.9.x/server-rest/examples/health/get-cache.md +++ b/examples/1.9.x/server-rest/examples/health/get-cache.md @@ -1,7 +1,7 @@ ```http GET /v1/health/cache HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-certificate.md b/examples/1.9.x/server-rest/examples/health/get-certificate.md index 64a32310a..7554cc212 100644 --- a/examples/1.9.x/server-rest/examples/health/get-certificate.md +++ b/examples/1.9.x/server-rest/examples/health/get-certificate.md @@ -1,7 +1,7 @@ ```http GET /v1/health/certificate HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-console-pausing.md b/examples/1.9.x/server-rest/examples/health/get-console-pausing.md index fe32b439a..de28fcfb8 100644 --- a/examples/1.9.x/server-rest/examples/health/get-console-pausing.md +++ b/examples/1.9.x/server-rest/examples/health/get-console-pausing.md @@ -1,7 +1,7 @@ ```http GET /v1/health/console-pausing HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-db.md b/examples/1.9.x/server-rest/examples/health/get-db.md index 9b0fabf64..9325e3ea8 100644 --- a/examples/1.9.x/server-rest/examples/health/get-db.md +++ b/examples/1.9.x/server-rest/examples/health/get-db.md @@ -1,7 +1,7 @@ ```http GET /v1/health/db HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-failed-jobs.md b/examples/1.9.x/server-rest/examples/health/get-failed-jobs.md index 136ada258..f27831dcd 100644 --- a/examples/1.9.x/server-rest/examples/health/get-failed-jobs.md +++ b/examples/1.9.x/server-rest/examples/health/get-failed-jobs.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/failed/{name} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-pub-sub.md b/examples/1.9.x/server-rest/examples/health/get-pub-sub.md index ba24795ec..796c040da 100644 --- a/examples/1.9.x/server-rest/examples/health/get-pub-sub.md +++ b/examples/1.9.x/server-rest/examples/health/get-pub-sub.md @@ -1,7 +1,7 @@ ```http GET /v1/health/pubsub HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-audits.md b/examples/1.9.x/server-rest/examples/health/get-queue-audits.md index 14aed25c3..a8ad742d6 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-audits.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-audits.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/audits HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-builds.md b/examples/1.9.x/server-rest/examples/health/get-queue-builds.md index 6fb5a57bd..d90d87add 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-builds.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-builds.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/builds HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-certificates.md b/examples/1.9.x/server-rest/examples/health/get-queue-certificates.md index 13fc103e9..98ddd4e31 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-certificates.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-certificates.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/certificates HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-databases.md b/examples/1.9.x/server-rest/examples/health/get-queue-databases.md index 8e13afd66..1d14ac2c0 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-databases.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-databases.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/databases HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-deletes.md b/examples/1.9.x/server-rest/examples/health/get-queue-deletes.md index 1ff1ff9cb..2b8e7fd69 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-deletes.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-deletes.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/deletes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-functions.md b/examples/1.9.x/server-rest/examples/health/get-queue-functions.md index ee29457af..8abc9a768 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-functions.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-functions.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/functions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-logs.md b/examples/1.9.x/server-rest/examples/health/get-queue-logs.md index 5f5424be5..7f0ea7c39 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-logs.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-mails.md b/examples/1.9.x/server-rest/examples/health/get-queue-mails.md index ca52d2a08..eea7fd62d 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-mails.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-mails.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/mails HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-messaging.md b/examples/1.9.x/server-rest/examples/health/get-queue-messaging.md index 152ee984a..a6a3ac746 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-messaging.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-messaging.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/messaging HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-migrations.md b/examples/1.9.x/server-rest/examples/health/get-queue-migrations.md index 7f3648ac4..3c04392ca 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-migrations.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-migrations.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/migrations HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-stats-resources.md b/examples/1.9.x/server-rest/examples/health/get-queue-stats-resources.md index 15210fb96..25b95a20b 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-stats-resources.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-stats-resources.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/stats-resources HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-usage.md b/examples/1.9.x/server-rest/examples/health/get-queue-usage.md index 740761492..de690b27b 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-usage.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-usage.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/stats-usage HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-queue-webhooks.md b/examples/1.9.x/server-rest/examples/health/get-queue-webhooks.md index c27eea8ad..62b7d5bb7 100644 --- a/examples/1.9.x/server-rest/examples/health/get-queue-webhooks.md +++ b/examples/1.9.x/server-rest/examples/health/get-queue-webhooks.md @@ -1,7 +1,7 @@ ```http GET /v1/health/queue/webhooks HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-storage-local.md b/examples/1.9.x/server-rest/examples/health/get-storage-local.md index 81b22ad18..4e7684894 100644 --- a/examples/1.9.x/server-rest/examples/health/get-storage-local.md +++ b/examples/1.9.x/server-rest/examples/health/get-storage-local.md @@ -1,7 +1,7 @@ ```http GET /v1/health/storage/local HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-storage.md b/examples/1.9.x/server-rest/examples/health/get-storage.md index 662deb8b9..1be0ea90c 100644 --- a/examples/1.9.x/server-rest/examples/health/get-storage.md +++ b/examples/1.9.x/server-rest/examples/health/get-storage.md @@ -1,7 +1,7 @@ ```http GET /v1/health/storage HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get-time.md b/examples/1.9.x/server-rest/examples/health/get-time.md index fc4864aab..2dc0db1cb 100644 --- a/examples/1.9.x/server-rest/examples/health/get-time.md +++ b/examples/1.9.x/server-rest/examples/health/get-time.md @@ -1,7 +1,7 @@ ```http GET /v1/health/time HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/health/get.md b/examples/1.9.x/server-rest/examples/health/get.md index 5c82980f7..8b935e810 100644 --- a/examples/1.9.x/server-rest/examples/health/get.md +++ b/examples/1.9.x/server-rest/examples/health/get.md @@ -1,7 +1,7 @@ ```http GET /v1/health HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/locale/get.md b/examples/1.9.x/server-rest/examples/locale/get.md index ed46c6b31..b3d8a4f0b 100644 --- a/examples/1.9.x/server-rest/examples/locale/get.md +++ b/examples/1.9.x/server-rest/examples/locale/get.md @@ -1,7 +1,7 @@ ```http GET /v1/locale HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/locale/list-codes.md b/examples/1.9.x/server-rest/examples/locale/list-codes.md index 140ccf4cd..9616d271f 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-codes.md +++ b/examples/1.9.x/server-rest/examples/locale/list-codes.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/codes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/locale/list-continents.md b/examples/1.9.x/server-rest/examples/locale/list-continents.md index 41474573e..10945f3b7 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-continents.md +++ b/examples/1.9.x/server-rest/examples/locale/list-continents.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/continents HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/locale/list-countries-eu.md b/examples/1.9.x/server-rest/examples/locale/list-countries-eu.md index 8885931af..542fe6c77 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-countries-eu.md +++ b/examples/1.9.x/server-rest/examples/locale/list-countries-eu.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/countries/eu HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/locale/list-countries-phones.md b/examples/1.9.x/server-rest/examples/locale/list-countries-phones.md index 28c5f4b74..3a6cfeb87 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-countries-phones.md +++ b/examples/1.9.x/server-rest/examples/locale/list-countries-phones.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/countries/phones HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/locale/list-countries.md b/examples/1.9.x/server-rest/examples/locale/list-countries.md index 6f0eed583..9c850c229 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-countries.md +++ b/examples/1.9.x/server-rest/examples/locale/list-countries.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/countries HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/locale/list-currencies.md b/examples/1.9.x/server-rest/examples/locale/list-currencies.md index d05900cb2..e380024e8 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-currencies.md +++ b/examples/1.9.x/server-rest/examples/locale/list-currencies.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/currencies HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/locale/list-languages.md b/examples/1.9.x/server-rest/examples/locale/list-languages.md index c9ec427d6..30b31466b 100644 --- a/examples/1.9.x/server-rest/examples/locale/list-languages.md +++ b/examples/1.9.x/server-rest/examples/locale/list-languages.md @@ -1,7 +1,7 @@ ```http GET /v1/locale/languages HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-apns-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-apns-provider.md index 3161f4dfe..facce1d49 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-apns-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-apns-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/apns HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-email.md b/examples/1.9.x/server-rest/examples/messaging/create-email.md index 413ea0b96..c66249700 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-email.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-email.md @@ -2,7 +2,7 @@ POST /v1/messaging/messages/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-fcm-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-fcm-provider.md index 050403328..04bcb9355 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-fcm-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-fcm-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/fcm HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-mailgun-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-mailgun-provider.md index 576d109be..3414d87d5 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-mailgun-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-mailgun-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/mailgun HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-msg-91-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-msg-91-provider.md index 78fd50eb5..33b7458ba 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-msg-91-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-msg-91-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/msg91 HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-push.md b/examples/1.9.x/server-rest/examples/messaging/create-push.md index 6023aafb5..889affb90 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-push.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-push.md @@ -2,7 +2,7 @@ POST /v1/messaging/messages/push HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-resend-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-resend-provider.md index d810cc4e6..e9131f009 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-resend-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-resend-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/resend HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-sendgrid-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-sendgrid-provider.md index 8533aaa77..2d5e7c29e 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-sendgrid-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-sendgrid-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/sendgrid HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-sms.md b/examples/1.9.x/server-rest/examples/messaging/create-sms.md index 8b99fa2d8..716f1f5d9 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-sms.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-sms.md @@ -2,7 +2,7 @@ POST /v1/messaging/messages/sms HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-smtp-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-smtp-provider.md index a60908299..bdb7aa4f4 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-smtp-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-smtp-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/smtp HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-subscriber.md b/examples/1.9.x/server-rest/examples/messaging/create-subscriber.md index d6ed2b0dc..f7a7edb97 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-subscriber.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-subscriber.md @@ -2,7 +2,7 @@ POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-JWT: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-telesign-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-telesign-provider.md index abcc5ed8b..d99ccb699 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-telesign-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-telesign-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/telesign HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-textmagic-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-textmagic-provider.md index 8983379f3..3a3045aed 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-textmagic-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-textmagic-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/textmagic HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-topic.md b/examples/1.9.x/server-rest/examples/messaging/create-topic.md index 7f05c50eb..805c54b1c 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-topic.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-topic.md @@ -2,7 +2,7 @@ POST /v1/messaging/topics HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-twilio-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-twilio-provider.md index 8ebb6ea84..d21338f90 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-twilio-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-twilio-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/twilio HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/create-vonage-provider.md b/examples/1.9.x/server-rest/examples/messaging/create-vonage-provider.md index 22802fb4a..8d8ae8ed0 100644 --- a/examples/1.9.x/server-rest/examples/messaging/create-vonage-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/create-vonage-provider.md @@ -2,7 +2,7 @@ POST /v1/messaging/providers/vonage HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/delete-provider.md b/examples/1.9.x/server-rest/examples/messaging/delete-provider.md index cb1591abf..275eebe3e 100644 --- a/examples/1.9.x/server-rest/examples/messaging/delete-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/delete-provider.md @@ -2,7 +2,7 @@ DELETE /v1/messaging/providers/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/delete-subscriber.md b/examples/1.9.x/server-rest/examples/messaging/delete-subscriber.md index eeace9c6b..719256fa6 100644 --- a/examples/1.9.x/server-rest/examples/messaging/delete-subscriber.md +++ b/examples/1.9.x/server-rest/examples/messaging/delete-subscriber.md @@ -2,7 +2,7 @@ DELETE /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-JWT: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/messaging/delete-topic.md b/examples/1.9.x/server-rest/examples/messaging/delete-topic.md index 7329e47b9..2c40f932a 100644 --- a/examples/1.9.x/server-rest/examples/messaging/delete-topic.md +++ b/examples/1.9.x/server-rest/examples/messaging/delete-topic.md @@ -2,7 +2,7 @@ DELETE /v1/messaging/topics/{topicId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/delete.md b/examples/1.9.x/server-rest/examples/messaging/delete.md index aba68eb23..7089acc4f 100644 --- a/examples/1.9.x/server-rest/examples/messaging/delete.md +++ b/examples/1.9.x/server-rest/examples/messaging/delete.md @@ -2,7 +2,7 @@ DELETE /v1/messaging/messages/{messageId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/get-message.md b/examples/1.9.x/server-rest/examples/messaging/get-message.md index 5ef4d748e..b98b81d3e 100644 --- a/examples/1.9.x/server-rest/examples/messaging/get-message.md +++ b/examples/1.9.x/server-rest/examples/messaging/get-message.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/messages/{messageId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/get-provider.md b/examples/1.9.x/server-rest/examples/messaging/get-provider.md index 54a360ca0..f2a243c74 100644 --- a/examples/1.9.x/server-rest/examples/messaging/get-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/get-provider.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/providers/{providerId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/get-subscriber.md b/examples/1.9.x/server-rest/examples/messaging/get-subscriber.md index 6c199bacc..0d6a027c5 100644 --- a/examples/1.9.x/server-rest/examples/messaging/get-subscriber.md +++ b/examples/1.9.x/server-rest/examples/messaging/get-subscriber.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/get-topic.md b/examples/1.9.x/server-rest/examples/messaging/get-topic.md index 05a29b78f..5ded7caf2 100644 --- a/examples/1.9.x/server-rest/examples/messaging/get-topic.md +++ b/examples/1.9.x/server-rest/examples/messaging/get-topic.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/topics/{topicId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-message-logs.md b/examples/1.9.x/server-rest/examples/messaging/list-message-logs.md index 97482c8d4..99cf6e0b2 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-message-logs.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-message-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/messages/{messageId}/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-messages.md b/examples/1.9.x/server-rest/examples/messaging/list-messages.md index 13cd6ec1b..0b65854e2 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-messages.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-messages.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/messages HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-provider-logs.md b/examples/1.9.x/server-rest/examples/messaging/list-provider-logs.md index 01621af7d..6731d3f97 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-provider-logs.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-provider-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/providers/{providerId}/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-providers.md b/examples/1.9.x/server-rest/examples/messaging/list-providers.md index cac2ec970..03b3e3785 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-providers.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-providers.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/providers HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-subscriber-logs.md b/examples/1.9.x/server-rest/examples/messaging/list-subscriber-logs.md index f60b00fc8..1e4a02693 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-subscriber-logs.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-subscriber-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/subscribers/{subscriberId}/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-subscribers.md b/examples/1.9.x/server-rest/examples/messaging/list-subscribers.md index daa2dc569..02ee664c2 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-subscribers.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-subscribers.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-targets.md b/examples/1.9.x/server-rest/examples/messaging/list-targets.md index 359211444..3785d1dc6 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-targets.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-targets.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/messages/{messageId}/targets HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-topic-logs.md b/examples/1.9.x/server-rest/examples/messaging/list-topic-logs.md index 4c995b665..786015306 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-topic-logs.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-topic-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/topics/{topicId}/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/list-topics.md b/examples/1.9.x/server-rest/examples/messaging/list-topics.md index dc680c9c3..e28c90c4f 100644 --- a/examples/1.9.x/server-rest/examples/messaging/list-topics.md +++ b/examples/1.9.x/server-rest/examples/messaging/list-topics.md @@ -1,7 +1,7 @@ ```http GET /v1/messaging/topics HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/messaging/update-apns-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-apns-provider.md index 64ac4e6ae..d3ad99e66 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-apns-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-apns-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/apns/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-email.md b/examples/1.9.x/server-rest/examples/messaging/update-email.md index 8a45a1628..55472285d 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-email.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-email.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/messages/email/{messageId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-fcm-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-fcm-provider.md index 1f939eb81..67757e606 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-fcm-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-fcm-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/fcm/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-mailgun-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-mailgun-provider.md index 69247854c..c1f4dc97b 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-mailgun-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-mailgun-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/mailgun/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-msg-91-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-msg-91-provider.md index 5bee6716b..2b73e882f 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-msg-91-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-msg-91-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/msg91/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-push.md b/examples/1.9.x/server-rest/examples/messaging/update-push.md index a28fb802c..ecaa53b2c 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-push.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-push.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/messages/push/{messageId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-resend-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-resend-provider.md index 23ba30118..de7fcaa06 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-resend-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-resend-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/resend/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-sendgrid-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-sendgrid-provider.md index 77fb49f85..25126d381 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-sendgrid-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-sendgrid-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/sendgrid/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-sms.md b/examples/1.9.x/server-rest/examples/messaging/update-sms.md index 05d3491e6..b41691ed5 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-sms.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-sms.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/messages/sms/{messageId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-smtp-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-smtp-provider.md index 02361edae..64b0ab6f3 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-smtp-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-smtp-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/smtp/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-telesign-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-telesign-provider.md index 3c7324a25..661adff5b 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-telesign-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-telesign-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/telesign/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-textmagic-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-textmagic-provider.md index 00d838e0e..23083107c 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-textmagic-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-textmagic-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/textmagic/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-topic.md b/examples/1.9.x/server-rest/examples/messaging/update-topic.md index 625f29312..4bc93ecde 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-topic.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-topic.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/topics/{topicId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-twilio-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-twilio-provider.md index 5ff115b57..5deea31f7 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-twilio-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-twilio-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/twilio/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/messaging/update-vonage-provider.md b/examples/1.9.x/server-rest/examples/messaging/update-vonage-provider.md index 95049c6f3..35fec71cb 100644 --- a/examples/1.9.x/server-rest/examples/messaging/update-vonage-provider.md +++ b/examples/1.9.x/server-rest/examples/messaging/update-vonage-provider.md @@ -2,7 +2,7 @@ PATCH /v1/messaging/providers/vonage/{providerId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/create-android-platform.md b/examples/1.9.x/server-rest/examples/project/create-android-platform.md index 389c897a4..97ac5c968 100644 --- a/examples/1.9.x/server-rest/examples/project/create-android-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-android-platform.md @@ -2,7 +2,7 @@ POST /v1/project/platforms/android HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/create-apple-platform.md b/examples/1.9.x/server-rest/examples/project/create-apple-platform.md index 2b9ab5719..b5297e706 100644 --- a/examples/1.9.x/server-rest/examples/project/create-apple-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-apple-platform.md @@ -2,7 +2,7 @@ POST /v1/project/platforms/apple HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-rest/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..a9eb48f4c --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/create-ephemeral-key.md @@ -0,0 +1,13 @@ +```http +POST /v1/project/keys/ephemeral HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "scopes": [], + "duration": 1 +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/create-key.md b/examples/1.9.x/server-rest/examples/project/create-key.md index ac32e0446..baf77ac84 100644 --- a/examples/1.9.x/server-rest/examples/project/create-key.md +++ b/examples/1.9.x/server-rest/examples/project/create-key.md @@ -2,7 +2,7 @@ POST /v1/project/keys HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/create-linux-platform.md b/examples/1.9.x/server-rest/examples/project/create-linux-platform.md index 9ddb4c942..ab1810613 100644 --- a/examples/1.9.x/server-rest/examples/project/create-linux-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-linux-platform.md @@ -2,7 +2,7 @@ POST /v1/project/platforms/linux HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/create-mock-phone.md b/examples/1.9.x/server-rest/examples/project/create-mock-phone.md new file mode 100644 index 000000000..e0fe44ab7 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/create-mock-phone.md @@ -0,0 +1,13 @@ +```http +POST /v1/project/mock-phones HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "number": "+12065550100", + "otp": "" +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/create-smtp-test.md b/examples/1.9.x/server-rest/examples/project/create-smtp-test.md index 64fea36d0..851cfd535 100644 --- a/examples/1.9.x/server-rest/examples/project/create-smtp-test.md +++ b/examples/1.9.x/server-rest/examples/project/create-smtp-test.md @@ -2,7 +2,7 @@ POST /v1/project/smtp/tests HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/create-variable.md b/examples/1.9.x/server-rest/examples/project/create-variable.md index ff8471ba8..dd9c685d7 100644 --- a/examples/1.9.x/server-rest/examples/project/create-variable.md +++ b/examples/1.9.x/server-rest/examples/project/create-variable.md @@ -2,7 +2,7 @@ POST /v1/project/variables HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/create-web-platform.md b/examples/1.9.x/server-rest/examples/project/create-web-platform.md index 0f9ae30aa..faa024641 100644 --- a/examples/1.9.x/server-rest/examples/project/create-web-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-web-platform.md @@ -2,7 +2,7 @@ POST /v1/project/platforms/web HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/create-windows-platform.md b/examples/1.9.x/server-rest/examples/project/create-windows-platform.md index 03f60f097..9dd3e312b 100644 --- a/examples/1.9.x/server-rest/examples/project/create-windows-platform.md +++ b/examples/1.9.x/server-rest/examples/project/create-windows-platform.md @@ -2,7 +2,7 @@ POST /v1/project/platforms/windows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/delete-key.md b/examples/1.9.x/server-rest/examples/project/delete-key.md index e42dadb31..7d33e09ed 100644 --- a/examples/1.9.x/server-rest/examples/project/delete-key.md +++ b/examples/1.9.x/server-rest/examples/project/delete-key.md @@ -2,7 +2,7 @@ DELETE /v1/project/keys/{keyId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/delete-mock-phone.md b/examples/1.9.x/server-rest/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..f2f721a8a --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/delete-mock-phone.md @@ -0,0 +1,9 @@ +```http +DELETE /v1/project/mock-phones/{number} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +``` diff --git a/examples/1.9.x/server-rest/examples/project/delete-platform.md b/examples/1.9.x/server-rest/examples/project/delete-platform.md index c85383e41..86e3fb00c 100644 --- a/examples/1.9.x/server-rest/examples/project/delete-platform.md +++ b/examples/1.9.x/server-rest/examples/project/delete-platform.md @@ -2,7 +2,7 @@ DELETE /v1/project/platforms/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/delete-variable.md b/examples/1.9.x/server-rest/examples/project/delete-variable.md index d602f0503..3f3031f55 100644 --- a/examples/1.9.x/server-rest/examples/project/delete-variable.md +++ b/examples/1.9.x/server-rest/examples/project/delete-variable.md @@ -2,7 +2,7 @@ DELETE /v1/project/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/delete.md b/examples/1.9.x/server-rest/examples/project/delete.md new file mode 100644 index 000000000..d5554c9aa --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/delete.md @@ -0,0 +1,9 @@ +```http +DELETE /v1/project HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +``` diff --git a/examples/1.9.x/server-rest/examples/project/get-email-template.md b/examples/1.9.x/server-rest/examples/project/get-email-template.md index 2bb6d30e2..102cd7844 100644 --- a/examples/1.9.x/server-rest/examples/project/get-email-template.md +++ b/examples/1.9.x/server-rest/examples/project/get-email-template.md @@ -1,7 +1,7 @@ ```http GET /v1/project/templates/email/{templateId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-key.md b/examples/1.9.x/server-rest/examples/project/get-key.md index 4619dec64..5ef4e9849 100644 --- a/examples/1.9.x/server-rest/examples/project/get-key.md +++ b/examples/1.9.x/server-rest/examples/project/get-key.md @@ -1,7 +1,7 @@ ```http GET /v1/project/keys/{keyId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-mock-phone.md b/examples/1.9.x/server-rest/examples/project/get-mock-phone.md new file mode 100644 index 000000000..2f4f26d4a --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/get-mock-phone.md @@ -0,0 +1,7 @@ +```http +GET /v1/project/mock-phones/{number} HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: +``` diff --git a/examples/1.9.x/server-rest/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-rest/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..fd94b68af --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,7 @@ +```http +GET /v1/project/oauth2/{provider} HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: +``` diff --git a/examples/1.9.x/server-rest/examples/project/get-platform.md b/examples/1.9.x/server-rest/examples/project/get-platform.md index adfc4826f..fb071a378 100644 --- a/examples/1.9.x/server-rest/examples/project/get-platform.md +++ b/examples/1.9.x/server-rest/examples/project/get-platform.md @@ -1,7 +1,7 @@ ```http GET /v1/project/platforms/{platformId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/project/get-policy.md b/examples/1.9.x/server-rest/examples/project/get-policy.md new file mode 100644 index 000000000..679eb65b0 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/get-policy.md @@ -0,0 +1,7 @@ +```http +GET /v1/project/policies/{policyId} HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: +``` diff --git a/examples/1.9.x/server-rest/examples/project/get-variable.md b/examples/1.9.x/server-rest/examples/project/get-variable.md index e1aaf2466..952d3714b 100644 --- a/examples/1.9.x/server-rest/examples/project/get-variable.md +++ b/examples/1.9.x/server-rest/examples/project/get-variable.md @@ -1,7 +1,7 @@ ```http GET /v1/project/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-email-templates.md b/examples/1.9.x/server-rest/examples/project/list-email-templates.md new file mode 100644 index 000000000..a4f6d5b4d --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/list-email-templates.md @@ -0,0 +1,7 @@ +```http +GET /v1/project/templates/email HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: +``` diff --git a/examples/1.9.x/server-rest/examples/project/list-keys.md b/examples/1.9.x/server-rest/examples/project/list-keys.md index b0fef8246..268be5ba8 100644 --- a/examples/1.9.x/server-rest/examples/project/list-keys.md +++ b/examples/1.9.x/server-rest/examples/project/list-keys.md @@ -1,7 +1,7 @@ ```http GET /v1/project/keys HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-mock-phones.md b/examples/1.9.x/server-rest/examples/project/list-mock-phones.md new file mode 100644 index 000000000..c6adb53d3 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/list-mock-phones.md @@ -0,0 +1,7 @@ +```http +GET /v1/project/mock-phones HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: +``` diff --git a/examples/1.9.x/server-rest/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-rest/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..b269c6497 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,7 @@ +```http +GET /v1/project/oauth2 HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: +``` diff --git a/examples/1.9.x/server-rest/examples/project/list-platforms.md b/examples/1.9.x/server-rest/examples/project/list-platforms.md index 7630a2823..d839e677c 100644 --- a/examples/1.9.x/server-rest/examples/project/list-platforms.md +++ b/examples/1.9.x/server-rest/examples/project/list-platforms.md @@ -1,7 +1,7 @@ ```http GET /v1/project/platforms HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/project/list-policies.md b/examples/1.9.x/server-rest/examples/project/list-policies.md new file mode 100644 index 000000000..72ab04bcc --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/list-policies.md @@ -0,0 +1,7 @@ +```http +GET /v1/project/policies HTTP/1.1 +Host: cloud.appwrite.io +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: +``` diff --git a/examples/1.9.x/server-rest/examples/project/list-variables.md b/examples/1.9.x/server-rest/examples/project/list-variables.md index d32e5b322..ce82743b3 100644 --- a/examples/1.9.x/server-rest/examples/project/list-variables.md +++ b/examples/1.9.x/server-rest/examples/project/list-variables.md @@ -1,7 +1,7 @@ ```http GET /v1/project/variables HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/project/update-android-platform.md b/examples/1.9.x/server-rest/examples/project/update-android-platform.md index 51cb59913..b812547ae 100644 --- a/examples/1.9.x/server-rest/examples/project/update-android-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-android-platform.md @@ -2,7 +2,7 @@ PUT /v1/project/platforms/android/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-apple-platform.md b/examples/1.9.x/server-rest/examples/project/update-apple-platform.md index d8eb73c94..1c4902082 100644 --- a/examples/1.9.x/server-rest/examples/project/update-apple-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-apple-platform.md @@ -2,7 +2,7 @@ PUT /v1/project/platforms/apple/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-auth-method.md b/examples/1.9.x/server-rest/examples/project/update-auth-method.md new file mode 100644 index 000000000..e34e31107 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-auth-method.md @@ -0,0 +1,12 @@ +```http +PATCH /v1/project/auth-methods/{methodId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-email-template.md b/examples/1.9.x/server-rest/examples/project/update-email-template.md index b43ce4551..bcc90224e 100644 --- a/examples/1.9.x/server-rest/examples/project/update-email-template.md +++ b/examples/1.9.x/server-rest/examples/project/update-email-template.md @@ -2,7 +2,7 @@ PATCH /v1/project/templates/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-key.md b/examples/1.9.x/server-rest/examples/project/update-key.md index 5980bf24d..63d2d4bd3 100644 --- a/examples/1.9.x/server-rest/examples/project/update-key.md +++ b/examples/1.9.x/server-rest/examples/project/update-key.md @@ -2,7 +2,7 @@ PUT /v1/project/keys/{keyId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-labels.md b/examples/1.9.x/server-rest/examples/project/update-labels.md index 57975a57e..cf1287f93 100644 --- a/examples/1.9.x/server-rest/examples/project/update-labels.md +++ b/examples/1.9.x/server-rest/examples/project/update-labels.md @@ -2,7 +2,7 @@ PUT /v1/project/labels HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-linux-platform.md b/examples/1.9.x/server-rest/examples/project/update-linux-platform.md index 965717bf0..892c594cb 100644 --- a/examples/1.9.x/server-rest/examples/project/update-linux-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-linux-platform.md @@ -2,7 +2,7 @@ PUT /v1/project/platforms/linux/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-membership-privacy-policy.md b/examples/1.9.x/server-rest/examples/project/update-membership-privacy-policy.md index d7b14f3b6..3654c2ef8 100644 --- a/examples/1.9.x/server-rest/examples/project/update-membership-privacy-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-membership-privacy-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/membership-privacy HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-mock-phone.md b/examples/1.9.x/server-rest/examples/project/update-mock-phone.md new file mode 100644 index 000000000..720f9f108 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-mock-phone.md @@ -0,0 +1,12 @@ +```http +PUT /v1/project/mock-phones/{number} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "otp": "" +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..91dba0ba7 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/amazon HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..1290442dc --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,16 @@ +```http +PATCH /v1/project/oauth2/apple HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "serviceId": "", + "keyId": "", + "teamId": "", + "p8File": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..9ec49cdb3 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,15 @@ +```http +PATCH /v1/project/oauth2/auth0 HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "endpoint": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..2e06c4662 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,15 @@ +```http +PATCH /v1/project/oauth2/authentik HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "endpoint": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..d02c00ec7 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/autodesk HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..ebd160e6b --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/bitbucket HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "key": "", + "secret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..4ed525203 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/bitly HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..b2ee72521 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-box.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/box HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..95ce6ba8f --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/dailymotion HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "apiKey": "", + "apiSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..8894dc2fa --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/discord HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..f0609c60d --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/disqus HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "publicKey": "", + "secretKey": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..7926cea74 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/dropbox HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "appKey": "", + "appSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..242fc34d2 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/etsy HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "keyString": "", + "sharedSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..f490119ff --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/facebook HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "appId": "", + "appSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..b965bf9f5 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/figma HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..de905e176 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,15 @@ +```http +PATCH /v1/project/oauth2/fusionauth HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "endpoint": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..fce047437 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/github HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..d406f99bd --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,15 @@ +```http +PATCH /v1/project/oauth2/gitlab HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "applicationId": "", + "secret": "", + "endpoint": "https://example.com", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..84d0af140 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-google.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/google HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..ea69b6f56 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,16 @@ +```http +PATCH /v1/project/oauth2/keycloak HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "endpoint": "", + "realmName": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..080a5200e --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/kick HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..04f81c278 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/linkedin HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "primaryClientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..8b975ce39 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,15 @@ +```http +PATCH /v1/project/oauth2/microsoft HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "applicationId": "", + "applicationSecret": "", + "tenant": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..cea683bf1 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/notion HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "oauthClientId": "", + "oauthClientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..ce461d61f --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,18 @@ +```http +PATCH /v1/project/oauth2/oidc HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "wellKnownURL": "https://example.com", + "authorizationURL": "https://example.com", + "tokenUrl": "https://example.com", + "userInfoUrl": "https://example.com", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..8301ea99f --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,16 @@ +```http +PATCH /v1/project/oauth2/okta HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "domain": "", + "authorizationServerId": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..4b0bce0f0 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/paypalSandbox HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "secretKey": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..bc0cd26fa --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/paypal HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "secretKey": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..e76eed170 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/podio HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..292f17965 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/salesforce HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "customerKey": "", + "customerSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..a77188064 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/slack HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..0c8d08578 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/spotify HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..f6f753542 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/stripe HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "apiSecretKey": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..e22241ee8 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/tradeshiftBox HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "oauth2ClientId": "", + "oauth2ClientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..4b44c35cc --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/tradeshift HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "oauth2ClientId": "", + "oauth2ClientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..77b372218 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/twitch HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..49a05ff61 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/wordpress HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..ee0ebd2f0 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/yahoo HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..bc0efcca9 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/yandex HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..044cbcf08 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/zoho HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..20c2e66de --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/zoom HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "clientId": "", + "clientSecret": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-rest/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..a88c93c17 --- /dev/null +++ b/examples/1.9.x/server-rest/examples/project/update-o-auth-2x.md @@ -0,0 +1,14 @@ +```http +PATCH /v1/project/oauth2/x HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.9.3 +X-Appwrite-Project: +X-Appwrite-Key: + +{ + "customerKey": "", + "secretKey": "", + "enabled": false +} +``` diff --git a/examples/1.9.x/server-rest/examples/project/update-password-dictionary-policy.md b/examples/1.9.x/server-rest/examples/project/update-password-dictionary-policy.md index 5fb4e9bba..3bc721365 100644 --- a/examples/1.9.x/server-rest/examples/project/update-password-dictionary-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-password-dictionary-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/password-dictionary HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-password-history-policy.md b/examples/1.9.x/server-rest/examples/project/update-password-history-policy.md index f0652ba06..c65b04520 100644 --- a/examples/1.9.x/server-rest/examples/project/update-password-history-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-password-history-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/password-history HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-password-personal-data-policy.md b/examples/1.9.x/server-rest/examples/project/update-password-personal-data-policy.md index 00f65547f..27a78540b 100644 --- a/examples/1.9.x/server-rest/examples/project/update-password-personal-data-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-password-personal-data-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/password-personal-data HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-protocol.md b/examples/1.9.x/server-rest/examples/project/update-protocol.md index 9376b039a..66415cabd 100644 --- a/examples/1.9.x/server-rest/examples/project/update-protocol.md +++ b/examples/1.9.x/server-rest/examples/project/update-protocol.md @@ -2,7 +2,7 @@ PATCH /v1/project/protocols/{protocolId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-service.md b/examples/1.9.x/server-rest/examples/project/update-service.md index 098dc06cd..ff2ab0536 100644 --- a/examples/1.9.x/server-rest/examples/project/update-service.md +++ b/examples/1.9.x/server-rest/examples/project/update-service.md @@ -2,7 +2,7 @@ PATCH /v1/project/services/{serviceId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-session-alert-policy.md b/examples/1.9.x/server-rest/examples/project/update-session-alert-policy.md index 44467832e..4279d6f0e 100644 --- a/examples/1.9.x/server-rest/examples/project/update-session-alert-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-session-alert-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/session-alert HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-session-duration-policy.md b/examples/1.9.x/server-rest/examples/project/update-session-duration-policy.md index f646eac03..65bb1aad5 100644 --- a/examples/1.9.x/server-rest/examples/project/update-session-duration-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-session-duration-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/session-duration HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-session-invalidation-policy.md b/examples/1.9.x/server-rest/examples/project/update-session-invalidation-policy.md index a906d2cf0..267fbd220 100644 --- a/examples/1.9.x/server-rest/examples/project/update-session-invalidation-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-session-invalidation-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/session-invalidation HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-session-limit-policy.md b/examples/1.9.x/server-rest/examples/project/update-session-limit-policy.md index 01dc5eafe..974004635 100644 --- a/examples/1.9.x/server-rest/examples/project/update-session-limit-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-session-limit-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/session-limit HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-smtp.md b/examples/1.9.x/server-rest/examples/project/update-smtp.md index ba3971d6a..ce6ed4e33 100644 --- a/examples/1.9.x/server-rest/examples/project/update-smtp.md +++ b/examples/1.9.x/server-rest/examples/project/update-smtp.md @@ -2,7 +2,7 @@ PATCH /v1/project/smtp HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-user-limit-policy.md b/examples/1.9.x/server-rest/examples/project/update-user-limit-policy.md index b77b1b10f..9f958139d 100644 --- a/examples/1.9.x/server-rest/examples/project/update-user-limit-policy.md +++ b/examples/1.9.x/server-rest/examples/project/update-user-limit-policy.md @@ -2,7 +2,7 @@ PATCH /v1/project/policies/user-limit HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-variable.md b/examples/1.9.x/server-rest/examples/project/update-variable.md index 0c2303c4a..f0514d90c 100644 --- a/examples/1.9.x/server-rest/examples/project/update-variable.md +++ b/examples/1.9.x/server-rest/examples/project/update-variable.md @@ -2,7 +2,7 @@ PUT /v1/project/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-web-platform.md b/examples/1.9.x/server-rest/examples/project/update-web-platform.md index 5d7593d85..58d4a92c3 100644 --- a/examples/1.9.x/server-rest/examples/project/update-web-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-web-platform.md @@ -2,7 +2,7 @@ PUT /v1/project/platforms/web/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/project/update-windows-platform.md b/examples/1.9.x/server-rest/examples/project/update-windows-platform.md index 26d4ea06f..a0e2d16e8 100644 --- a/examples/1.9.x/server-rest/examples/project/update-windows-platform.md +++ b/examples/1.9.x/server-rest/examples/project/update-windows-platform.md @@ -2,7 +2,7 @@ PUT /v1/project/platforms/windows/{platformId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/create-deployment.md b/examples/1.9.x/server-rest/examples/sites/create-deployment.md index 63fee5a21..4d43839dc 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/create-deployment.md @@ -2,7 +2,7 @@ POST /v1/sites/{siteId}/deployments HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: Content-Length: *Length of your entity body in bytes* diff --git a/examples/1.9.x/server-rest/examples/sites/create-duplicate-deployment.md b/examples/1.9.x/server-rest/examples/sites/create-duplicate-deployment.md index 4f94cd136..d7f96af8f 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-duplicate-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/create-duplicate-deployment.md @@ -2,7 +2,7 @@ POST /v1/sites/{siteId}/deployments/duplicate HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/create-template-deployment.md b/examples/1.9.x/server-rest/examples/sites/create-template-deployment.md index 8a59cf3c0..d37e04032 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-template-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/create-template-deployment.md @@ -2,7 +2,7 @@ POST /v1/sites/{siteId}/deployments/template HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/create-variable.md b/examples/1.9.x/server-rest/examples/sites/create-variable.md index 9cced5a78..d38e2e946 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-variable.md +++ b/examples/1.9.x/server-rest/examples/sites/create-variable.md @@ -2,7 +2,7 @@ POST /v1/sites/{siteId}/variables HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/create-vcs-deployment.md b/examples/1.9.x/server-rest/examples/sites/create-vcs-deployment.md index 34597b297..94fe5d0b3 100644 --- a/examples/1.9.x/server-rest/examples/sites/create-vcs-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/create-vcs-deployment.md @@ -2,7 +2,7 @@ POST /v1/sites/{siteId}/deployments/vcs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/create.md b/examples/1.9.x/server-rest/examples/sites/create.md index bfacbb3f0..404ae2069 100644 --- a/examples/1.9.x/server-rest/examples/sites/create.md +++ b/examples/1.9.x/server-rest/examples/sites/create.md @@ -2,7 +2,7 @@ POST /v1/sites HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/delete-deployment.md b/examples/1.9.x/server-rest/examples/sites/delete-deployment.md index 7a6c2c892..757d195ec 100644 --- a/examples/1.9.x/server-rest/examples/sites/delete-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/delete-deployment.md @@ -2,7 +2,7 @@ DELETE /v1/sites/{siteId}/deployments/{deploymentId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/delete-log.md b/examples/1.9.x/server-rest/examples/sites/delete-log.md index f3e959254..4a3335135 100644 --- a/examples/1.9.x/server-rest/examples/sites/delete-log.md +++ b/examples/1.9.x/server-rest/examples/sites/delete-log.md @@ -2,7 +2,7 @@ DELETE /v1/sites/{siteId}/logs/{logId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/delete-variable.md b/examples/1.9.x/server-rest/examples/sites/delete-variable.md index e6428f752..3b3928f8d 100644 --- a/examples/1.9.x/server-rest/examples/sites/delete-variable.md +++ b/examples/1.9.x/server-rest/examples/sites/delete-variable.md @@ -2,7 +2,7 @@ DELETE /v1/sites/{siteId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/delete.md b/examples/1.9.x/server-rest/examples/sites/delete.md index b810fcfeb..30fcc5684 100644 --- a/examples/1.9.x/server-rest/examples/sites/delete.md +++ b/examples/1.9.x/server-rest/examples/sites/delete.md @@ -2,7 +2,7 @@ DELETE /v1/sites/{siteId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/get-deployment-download.md b/examples/1.9.x/server-rest/examples/sites/get-deployment-download.md index e380e47ac..535313da1 100644 --- a/examples/1.9.x/server-rest/examples/sites/get-deployment-download.md +++ b/examples/1.9.x/server-rest/examples/sites/get-deployment-download.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/{siteId}/deployments/{deploymentId}/download HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/sites/get-deployment.md b/examples/1.9.x/server-rest/examples/sites/get-deployment.md index 343d39fc6..a821e2a04 100644 --- a/examples/1.9.x/server-rest/examples/sites/get-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/get-deployment.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/{siteId}/deployments/{deploymentId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/get-log.md b/examples/1.9.x/server-rest/examples/sites/get-log.md index 9f7ef5a11..9b58e7421 100644 --- a/examples/1.9.x/server-rest/examples/sites/get-log.md +++ b/examples/1.9.x/server-rest/examples/sites/get-log.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/{siteId}/logs/{logId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/get-variable.md b/examples/1.9.x/server-rest/examples/sites/get-variable.md index 7f9d8d4de..45cb79289 100644 --- a/examples/1.9.x/server-rest/examples/sites/get-variable.md +++ b/examples/1.9.x/server-rest/examples/sites/get-variable.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/{siteId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/get.md b/examples/1.9.x/server-rest/examples/sites/get.md index 0a91903ae..17f35e300 100644 --- a/examples/1.9.x/server-rest/examples/sites/get.md +++ b/examples/1.9.x/server-rest/examples/sites/get.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/{siteId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-deployments.md b/examples/1.9.x/server-rest/examples/sites/list-deployments.md index dec04fc1e..7f1f1b079 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-deployments.md +++ b/examples/1.9.x/server-rest/examples/sites/list-deployments.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/{siteId}/deployments HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-frameworks.md b/examples/1.9.x/server-rest/examples/sites/list-frameworks.md index 2c6fcff75..118b7ef3f 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-frameworks.md +++ b/examples/1.9.x/server-rest/examples/sites/list-frameworks.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/frameworks HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-logs.md b/examples/1.9.x/server-rest/examples/sites/list-logs.md index fa7fdbbe6..697fc4d4d 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-logs.md +++ b/examples/1.9.x/server-rest/examples/sites/list-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/{siteId}/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-specifications.md b/examples/1.9.x/server-rest/examples/sites/list-specifications.md index 9a683c1ae..f87c1ed8a 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-specifications.md +++ b/examples/1.9.x/server-rest/examples/sites/list-specifications.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/specifications HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list-variables.md b/examples/1.9.x/server-rest/examples/sites/list-variables.md index b61dc11f3..ca48b51dc 100644 --- a/examples/1.9.x/server-rest/examples/sites/list-variables.md +++ b/examples/1.9.x/server-rest/examples/sites/list-variables.md @@ -1,7 +1,7 @@ ```http GET /v1/sites/{siteId}/variables HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/list.md b/examples/1.9.x/server-rest/examples/sites/list.md index d4ee10390..c27ebcd65 100644 --- a/examples/1.9.x/server-rest/examples/sites/list.md +++ b/examples/1.9.x/server-rest/examples/sites/list.md @@ -1,7 +1,7 @@ ```http GET /v1/sites HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/sites/update-deployment-status.md b/examples/1.9.x/server-rest/examples/sites/update-deployment-status.md index 809a6db39..25c562a11 100644 --- a/examples/1.9.x/server-rest/examples/sites/update-deployment-status.md +++ b/examples/1.9.x/server-rest/examples/sites/update-deployment-status.md @@ -2,7 +2,7 @@ PATCH /v1/sites/{siteId}/deployments/{deploymentId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/update-site-deployment.md b/examples/1.9.x/server-rest/examples/sites/update-site-deployment.md index 936d3ede7..6e6049cd4 100644 --- a/examples/1.9.x/server-rest/examples/sites/update-site-deployment.md +++ b/examples/1.9.x/server-rest/examples/sites/update-site-deployment.md @@ -2,7 +2,7 @@ PATCH /v1/sites/{siteId}/deployment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/update-variable.md b/examples/1.9.x/server-rest/examples/sites/update-variable.md index c31bd84bc..a075d2527 100644 --- a/examples/1.9.x/server-rest/examples/sites/update-variable.md +++ b/examples/1.9.x/server-rest/examples/sites/update-variable.md @@ -2,7 +2,7 @@ PUT /v1/sites/{siteId}/variables/{variableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/sites/update.md b/examples/1.9.x/server-rest/examples/sites/update.md index 7cf9ed8a0..d8b0934e5 100644 --- a/examples/1.9.x/server-rest/examples/sites/update.md +++ b/examples/1.9.x/server-rest/examples/sites/update.md @@ -2,7 +2,7 @@ PUT /v1/sites/{siteId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/create-bucket.md b/examples/1.9.x/server-rest/examples/storage/create-bucket.md index 0b117fd67..850b2a162 100644 --- a/examples/1.9.x/server-rest/examples/storage/create-bucket.md +++ b/examples/1.9.x/server-rest/examples/storage/create-bucket.md @@ -2,7 +2,7 @@ POST /v1/storage/buckets HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/create-file.md b/examples/1.9.x/server-rest/examples/storage/create-file.md index f5aeb4dce..6e2b8e687 100644 --- a/examples/1.9.x/server-rest/examples/storage/create-file.md +++ b/examples/1.9.x/server-rest/examples/storage/create-file.md @@ -2,7 +2,7 @@ POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/delete-bucket.md b/examples/1.9.x/server-rest/examples/storage/delete-bucket.md index 90eaa172d..f808de8e4 100644 --- a/examples/1.9.x/server-rest/examples/storage/delete-bucket.md +++ b/examples/1.9.x/server-rest/examples/storage/delete-bucket.md @@ -2,7 +2,7 @@ DELETE /v1/storage/buckets/{bucketId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/delete-file.md b/examples/1.9.x/server-rest/examples/storage/delete-file.md index 6aacc94ff..40fd584a1 100644 --- a/examples/1.9.x/server-rest/examples/storage/delete-file.md +++ b/examples/1.9.x/server-rest/examples/storage/delete-file.md @@ -2,7 +2,7 @@ DELETE /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/get-bucket.md b/examples/1.9.x/server-rest/examples/storage/get-bucket.md index e2fbf7a7f..61b6e3ccf 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-bucket.md +++ b/examples/1.9.x/server-rest/examples/storage/get-bucket.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/storage/get-file-download.md b/examples/1.9.x/server-rest/examples/storage/get-file-download.md index 5416bc44b..5effb72e1 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-file-download.md +++ b/examples/1.9.x/server-rest/examples/storage/get-file-download.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/download HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/get-file-preview.md b/examples/1.9.x/server-rest/examples/storage/get-file-preview.md index d58a5be5d..c594cbf5a 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-file-preview.md +++ b/examples/1.9.x/server-rest/examples/storage/get-file-preview.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/preview HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/get-file-view.md b/examples/1.9.x/server-rest/examples/storage/get-file-view.md index 8703118e9..67a9a1608 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-file-view.md +++ b/examples/1.9.x/server-rest/examples/storage/get-file-view.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId}/view HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/get-file.md b/examples/1.9.x/server-rest/examples/storage/get-file.md index 1518f8a5c..cf691ba91 100644 --- a/examples/1.9.x/server-rest/examples/storage/get-file.md +++ b/examples/1.9.x/server-rest/examples/storage/get-file.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/list-buckets.md b/examples/1.9.x/server-rest/examples/storage/list-buckets.md index dfa01c2f5..d209911ef 100644 --- a/examples/1.9.x/server-rest/examples/storage/list-buckets.md +++ b/examples/1.9.x/server-rest/examples/storage/list-buckets.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/storage/list-files.md b/examples/1.9.x/server-rest/examples/storage/list-files.md index f4ce7a08c..2ff558d0d 100644 --- a/examples/1.9.x/server-rest/examples/storage/list-files.md +++ b/examples/1.9.x/server-rest/examples/storage/list-files.md @@ -1,7 +1,7 @@ ```http GET /v1/storage/buckets/{bucketId}/files HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/update-bucket.md b/examples/1.9.x/server-rest/examples/storage/update-bucket.md index 5107ead3d..e1770e42f 100644 --- a/examples/1.9.x/server-rest/examples/storage/update-bucket.md +++ b/examples/1.9.x/server-rest/examples/storage/update-bucket.md @@ -2,7 +2,7 @@ PUT /v1/storage/buckets/{bucketId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/storage/update-file.md b/examples/1.9.x/server-rest/examples/storage/update-file.md index 58b4eaac6..96815f8eb 100644 --- a/examples/1.9.x/server-rest/examples/storage/update-file.md +++ b/examples/1.9.x/server-rest/examples/storage/update-file.md @@ -2,7 +2,7 @@ PUT /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-boolean-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-boolean-column.md index 9c4717b9b..9a2366853 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-boolean-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-boolean-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/boolean HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-datetime-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-datetime-column.md index dd4c534d1..cd80a608b 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-datetime-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-datetime-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/datetime HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-email-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-email-column.md index 5ca6dc632..d608413bc 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-email-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-email-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-enum-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-enum-column.md index a09206499..e0b43e422 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-enum-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-enum-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/enum HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-float-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-float-column.md index 5cc4b0d46..bea4e02ea 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-float-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-float-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/float HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-index.md b/examples/1.9.x/server-rest/examples/tablesdb/create-index.md index 5d9746ccf..ce8d8af32 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-index.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-index.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/indexes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-integer-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-integer-column.md index 9ce8d29b0..52b7b09c9 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-integer-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-integer-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/integer HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-ip-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-ip-column.md index c97835119..bcd86a997 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-ip-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-ip-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/ip HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-line-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-line-column.md index e72daa02f..8aa3384ae 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-line-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-line-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/line HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-longtext-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-longtext-column.md index 4590ed36e..c3788aafc 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-longtext-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-longtext-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/longtext HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-mediumtext-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-mediumtext-column.md index d5298f97c..832e71670 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-mediumtext-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-mediumtext-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/mediumtext HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-operations.md b/examples/1.9.x/server-rest/examples/tablesdb/create-operations.md index 6a045adfc..9f821d471 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-operations.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-operations.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/transactions/{transactionId}/operations HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-point-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-point-column.md index a50291a07..009f32dbc 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-point-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-point-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/point HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-polygon-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-polygon-column.md index 84d9ed4b8..19ff09126 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-polygon-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-polygon-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/polygon HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-relationship-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-relationship-column.md index 471688ade..db098cf0e 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-relationship-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-relationship-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/relationship HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-row.md b/examples/1.9.x/server-rest/examples/tablesdb/create-row.md index 98ec75f1f..e8c1c6cb4 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-row.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/create-rows.md index 8f3fc2753..9e782e631 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-rows.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-string-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-string-column.md index aef15365c..9680ec5f1 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-string-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-string-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/string HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-table.md b/examples/1.9.x/server-rest/examples/tablesdb/create-table.md index ef5c04170..7d3bd63c1 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-table.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-table.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-text-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-text-column.md index 3d3960dbe..02d7ab3f7 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-text-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-text-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/text HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-transaction.md b/examples/1.9.x/server-rest/examples/tablesdb/create-transaction.md index 4506af85d..4b17d3613 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-transaction.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-transaction.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/transactions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-url-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-url-column.md index 19c967d72..4856b3457 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-url-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-url-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/url HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create-varchar-column.md b/examples/1.9.x/server-rest/examples/tablesdb/create-varchar-column.md index 2402dbf9f..91ccbca36 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create-varchar-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create-varchar-column.md @@ -2,7 +2,7 @@ POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/varchar HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/create.md b/examples/1.9.x/server-rest/examples/tablesdb/create.md index e663f80d6..c7f61fa81 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/create.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/create.md @@ -2,7 +2,7 @@ POST /v1/tablesdb HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/decrement-row-column.md b/examples/1.9.x/server-rest/examples/tablesdb/decrement-row-column.md index 8a7f2b760..9708047dc 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/decrement-row-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/decrement-row-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/decrement HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-column.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-column.md index 7e385d825..aaf1aad45 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-column.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/{databaseId}/tables/{tableId}/columns/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-index.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-index.md index 81076633e..2137b957d 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-index.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-index.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/{databaseId}/tables/{tableId}/indexes/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md index d1efa52f3..89637c293 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md index cdd786112..e5332d6ad 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-table.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-table.md index 3b8eeafe7..418e85c91 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-table.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-table.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/{databaseId}/tables/{tableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-transaction.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-transaction.md index 8111a7068..0ce083eed 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-transaction.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-transaction.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete.md b/examples/1.9.x/server-rest/examples/tablesdb/delete.md index 1680e9226..e14d64d70 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete.md @@ -2,7 +2,7 @@ DELETE /v1/tablesdb/{databaseId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-column.md b/examples/1.9.x/server-rest/examples/tablesdb/get-column.md index ddfbf6a28..32a70eba4 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-column.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/columns/{key} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-index.md b/examples/1.9.x/server-rest/examples/tablesdb/get-index.md index a0951d951..ed9c4df95 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-index.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-index.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/indexes/{key} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-row.md b/examples/1.9.x/server-rest/examples/tablesdb/get-row.md index db06ff569..26c63d776 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-row.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-table.md b/examples/1.9.x/server-rest/examples/tablesdb/get-table.md index d54e2b06f..176cacf13 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-table.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-table.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get-transaction.md b/examples/1.9.x/server-rest/examples/tablesdb/get-transaction.md index 3a3e9effc..c300eeb03 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get-transaction.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get-transaction.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/get.md b/examples/1.9.x/server-rest/examples/tablesdb/get.md index c917f943a..4aa1396a1 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/get.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/get.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/increment-row-column.md b/examples/1.9.x/server-rest/examples/tablesdb/increment-row-column.md index c6e533a6f..5f16b4410 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/increment-row-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/increment-row-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId}/{column}/increment HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-columns.md b/examples/1.9.x/server-rest/examples/tablesdb/list-columns.md index 857c6b867..89cf53df1 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-columns.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-columns.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/columns HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-indexes.md b/examples/1.9.x/server-rest/examples/tablesdb/list-indexes.md index f053557de..17f03f2c8 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-indexes.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-indexes.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/indexes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/list-rows.md index 87d2d8425..a3ee4859c 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-rows.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-tables.md b/examples/1.9.x/server-rest/examples/tablesdb/list-tables.md index dc6a07e14..5f6165b87 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-tables.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-tables.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/{databaseId}/tables HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list-transactions.md b/examples/1.9.x/server-rest/examples/tablesdb/list-transactions.md index a79ae9d30..80cc5e74e 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list-transactions.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list-transactions.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb/transactions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/list.md b/examples/1.9.x/server-rest/examples/tablesdb/list.md index 7adc0eed7..9c95ac097 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/list.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/list.md @@ -1,7 +1,7 @@ ```http GET /v1/tablesdb HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-boolean-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-boolean-column.md index 63982bd0a..33d720893 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-boolean-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-boolean-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/boolean/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-datetime-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-datetime-column.md index b070b7361..78522cbf6 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-datetime-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-datetime-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/datetime/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-email-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-email-column.md index 95cecb34c..28fa2b005 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-email-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-email-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/email/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-enum-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-enum-column.md index f5ebe8cce..eb56f1933 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-enum-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-enum-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/enum/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-float-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-float-column.md index 3c9117e39..ed2de581c 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-float-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-float-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/float/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-integer-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-integer-column.md index 1e34677f8..4bc243d6c 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-integer-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-integer-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/integer/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-ip-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-ip-column.md index 7cb3ee150..264aa442c 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-ip-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-ip-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/ip/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-line-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-line-column.md index f71480c34..59e612760 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-line-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-line-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/line/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-longtext-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-longtext-column.md index e5e1177e5..6eee2399f 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-longtext-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-longtext-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/longtext/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-mediumtext-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-mediumtext-column.md index fe995fb32..56a37cac1 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-mediumtext-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-mediumtext-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/mediumtext/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-point-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-point-column.md index 2098a594c..8d13f4857 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-point-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-point-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/point/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-polygon-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-polygon-column.md index d2c837983..b8f96ebeb 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-polygon-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-polygon-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/polygon/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-relationship-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-relationship-column.md index 8eaec7095..547f53323 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-relationship-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-relationship-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/{key}/relationship HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-row.md b/examples/1.9.x/server-rest/examples/tablesdb/update-row.md index f64a0319e..de10c92c2 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-row.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/update-rows.md index 9c2287bb6..6b7c16078 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-rows.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-string-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-string-column.md index e2c4588df..aaf8f14b9 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-string-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-string-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/string/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-table.md b/examples/1.9.x/server-rest/examples/tablesdb/update-table.md index b107fe009..b8ffe194b 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-table.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-table.md @@ -2,7 +2,7 @@ PUT /v1/tablesdb/{databaseId}/tables/{tableId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-text-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-text-column.md index 3b8acc07e..c8c478714 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-text-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-text-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/text/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-transaction.md b/examples/1.9.x/server-rest/examples/tablesdb/update-transaction.md index 16c32bff9..0ec1d6b00 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-transaction.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-transaction.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/transactions/{transactionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: X-Appwrite-Session: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-url-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-url-column.md index 3e6e769ba..129b25e6c 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-url-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-url-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/url/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update-varchar-column.md b/examples/1.9.x/server-rest/examples/tablesdb/update-varchar-column.md index 501dfd0b9..781756fa4 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update-varchar-column.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update-varchar-column.md @@ -2,7 +2,7 @@ PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/varchar/{key} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/update.md b/examples/1.9.x/server-rest/examples/tablesdb/update.md index 50307d150..2d47c983e 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/update.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/update.md @@ -2,7 +2,7 @@ PUT /v1/tablesdb/{databaseId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/upsert-row.md b/examples/1.9.x/server-rest/examples/tablesdb/upsert-row.md index 3d38e6bb5..3063212a2 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/upsert-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/upsert-row.md @@ -2,7 +2,7 @@ PUT /v1/tablesdb/{databaseId}/tables/{tableId}/rows/{rowId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tablesdb/upsert-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/upsert-rows.md index 07c73cfda..85d4d1ab6 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/upsert-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/upsert-rows.md @@ -2,7 +2,7 @@ PUT /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/create-membership.md b/examples/1.9.x/server-rest/examples/teams/create-membership.md index 12997e94f..15ad7537a 100644 --- a/examples/1.9.x/server-rest/examples/teams/create-membership.md +++ b/examples/1.9.x/server-rest/examples/teams/create-membership.md @@ -2,7 +2,7 @@ POST /v1/teams/{teamId}/memberships HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/create.md b/examples/1.9.x/server-rest/examples/teams/create.md index a744da5b4..83d4f0d63 100644 --- a/examples/1.9.x/server-rest/examples/teams/create.md +++ b/examples/1.9.x/server-rest/examples/teams/create.md @@ -2,7 +2,7 @@ POST /v1/teams HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/delete-membership.md b/examples/1.9.x/server-rest/examples/teams/delete-membership.md index ab6b63c64..823701cd3 100644 --- a/examples/1.9.x/server-rest/examples/teams/delete-membership.md +++ b/examples/1.9.x/server-rest/examples/teams/delete-membership.md @@ -2,7 +2,7 @@ DELETE /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/delete.md b/examples/1.9.x/server-rest/examples/teams/delete.md index a82ff80d7..2518c1adc 100644 --- a/examples/1.9.x/server-rest/examples/teams/delete.md +++ b/examples/1.9.x/server-rest/examples/teams/delete.md @@ -2,7 +2,7 @@ DELETE /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/get-membership.md b/examples/1.9.x/server-rest/examples/teams/get-membership.md index 841bf3935..e3b38a677 100644 --- a/examples/1.9.x/server-rest/examples/teams/get-membership.md +++ b/examples/1.9.x/server-rest/examples/teams/get-membership.md @@ -1,7 +1,7 @@ ```http GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/get-prefs.md b/examples/1.9.x/server-rest/examples/teams/get-prefs.md index fa9787ad4..29c800ed9 100644 --- a/examples/1.9.x/server-rest/examples/teams/get-prefs.md +++ b/examples/1.9.x/server-rest/examples/teams/get-prefs.md @@ -1,7 +1,7 @@ ```http GET /v1/teams/{teamId}/prefs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/teams/get.md b/examples/1.9.x/server-rest/examples/teams/get.md index 9ae1f2068..90d28f365 100644 --- a/examples/1.9.x/server-rest/examples/teams/get.md +++ b/examples/1.9.x/server-rest/examples/teams/get.md @@ -1,7 +1,7 @@ ```http GET /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/list-memberships.md b/examples/1.9.x/server-rest/examples/teams/list-memberships.md index 61694bb27..79e90691e 100644 --- a/examples/1.9.x/server-rest/examples/teams/list-memberships.md +++ b/examples/1.9.x/server-rest/examples/teams/list-memberships.md @@ -1,7 +1,7 @@ ```http GET /v1/teams/{teamId}/memberships HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/list.md b/examples/1.9.x/server-rest/examples/teams/list.md index 22f67eee4..0796a81a7 100644 --- a/examples/1.9.x/server-rest/examples/teams/list.md +++ b/examples/1.9.x/server-rest/examples/teams/list.md @@ -1,7 +1,7 @@ ```http GET /v1/teams HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/update-membership-status.md b/examples/1.9.x/server-rest/examples/teams/update-membership-status.md index 87b5ab403..e7e20952c 100644 --- a/examples/1.9.x/server-rest/examples/teams/update-membership-status.md +++ b/examples/1.9.x/server-rest/examples/teams/update-membership-status.md @@ -2,7 +2,7 @@ PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/teams/update-membership.md b/examples/1.9.x/server-rest/examples/teams/update-membership.md index f89e06db1..97f634584 100644 --- a/examples/1.9.x/server-rest/examples/teams/update-membership.md +++ b/examples/1.9.x/server-rest/examples/teams/update-membership.md @@ -2,7 +2,7 @@ PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/update-name.md b/examples/1.9.x/server-rest/examples/teams/update-name.md index 6df37c9fc..7aa88dc40 100644 --- a/examples/1.9.x/server-rest/examples/teams/update-name.md +++ b/examples/1.9.x/server-rest/examples/teams/update-name.md @@ -2,7 +2,7 @@ PUT /v1/teams/{teamId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/teams/update-prefs.md b/examples/1.9.x/server-rest/examples/teams/update-prefs.md index 186eda636..b76054e8f 100644 --- a/examples/1.9.x/server-rest/examples/teams/update-prefs.md +++ b/examples/1.9.x/server-rest/examples/teams/update-prefs.md @@ -2,7 +2,7 @@ PUT /v1/teams/{teamId}/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Session: X-Appwrite-JWT: diff --git a/examples/1.9.x/server-rest/examples/tokens/create-file-token.md b/examples/1.9.x/server-rest/examples/tokens/create-file-token.md index acaa447b1..92a9ba248 100644 --- a/examples/1.9.x/server-rest/examples/tokens/create-file-token.md +++ b/examples/1.9.x/server-rest/examples/tokens/create-file-token.md @@ -2,7 +2,7 @@ POST /v1/tokens/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tokens/delete.md b/examples/1.9.x/server-rest/examples/tokens/delete.md index 9055ed840..35fb1eec0 100644 --- a/examples/1.9.x/server-rest/examples/tokens/delete.md +++ b/examples/1.9.x/server-rest/examples/tokens/delete.md @@ -2,7 +2,7 @@ DELETE /v1/tokens/{tokenId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/tokens/get.md b/examples/1.9.x/server-rest/examples/tokens/get.md index c16142d94..bade4df55 100644 --- a/examples/1.9.x/server-rest/examples/tokens/get.md +++ b/examples/1.9.x/server-rest/examples/tokens/get.md @@ -1,7 +1,7 @@ ```http GET /v1/tokens/{tokenId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tokens/list.md b/examples/1.9.x/server-rest/examples/tokens/list.md index 0d15b0f35..3c2d365ff 100644 --- a/examples/1.9.x/server-rest/examples/tokens/list.md +++ b/examples/1.9.x/server-rest/examples/tokens/list.md @@ -1,7 +1,7 @@ ```http GET /v1/tokens/buckets/{bucketId}/files/{fileId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/tokens/update.md b/examples/1.9.x/server-rest/examples/tokens/update.md index 01bf8e16e..a326e3de1 100644 --- a/examples/1.9.x/server-rest/examples/tokens/update.md +++ b/examples/1.9.x/server-rest/examples/tokens/update.md @@ -2,7 +2,7 @@ PATCH /v1/tokens/{tokenId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-argon-2-user.md b/examples/1.9.x/server-rest/examples/users/create-argon-2-user.md index 3139d4f2f..91732e181 100644 --- a/examples/1.9.x/server-rest/examples/users/create-argon-2-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-argon-2-user.md @@ -2,7 +2,7 @@ POST /v1/users/argon2 HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-bcrypt-user.md b/examples/1.9.x/server-rest/examples/users/create-bcrypt-user.md index 3f9a0896e..7592b3051 100644 --- a/examples/1.9.x/server-rest/examples/users/create-bcrypt-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-bcrypt-user.md @@ -2,7 +2,7 @@ POST /v1/users/bcrypt HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-jwt.md b/examples/1.9.x/server-rest/examples/users/create-jwt.md index 042ef878c..b3af1e73d 100644 --- a/examples/1.9.x/server-rest/examples/users/create-jwt.md +++ b/examples/1.9.x/server-rest/examples/users/create-jwt.md @@ -2,7 +2,7 @@ POST /v1/users/{userId}/jwts HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-md-5-user.md b/examples/1.9.x/server-rest/examples/users/create-md-5-user.md index 2d05063e1..3e13967d6 100644 --- a/examples/1.9.x/server-rest/examples/users/create-md-5-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-md-5-user.md @@ -2,7 +2,7 @@ POST /v1/users/md5 HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/users/create-mfa-recovery-codes.md index dbbce8e5a..056cc1575 100644 --- a/examples/1.9.x/server-rest/examples/users/create-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/users/create-mfa-recovery-codes.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-ph-pass-user.md b/examples/1.9.x/server-rest/examples/users/create-ph-pass-user.md index 7b17aa940..0329a53cc 100644 --- a/examples/1.9.x/server-rest/examples/users/create-ph-pass-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-ph-pass-user.md @@ -2,7 +2,7 @@ POST /v1/users/phpass HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-scrypt-modified-user.md b/examples/1.9.x/server-rest/examples/users/create-scrypt-modified-user.md index 92a9a2348..a206214f2 100644 --- a/examples/1.9.x/server-rest/examples/users/create-scrypt-modified-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-scrypt-modified-user.md @@ -2,7 +2,7 @@ POST /v1/users/scrypt-modified HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-scrypt-user.md b/examples/1.9.x/server-rest/examples/users/create-scrypt-user.md index c7912e9c3..8ebde5170 100644 --- a/examples/1.9.x/server-rest/examples/users/create-scrypt-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-scrypt-user.md @@ -2,7 +2,7 @@ POST /v1/users/scrypt HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-session.md b/examples/1.9.x/server-rest/examples/users/create-session.md index 0d5ebe8d2..d21f2727d 100644 --- a/examples/1.9.x/server-rest/examples/users/create-session.md +++ b/examples/1.9.x/server-rest/examples/users/create-session.md @@ -2,7 +2,7 @@ POST /v1/users/{userId}/sessions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-sha-user.md b/examples/1.9.x/server-rest/examples/users/create-sha-user.md index 9ff8a34f1..5ebfcc8c0 100644 --- a/examples/1.9.x/server-rest/examples/users/create-sha-user.md +++ b/examples/1.9.x/server-rest/examples/users/create-sha-user.md @@ -2,7 +2,7 @@ POST /v1/users/sha HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-target.md b/examples/1.9.x/server-rest/examples/users/create-target.md index a57ffe032..62c8267fa 100644 --- a/examples/1.9.x/server-rest/examples/users/create-target.md +++ b/examples/1.9.x/server-rest/examples/users/create-target.md @@ -2,7 +2,7 @@ POST /v1/users/{userId}/targets HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create-token.md b/examples/1.9.x/server-rest/examples/users/create-token.md index 1e136ee1f..c584c9928 100644 --- a/examples/1.9.x/server-rest/examples/users/create-token.md +++ b/examples/1.9.x/server-rest/examples/users/create-token.md @@ -2,7 +2,7 @@ POST /v1/users/{userId}/tokens HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/create.md b/examples/1.9.x/server-rest/examples/users/create.md index 6ce23f693..01906c88f 100644 --- a/examples/1.9.x/server-rest/examples/users/create.md +++ b/examples/1.9.x/server-rest/examples/users/create.md @@ -2,7 +2,7 @@ POST /v1/users HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/delete-identity.md b/examples/1.9.x/server-rest/examples/users/delete-identity.md index 0262aa0c1..64405b304 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-identity.md +++ b/examples/1.9.x/server-rest/examples/users/delete-identity.md @@ -2,7 +2,7 @@ DELETE /v1/users/identities/{identityId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/delete-mfa-authenticator.md b/examples/1.9.x/server-rest/examples/users/delete-mfa-authenticator.md index 34441dc4b..4b26c602e 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-mfa-authenticator.md +++ b/examples/1.9.x/server-rest/examples/users/delete-mfa-authenticator.md @@ -2,7 +2,7 @@ DELETE /v1/users/{userId}/mfa/authenticators/{type} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/delete-session.md b/examples/1.9.x/server-rest/examples/users/delete-session.md index 292e33a32..36e34bc54 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-session.md +++ b/examples/1.9.x/server-rest/examples/users/delete-session.md @@ -2,7 +2,7 @@ DELETE /v1/users/{userId}/sessions/{sessionId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/delete-sessions.md b/examples/1.9.x/server-rest/examples/users/delete-sessions.md index 7e0800163..2d2498797 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-sessions.md +++ b/examples/1.9.x/server-rest/examples/users/delete-sessions.md @@ -2,7 +2,7 @@ DELETE /v1/users/{userId}/sessions HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/delete-target.md b/examples/1.9.x/server-rest/examples/users/delete-target.md index 4a5c3b25a..c3f4b13d0 100644 --- a/examples/1.9.x/server-rest/examples/users/delete-target.md +++ b/examples/1.9.x/server-rest/examples/users/delete-target.md @@ -2,7 +2,7 @@ DELETE /v1/users/{userId}/targets/{targetId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/delete.md b/examples/1.9.x/server-rest/examples/users/delete.md index b9a6ccd1a..58c63025b 100644 --- a/examples/1.9.x/server-rest/examples/users/delete.md +++ b/examples/1.9.x/server-rest/examples/users/delete.md @@ -2,7 +2,7 @@ DELETE /v1/users/{userId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/get-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/users/get-mfa-recovery-codes.md index ef0389fa8..301a3aa92 100644 --- a/examples/1.9.x/server-rest/examples/users/get-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/users/get-mfa-recovery-codes.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/get-prefs.md b/examples/1.9.x/server-rest/examples/users/get-prefs.md index 106e96e06..03e1c8624 100644 --- a/examples/1.9.x/server-rest/examples/users/get-prefs.md +++ b/examples/1.9.x/server-rest/examples/users/get-prefs.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId}/prefs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/get-target.md b/examples/1.9.x/server-rest/examples/users/get-target.md index 435d7e140..bee3bdb4d 100644 --- a/examples/1.9.x/server-rest/examples/users/get-target.md +++ b/examples/1.9.x/server-rest/examples/users/get-target.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId}/targets/{targetId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/get.md b/examples/1.9.x/server-rest/examples/users/get.md index fd88c7ce9..e7e3683b2 100644 --- a/examples/1.9.x/server-rest/examples/users/get.md +++ b/examples/1.9.x/server-rest/examples/users/get.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-identities.md b/examples/1.9.x/server-rest/examples/users/list-identities.md index a5e20ba2b..4926ac75c 100644 --- a/examples/1.9.x/server-rest/examples/users/list-identities.md +++ b/examples/1.9.x/server-rest/examples/users/list-identities.md @@ -1,7 +1,7 @@ ```http GET /v1/users/identities HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-logs.md b/examples/1.9.x/server-rest/examples/users/list-logs.md index 0536eaba0..899d393b3 100644 --- a/examples/1.9.x/server-rest/examples/users/list-logs.md +++ b/examples/1.9.x/server-rest/examples/users/list-logs.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId}/logs HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-memberships.md b/examples/1.9.x/server-rest/examples/users/list-memberships.md index ad56b0a6a..a3828cb82 100644 --- a/examples/1.9.x/server-rest/examples/users/list-memberships.md +++ b/examples/1.9.x/server-rest/examples/users/list-memberships.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId}/memberships HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-mfa-factors.md b/examples/1.9.x/server-rest/examples/users/list-mfa-factors.md index a0a9e7802..3db4d942f 100644 --- a/examples/1.9.x/server-rest/examples/users/list-mfa-factors.md +++ b/examples/1.9.x/server-rest/examples/users/list-mfa-factors.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId}/mfa/factors HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-sessions.md b/examples/1.9.x/server-rest/examples/users/list-sessions.md index 6bd2a45eb..86161bbb9 100644 --- a/examples/1.9.x/server-rest/examples/users/list-sessions.md +++ b/examples/1.9.x/server-rest/examples/users/list-sessions.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId}/sessions HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/list-targets.md b/examples/1.9.x/server-rest/examples/users/list-targets.md index 06a136cd6..94a54dd35 100644 --- a/examples/1.9.x/server-rest/examples/users/list-targets.md +++ b/examples/1.9.x/server-rest/examples/users/list-targets.md @@ -1,7 +1,7 @@ ```http GET /v1/users/{userId}/targets HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/list.md b/examples/1.9.x/server-rest/examples/users/list.md index 970114f00..7d7638ee2 100644 --- a/examples/1.9.x/server-rest/examples/users/list.md +++ b/examples/1.9.x/server-rest/examples/users/list.md @@ -1,7 +1,7 @@ ```http GET /v1/users HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/users/update-email-verification.md b/examples/1.9.x/server-rest/examples/users/update-email-verification.md index a25e1f470..47c379d08 100644 --- a/examples/1.9.x/server-rest/examples/users/update-email-verification.md +++ b/examples/1.9.x/server-rest/examples/users/update-email-verification.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/verification HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-email.md b/examples/1.9.x/server-rest/examples/users/update-email.md index 06bb97177..7fa87d782 100644 --- a/examples/1.9.x/server-rest/examples/users/update-email.md +++ b/examples/1.9.x/server-rest/examples/users/update-email.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/email HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-impersonator.md b/examples/1.9.x/server-rest/examples/users/update-impersonator.md index c5acf4374..0e20379a4 100644 --- a/examples/1.9.x/server-rest/examples/users/update-impersonator.md +++ b/examples/1.9.x/server-rest/examples/users/update-impersonator.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/impersonator HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-labels.md b/examples/1.9.x/server-rest/examples/users/update-labels.md index 3d32019c5..c070493ee 100644 --- a/examples/1.9.x/server-rest/examples/users/update-labels.md +++ b/examples/1.9.x/server-rest/examples/users/update-labels.md @@ -2,7 +2,7 @@ PUT /v1/users/{userId}/labels HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-mfa-recovery-codes.md b/examples/1.9.x/server-rest/examples/users/update-mfa-recovery-codes.md index 055adcaa4..30281602d 100644 --- a/examples/1.9.x/server-rest/examples/users/update-mfa-recovery-codes.md +++ b/examples/1.9.x/server-rest/examples/users/update-mfa-recovery-codes.md @@ -2,7 +2,7 @@ PUT /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-mfa.md b/examples/1.9.x/server-rest/examples/users/update-mfa.md index bc336e5ff..5b0fea38f 100644 --- a/examples/1.9.x/server-rest/examples/users/update-mfa.md +++ b/examples/1.9.x/server-rest/examples/users/update-mfa.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/mfa HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-name.md b/examples/1.9.x/server-rest/examples/users/update-name.md index cf8f3d643..798772e79 100644 --- a/examples/1.9.x/server-rest/examples/users/update-name.md +++ b/examples/1.9.x/server-rest/examples/users/update-name.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/name HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-password.md b/examples/1.9.x/server-rest/examples/users/update-password.md index 9d8dda447..6c3d1e80b 100644 --- a/examples/1.9.x/server-rest/examples/users/update-password.md +++ b/examples/1.9.x/server-rest/examples/users/update-password.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/password HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-phone-verification.md b/examples/1.9.x/server-rest/examples/users/update-phone-verification.md index d833de59a..3a7ee83dd 100644 --- a/examples/1.9.x/server-rest/examples/users/update-phone-verification.md +++ b/examples/1.9.x/server-rest/examples/users/update-phone-verification.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/verification/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-phone.md b/examples/1.9.x/server-rest/examples/users/update-phone.md index ecf810463..31e8c956f 100644 --- a/examples/1.9.x/server-rest/examples/users/update-phone.md +++ b/examples/1.9.x/server-rest/examples/users/update-phone.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/phone HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-prefs.md b/examples/1.9.x/server-rest/examples/users/update-prefs.md index f7e594cb4..dbf9ad425 100644 --- a/examples/1.9.x/server-rest/examples/users/update-prefs.md +++ b/examples/1.9.x/server-rest/examples/users/update-prefs.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/prefs HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-status.md b/examples/1.9.x/server-rest/examples/users/update-status.md index 018d087ec..777cb71c1 100644 --- a/examples/1.9.x/server-rest/examples/users/update-status.md +++ b/examples/1.9.x/server-rest/examples/users/update-status.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/status HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/users/update-target.md b/examples/1.9.x/server-rest/examples/users/update-target.md index d7c5abdda..5099b1870 100644 --- a/examples/1.9.x/server-rest/examples/users/update-target.md +++ b/examples/1.9.x/server-rest/examples/users/update-target.md @@ -2,7 +2,7 @@ PATCH /v1/users/{userId}/targets/{targetId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/webhooks/create.md b/examples/1.9.x/server-rest/examples/webhooks/create.md index f43134703..05da59095 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/create.md +++ b/examples/1.9.x/server-rest/examples/webhooks/create.md @@ -2,7 +2,7 @@ POST /v1/webhooks HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/webhooks/delete.md b/examples/1.9.x/server-rest/examples/webhooks/delete.md index ccc96616b..b3e10fad7 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/delete.md +++ b/examples/1.9.x/server-rest/examples/webhooks/delete.md @@ -2,7 +2,7 @@ DELETE /v1/webhooks/{webhookId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/webhooks/get.md b/examples/1.9.x/server-rest/examples/webhooks/get.md index 1cd03d11d..faa372ed5 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/get.md +++ b/examples/1.9.x/server-rest/examples/webhooks/get.md @@ -1,7 +1,7 @@ ```http GET /v1/webhooks/{webhookId} HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/webhooks/list.md b/examples/1.9.x/server-rest/examples/webhooks/list.md index af92e3248..9d00520bf 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/list.md +++ b/examples/1.9.x/server-rest/examples/webhooks/list.md @@ -1,7 +1,7 @@ ```http GET /v1/webhooks HTTP/1.1 Host: cloud.appwrite.io -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: ``` diff --git a/examples/1.9.x/server-rest/examples/webhooks/update-secret.md b/examples/1.9.x/server-rest/examples/webhooks/update-secret.md index 2f1b4aae6..51c74113e 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/update-secret.md +++ b/examples/1.9.x/server-rest/examples/webhooks/update-secret.md @@ -2,7 +2,7 @@ PATCH /v1/webhooks/{webhookId}/secret HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-rest/examples/webhooks/update.md b/examples/1.9.x/server-rest/examples/webhooks/update.md index c0a1dddf5..eee73f497 100644 --- a/examples/1.9.x/server-rest/examples/webhooks/update.md +++ b/examples/1.9.x/server-rest/examples/webhooks/update.md @@ -2,7 +2,7 @@ PUT /v1/webhooks/{webhookId} HTTP/1.1 Host: cloud.appwrite.io Content-Type: application/json -X-Appwrite-Response-Format: 1.9.2 +X-Appwrite-Response-Format: 1.9.3 X-Appwrite-Project: X-Appwrite-Key: diff --git a/examples/1.9.x/server-ruby/examples/functions/create.md b/examples/1.9.x/server-ruby/examples/functions/create.md index ee2b47929..6ca65e3fe 100644 --- a/examples/1.9.x/server-ruby/examples/functions/create.md +++ b/examples/1.9.x/server-ruby/examples/functions/create.md @@ -23,7 +23,7 @@ result = functions.create( logging: false, # optional entrypoint: '', # optional commands: '', # optional - scopes: [Scopes::SESSIONS_WRITE], # optional + scopes: [Scopes::PROJECT_READ], # optional installation_id: '', # optional provider_repository_id: '', # optional provider_branch: '', # optional diff --git a/examples/1.9.x/server-ruby/examples/functions/update.md b/examples/1.9.x/server-ruby/examples/functions/update.md index 8e883a543..78c70dff1 100644 --- a/examples/1.9.x/server-ruby/examples/functions/update.md +++ b/examples/1.9.x/server-ruby/examples/functions/update.md @@ -23,7 +23,7 @@ result = functions.update( logging: false, # optional entrypoint: '', # optional commands: '', # optional - scopes: [Scopes::SESSIONS_WRITE], # optional + scopes: [Scopes::PROJECT_READ], # optional installation_id: '', # optional provider_repository_id: '', # optional provider_branch: '', # optional diff --git a/examples/1.9.x/server-ruby/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-ruby/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..362fa4411 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/create-ephemeral-key.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.create_ephemeral_key( + scopes: [Scopes::PROJECT_READ], + duration: 1 +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/create-key.md b/examples/1.9.x/server-ruby/examples/project/create-key.md index 90c15026d..f5f74b70b 100644 --- a/examples/1.9.x/server-ruby/examples/project/create-key.md +++ b/examples/1.9.x/server-ruby/examples/project/create-key.md @@ -14,7 +14,7 @@ project = Project.new(client) result = project.create_key( key_id: '', name: '', - scopes: [Scopes::SESSIONS_WRITE], + scopes: [Scopes::PROJECT_READ], expire: '2020-10-15T06:38:00.000+00:00' # optional ) ``` diff --git a/examples/1.9.x/server-ruby/examples/project/create-mock-phone.md b/examples/1.9.x/server-ruby/examples/project/create-mock-phone.md new file mode 100644 index 000000000..73cb15a44 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/create-mock-phone.md @@ -0,0 +1,17 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.create_mock_phone( + number: '+12065550100', + otp: '' +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/delete-mock-phone.md b/examples/1.9.x/server-ruby/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..1800c0ec6 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/delete-mock-phone.md @@ -0,0 +1,16 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.delete_mock_phone( + number: '+12065550100' +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/delete.md b/examples/1.9.x/server-ruby/examples/project/delete.md new file mode 100644 index 000000000..bc8b3a1a2 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/delete.md @@ -0,0 +1,14 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.delete() +``` diff --git a/examples/1.9.x/server-ruby/examples/project/get-mock-phone.md b/examples/1.9.x/server-ruby/examples/project/get-mock-phone.md new file mode 100644 index 000000000..03ef044ba --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/get-mock-phone.md @@ -0,0 +1,16 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.get_mock_phone( + number: '+12065550100' +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-ruby/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..3a33b91e9 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,16 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.get_o_auth2_provider( + provider: '' +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/get-policy.md b/examples/1.9.x/server-ruby/examples/project/get-policy.md new file mode 100644 index 000000000..3c42248f2 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/get-policy.md @@ -0,0 +1,17 @@ +```ruby +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.get_policy( + policy_id: PolicyId::PASSWORD_DICTIONARY +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/list-email-templates.md b/examples/1.9.x/server-ruby/examples/project/list-email-templates.md new file mode 100644 index 000000000..3286a5db4 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/list-email-templates.md @@ -0,0 +1,17 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.list_email_templates( + queries: [], # optional + total: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/list-mock-phones.md b/examples/1.9.x/server-ruby/examples/project/list-mock-phones.md new file mode 100644 index 000000000..e0f0b35d5 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/list-mock-phones.md @@ -0,0 +1,17 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.list_mock_phones( + queries: [], # optional + total: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-ruby/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..83f52a9a9 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,14 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.list_o_auth2_providers() +``` diff --git a/examples/1.9.x/server-ruby/examples/project/list-policies.md b/examples/1.9.x/server-ruby/examples/project/list-policies.md new file mode 100644 index 000000000..b5ac0bd25 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/list-policies.md @@ -0,0 +1,17 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.list_policies( + queries: [], # optional + total: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-auth-method.md b/examples/1.9.x/server-ruby/examples/project/update-auth-method.md new file mode 100644 index 000000000..5384dfef6 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-auth-method.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_auth_method( + method_id: MethodId::EMAIL_PASSWORD, + enabled: false +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-key.md b/examples/1.9.x/server-ruby/examples/project/update-key.md index 26559101b..9c86320fc 100644 --- a/examples/1.9.x/server-ruby/examples/project/update-key.md +++ b/examples/1.9.x/server-ruby/examples/project/update-key.md @@ -14,7 +14,7 @@ project = Project.new(client) result = project.update_key( key_id: '', name: '', - scopes: [Scopes::SESSIONS_WRITE], + scopes: [Scopes::PROJECT_READ], expire: '2020-10-15T06:38:00.000+00:00' # optional ) ``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-mock-phone.md b/examples/1.9.x/server-ruby/examples/project/update-mock-phone.md new file mode 100644 index 000000000..028cb481f --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-mock-phone.md @@ -0,0 +1,17 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_mock_phone( + number: '+12065550100', + otp: '' +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..29861e692 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_amazon( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..adb2c8d6e --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,20 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_apple( + service_id: '', # optional + key_id: '', # optional + team_id: '', # optional + p8_file: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..e8d11dbf3 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,19 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_auth0( + client_id: '', # optional + client_secret: '', # optional + endpoint: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..d0ec2396d --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,19 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_authentik( + client_id: '', # optional + client_secret: '', # optional + endpoint: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..41e2e475f --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_autodesk( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..46c7e20f4 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_bitbucket( + key: '', # optional + secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..12a8ab63c --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_bitly( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..5d390fead --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-box.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_box( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..7ae5ac7b5 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_dailymotion( + api_key: '', # optional + api_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..01bacd7cb --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_discord( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..38784b107 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_disqus( + public_key: '', # optional + secret_key: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..29247c56d --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_dropbox( + app_key: '', # optional + app_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..e3fdb3882 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_etsy( + key_string: '', # optional + shared_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..474e4b5a6 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_facebook( + app_id: '', # optional + app_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..78ce11092 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_figma( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..5350351e3 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,19 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_fusion_auth( + client_id: '', # optional + client_secret: '', # optional + endpoint: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..e63370f78 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_git_hub( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..6073bc86a --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,19 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_gitlab( + application_id: '', # optional + secret: '', # optional + endpoint: 'https://example.com', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..9cb800798 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-google.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_google( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..63d60d122 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,20 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_keycloak( + client_id: '', # optional + client_secret: '', # optional + endpoint: '', # optional + realm_name: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..4a36804b0 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_kick( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..7a9109cec --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_linkedin( + client_id: '', # optional + primary_client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..0a5563f7a --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,19 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_microsoft( + application_id: '', # optional + application_secret: '', # optional + tenant: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..f679d2872 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_notion( + oauth_client_id: '', # optional + oauth_client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..44e48c726 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,22 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_oidc( + client_id: '', # optional + client_secret: '', # optional + well_known_url: 'https://example.com', # optional + authorization_url: 'https://example.com', # optional + token_url: 'https://example.com', # optional + user_info_url: 'https://example.com', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..a020227c6 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,20 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_okta( + client_id: '', # optional + client_secret: '', # optional + domain: '', # optional + authorization_server_id: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..34a5cbf11 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_paypal_sandbox( + client_id: '', # optional + secret_key: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..054a5c919 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_paypal( + client_id: '', # optional + secret_key: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..5f58dbe8a --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_podio( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..f573693fb --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_salesforce( + customer_key: '', # optional + customer_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..fb5055df9 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_slack( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..fc95bff49 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_spotify( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..21db796dc --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_stripe( + client_id: '', # optional + api_secret_key: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..a79d0a91e --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_tradeshift_sandbox( + oauth2_client_id: '', # optional + oauth2_client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..eb4536caa --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_tradeshift( + oauth2_client_id: '', # optional + oauth2_client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..c110abaf2 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_twitch( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..90da17ab1 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_word_press( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..8e2498a37 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_yahoo( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..73461da23 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_yandex( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..2fbd5fed3 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_zoho( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..c61ddd9b4 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_zoom( + client_id: '', # optional + client_secret: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-ruby/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..3d06d8443 --- /dev/null +++ b/examples/1.9.x/server-ruby/examples/project/update-o-auth-2x.md @@ -0,0 +1,18 @@ +```ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +project = Project.new(client) + +result = project.update_o_auth2_x( + customer_key: '', # optional + secret_key: '', # optional + enabled: false # optional +) +``` diff --git a/examples/1.9.x/server-rust/examples/databases/update-boolean-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-boolean-attribute.md index 3b21d421c..b3477b3a4 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-boolean-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-boolean-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - false, + Some(false), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-datetime-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-datetime-attribute.md index 66d20907c..0f431d17c 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-datetime-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-datetime-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "2020-10-15T06:38:00.000+00:00", + Some("2020-10-15T06:38:00.000+00:00"), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-email-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-email-attribute.md index c4c77f279..417681b39 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-email-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-email-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "email@example.com", + Some("email@example.com"), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-enum-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-enum-attribute.md index 256775565..66d5e718d 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-enum-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-enum-attribute.md @@ -17,7 +17,7 @@ async fn main() -> Result<(), Box> { "", vec![], false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-float-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-float-attribute.md index e36d6cbc9..e63c364ca 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-float-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-float-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - 0, + Some(0), Some(0), // optional Some(0), // optional Some("") // optional diff --git a/examples/1.9.x/server-rust/examples/databases/update-integer-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-integer-attribute.md index f1ff19331..9e6d0bc1f 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-integer-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-integer-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - 0, + Some(0), Some(0), // optional Some(0), // optional Some("") // optional diff --git a/examples/1.9.x/server-rust/examples/databases/update-ip-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-ip-attribute.md index 65e29804b..7f3416ee5 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-ip-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-ip-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-longtext-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-longtext-attribute.md index a5af12040..3936d9058 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-longtext-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-longtext-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-mediumtext-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-mediumtext-attribute.md index 9587103fb..e208ed776 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-mediumtext-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-mediumtext-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-string-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-string-attribute.md index 9fa09d682..d30640a18 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-string-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-string-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some(1), // optional Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-text-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-text-attribute.md index 83a11d3f8..eaf9a1753 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-text-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-text-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-url-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-url-attribute.md index 04992eaab..5d384f560 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-url-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-url-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "https://example.com", + Some("https://example.com"), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/databases/update-varchar-attribute.md b/examples/1.9.x/server-rust/examples/databases/update-varchar-attribute.md index 69e95717d..5ca0b248a 100644 --- a/examples/1.9.x/server-rust/examples/databases/update-varchar-attribute.md +++ b/examples/1.9.x/server-rust/examples/databases/update-varchar-attribute.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some(1), // optional Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/functions/create.md b/examples/1.9.x/server-rust/examples/functions/create.md index 60d584a80..b0b9cad5f 100644 --- a/examples/1.9.x/server-rust/examples/functions/create.md +++ b/examples/1.9.x/server-rust/examples/functions/create.md @@ -23,7 +23,7 @@ async fn main() -> Result<(), Box> { Some(false), // optional Some(""), // optional Some(""), // optional - Some(vec![appwrite::enums::Scopes::SessionsWrite]), // optional + Some(vec![appwrite::enums::Scopes::ProjectRead]), // optional Some(""), // optional Some(""), // optional Some(""), // optional diff --git a/examples/1.9.x/server-rust/examples/functions/update.md b/examples/1.9.x/server-rust/examples/functions/update.md index 110a43321..b49460920 100644 --- a/examples/1.9.x/server-rust/examples/functions/update.md +++ b/examples/1.9.x/server-rust/examples/functions/update.md @@ -23,7 +23,7 @@ async fn main() -> Result<(), Box> { Some(false), // optional Some(""), // optional Some(""), // optional - Some(vec![appwrite::enums::Scopes::SessionsWrite]), // optional + Some(vec![appwrite::enums::Scopes::ProjectRead]), // optional Some(""), // optional Some(""), // optional Some(""), // optional diff --git a/examples/1.9.x/server-rust/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-rust/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..2bbe961d8 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/create-ephemeral-key.md @@ -0,0 +1,23 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.create_ephemeral_key( + vec![appwrite::enums::Scopes::ProjectRead], + 1 + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/create-key.md b/examples/1.9.x/server-rust/examples/project/create-key.md index 0b86a3cc4..7a9f527b1 100644 --- a/examples/1.9.x/server-rust/examples/project/create-key.md +++ b/examples/1.9.x/server-rust/examples/project/create-key.md @@ -14,7 +14,7 @@ async fn main() -> Result<(), Box> { let result = project.create_key( "", "", - vec![appwrite::enums::Scopes::SessionsWrite], + vec![appwrite::enums::Scopes::ProjectRead], Some("2020-10-15T06:38:00.000+00:00") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/project/create-mock-phone.md b/examples/1.9.x/server-rust/examples/project/create-mock-phone.md new file mode 100644 index 000000000..f867b96f6 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/create-mock-phone.md @@ -0,0 +1,23 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.create_mock_phone( + "+12065550100", + "" + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/delete-mock-phone.md b/examples/1.9.x/server-rust/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..f3b8744be --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/delete-mock-phone.md @@ -0,0 +1,20 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + project.delete_mock_phone( + "+12065550100" + ).await?; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/delete.md b/examples/1.9.x/server-rust/examples/project/delete.md new file mode 100644 index 000000000..aef1dcf76 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/delete.md @@ -0,0 +1,18 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + project.delete().await?; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/get-mock-phone.md b/examples/1.9.x/server-rust/examples/project/get-mock-phone.md new file mode 100644 index 000000000..1c44f0729 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/get-mock-phone.md @@ -0,0 +1,22 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.get_mock_phone( + "+12065550100" + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-rust/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..78b563dbd --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,22 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.get_o_auth2_provider( + "" + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/get-policy.md b/examples/1.9.x/server-rust/examples/project/get-policy.md new file mode 100644 index 000000000..efbc3cffc --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/get-policy.md @@ -0,0 +1,22 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.get_policy( + appwrite::enums::PolicyId::PasswordDictionary + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/list-email-templates.md b/examples/1.9.x/server-rust/examples/project/list-email-templates.md new file mode 100644 index 000000000..edbaf99f8 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/list-email-templates.md @@ -0,0 +1,23 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.list_email_templates( + Some(vec![]), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/list-mock-phones.md b/examples/1.9.x/server-rust/examples/project/list-mock-phones.md new file mode 100644 index 000000000..4057971d9 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/list-mock-phones.md @@ -0,0 +1,23 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.list_mock_phones( + Some(vec![]), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-rust/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..d0cf84066 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,20 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.list_o_auth2_providers().await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/list-policies.md b/examples/1.9.x/server-rust/examples/project/list-policies.md new file mode 100644 index 000000000..3abb2ab69 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/list-policies.md @@ -0,0 +1,23 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.list_policies( + Some(vec![]), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-auth-method.md b/examples/1.9.x/server-rust/examples/project/update-auth-method.md new file mode 100644 index 000000000..36f987143 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-auth-method.md @@ -0,0 +1,23 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_auth_method( + appwrite::enums::MethodId::EmailPassword, + false + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-key.md b/examples/1.9.x/server-rust/examples/project/update-key.md index 5ad81642b..38e0a2a4c 100644 --- a/examples/1.9.x/server-rust/examples/project/update-key.md +++ b/examples/1.9.x/server-rust/examples/project/update-key.md @@ -14,7 +14,7 @@ async fn main() -> Result<(), Box> { let result = project.update_key( "", "", - vec![appwrite::enums::Scopes::SessionsWrite], + vec![appwrite::enums::Scopes::ProjectRead], Some("2020-10-15T06:38:00.000+00:00") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/project/update-mock-phone.md b/examples/1.9.x/server-rust/examples/project/update-mock-phone.md new file mode 100644 index 000000000..cd55b55b3 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-mock-phone.md @@ -0,0 +1,23 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_mock_phone( + "+12065550100", + "" + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..4c02d8b5d --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_amazon( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..428de09e8 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,26 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_apple( + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..811a8c8fc --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,25 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_auth0( + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..a4566e112 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,25 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_authentik( + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..62ad0944c --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_autodesk( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..30791180a --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_bitbucket( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..212d49fb2 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_bitly( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..3a463f299 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-box.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_box( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..e46a0f18f --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_dailymotion( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..783c9b8ab --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_discord( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..4476bf26e --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_disqus( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..49458db76 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_dropbox( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..09ab588e5 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_etsy( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..424cdff2a --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_facebook( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..5f5a34916 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_figma( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..e1a73144c --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,25 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_fusion_auth( + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..be26e71dd --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_git_hub( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..23fab7e4e --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,25 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_gitlab( + Some(""), // optional + Some(""), // optional + Some("https://example.com"), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..80b81942e --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-google.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_google( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..89ae292af --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,26 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_keycloak( + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..56aedb478 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_kick( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..8f864a3f0 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_linkedin( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..f32216e4b --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,25 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_microsoft( + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..84642ef72 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_notion( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..f37d38775 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,28 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_oidc( + Some(""), // optional + Some(""), // optional + Some("https://example.com"), // optional + Some("https://example.com"), // optional + Some("https://example.com"), // optional + Some("https://example.com"), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..b180d2bfa --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,26 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_okta( + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..a260d7d9e --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_paypal_sandbox( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..8a296877a --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_paypal( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..141c517ba --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_podio( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..dd41c0a9b --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_salesforce( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..60fa98300 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_slack( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..ac7af69db --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_spotify( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..993f2164c --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_stripe( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..5804af8fa --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_tradeshift_sandbox( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..37bc1145f --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_tradeshift( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..e238d7630 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_twitch( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..808c156a6 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_word_press( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..c75ae753a --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_yahoo( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..b5b82d3a1 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_yandex( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..62ac858e2 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_zoho( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..225ed8773 --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_zoom( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-rust/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..b8c02abdf --- /dev/null +++ b/examples/1.9.x/server-rust/examples/project/update-o-auth-2x.md @@ -0,0 +1,24 @@ +```rust +use appwrite::Client; +use appwrite::services::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new(); + client.set_endpoint("https://.cloud.appwrite.io/v1"); // Your API Endpoint + client.set_project(""); // Your project ID + client.set_key(""); // Your secret API key + + let project = Project::new(&client); + + let result = project.update_o_auth2_x( + Some(""), // optional + Some(""), // optional + Some(false) // optional + ).await?; + + let _ = result; + + Ok(()) +} +``` diff --git a/examples/1.9.x/server-rust/examples/project/update-password-history-policy.md b/examples/1.9.x/server-rust/examples/project/update-password-history-policy.md index c45e8a8ef..1b884806d 100644 --- a/examples/1.9.x/server-rust/examples/project/update-password-history-policy.md +++ b/examples/1.9.x/server-rust/examples/project/update-password-history-policy.md @@ -12,7 +12,7 @@ async fn main() -> Result<(), Box> { let project = Project::new(&client); let result = project.update_password_history_policy( - 1 + Some(1) ).await?; let _ = result; diff --git a/examples/1.9.x/server-rust/examples/project/update-session-limit-policy.md b/examples/1.9.x/server-rust/examples/project/update-session-limit-policy.md index fd958cf0a..c4e9aa988 100644 --- a/examples/1.9.x/server-rust/examples/project/update-session-limit-policy.md +++ b/examples/1.9.x/server-rust/examples/project/update-session-limit-policy.md @@ -12,7 +12,7 @@ async fn main() -> Result<(), Box> { let project = Project::new(&client); let result = project.update_session_limit_policy( - 1 + Some(1) ).await?; let _ = result; diff --git a/examples/1.9.x/server-rust/examples/project/update-user-limit-policy.md b/examples/1.9.x/server-rust/examples/project/update-user-limit-policy.md index dd679d485..2b2d999b2 100644 --- a/examples/1.9.x/server-rust/examples/project/update-user-limit-policy.md +++ b/examples/1.9.x/server-rust/examples/project/update-user-limit-policy.md @@ -12,7 +12,7 @@ async fn main() -> Result<(), Box> { let project = Project::new(&client); let result = project.update_user_limit_policy( - 1 + Some(1) ).await?; let _ = result; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-boolean-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-boolean-column.md index 88e675594..a7a871aa3 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-boolean-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-boolean-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - false, + Some(false), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-datetime-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-datetime-column.md index 56dbd2fc7..6200842ae 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-datetime-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-datetime-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "2020-10-15T06:38:00.000+00:00", + Some("2020-10-15T06:38:00.000+00:00"), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-email-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-email-column.md index 669eae01c..e19b352d2 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-email-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-email-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "email@example.com", + Some("email@example.com"), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-enum-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-enum-column.md index 78faa5beb..d0de7b0f8 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-enum-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-enum-column.md @@ -17,7 +17,7 @@ async fn main() -> Result<(), Box> { "", vec![], false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-float-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-float-column.md index 5bfc2729c..77ee53201 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-float-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-float-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - 0, + Some(0), Some(0), // optional Some(0), // optional Some("") // optional diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-integer-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-integer-column.md index 42b33f75a..a290193bb 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-integer-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-integer-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - 0, + Some(0), Some(0), // optional Some(0), // optional Some("") // optional diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-ip-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-ip-column.md index dc88ba603..d20dc4779 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-ip-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-ip-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-longtext-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-longtext-column.md index 0bf4ba12a..e7867b182 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-longtext-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-longtext-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-mediumtext-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-mediumtext-column.md index 73498643f..df7813f39 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-mediumtext-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-mediumtext-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-string-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-string-column.md index cdedb15f3..0bdf03a73 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-string-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-string-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some(1), // optional Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-text-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-text-column.md index fa8126ac5..8b29968e2 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-text-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-text-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-url-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-url-column.md index 0baa59cc2..853a5ec9e 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-url-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-url-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "https://example.com", + Some("https://example.com"), Some("") // optional ).await?; diff --git a/examples/1.9.x/server-rust/examples/tablesdb/update-varchar-column.md b/examples/1.9.x/server-rust/examples/tablesdb/update-varchar-column.md index 521389803..ff3a27f2f 100644 --- a/examples/1.9.x/server-rust/examples/tablesdb/update-varchar-column.md +++ b/examples/1.9.x/server-rust/examples/tablesdb/update-varchar-column.md @@ -16,7 +16,7 @@ async fn main() -> Result<(), Box> { "", "", false, - "", + Some(""), Some(1), // optional Some("") // optional ).await?; diff --git a/examples/1.9.x/server-swift/examples/functions/create.md b/examples/1.9.x/server-swift/examples/functions/create.md index f64aad770..e7eb83b69 100644 --- a/examples/1.9.x/server-swift/examples/functions/create.md +++ b/examples/1.9.x/server-swift/examples/functions/create.md @@ -21,7 +21,7 @@ let function = try await functions.create( logging: false, // optional entrypoint: "", // optional commands: "", // optional - scopes: [.sessionsWrite], // optional + scopes: [.projectRead], // optional installationId: "", // optional providerRepositoryId: "", // optional providerBranch: "", // optional diff --git a/examples/1.9.x/server-swift/examples/functions/update.md b/examples/1.9.x/server-swift/examples/functions/update.md index 69d2f2bff..be3bce626 100644 --- a/examples/1.9.x/server-swift/examples/functions/update.md +++ b/examples/1.9.x/server-swift/examples/functions/update.md @@ -21,7 +21,7 @@ let function = try await functions.update( logging: false, // optional entrypoint: "", // optional commands: "", // optional - scopes: [.sessionsWrite], // optional + scopes: [.projectRead], // optional installationId: "", // optional providerRepositoryId: "", // optional providerBranch: "", // optional diff --git a/examples/1.9.x/server-swift/examples/project/create-ephemeral-key.md b/examples/1.9.x/server-swift/examples/project/create-ephemeral-key.md new file mode 100644 index 000000000..2d0098f36 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/create-ephemeral-key.md @@ -0,0 +1,17 @@ +```swift +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let ephemeralKey = try await project.createEphemeralKey( + scopes: [.projectRead], + duration: 1 +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/create-key.md b/examples/1.9.x/server-swift/examples/project/create-key.md index f2361de54..fac75eaa2 100644 --- a/examples/1.9.x/server-swift/examples/project/create-key.md +++ b/examples/1.9.x/server-swift/examples/project/create-key.md @@ -12,7 +12,7 @@ let project = Project(client) let key = try await project.createKey( keyId: "", name: "", - scopes: [.sessionsWrite], + scopes: [.projectRead], expire: "2020-10-15T06:38:00.000+00:00" // optional ) diff --git a/examples/1.9.x/server-swift/examples/project/create-mock-phone.md b/examples/1.9.x/server-swift/examples/project/create-mock-phone.md new file mode 100644 index 000000000..d55045e52 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/create-mock-phone.md @@ -0,0 +1,16 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let mockNumber = try await project.createMockPhone( + number: "+12065550100", + otp: "" +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/delete-mock-phone.md b/examples/1.9.x/server-swift/examples/project/delete-mock-phone.md new file mode 100644 index 000000000..b7276924a --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/delete-mock-phone.md @@ -0,0 +1,15 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let result = try await project.deleteMockPhone( + number: "+12065550100" +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/delete.md b/examples/1.9.x/server-swift/examples/project/delete.md new file mode 100644 index 000000000..e21a359a3 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/delete.md @@ -0,0 +1,13 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let result = try await project.delete() + +``` diff --git a/examples/1.9.x/server-swift/examples/project/get-mock-phone.md b/examples/1.9.x/server-swift/examples/project/get-mock-phone.md new file mode 100644 index 000000000..c37f50f95 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/get-mock-phone.md @@ -0,0 +1,15 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let mockNumber = try await project.getMockPhone( + number: "+12065550100" +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/get-o-auth-2-provider.md b/examples/1.9.x/server-swift/examples/project/get-o-auth-2-provider.md new file mode 100644 index 000000000..5fa49c1a2 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/get-o-auth-2-provider.md @@ -0,0 +1,15 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let result = try await project.getOAuth2Provider( + provider: "" +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/get-policy.md b/examples/1.9.x/server-swift/examples/project/get-policy.md new file mode 100644 index 000000000..56a46ff13 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/get-policy.md @@ -0,0 +1,16 @@ +```swift +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let result = try await project.getPolicy( + policyId: .passwordDictionary +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/list-email-templates.md b/examples/1.9.x/server-swift/examples/project/list-email-templates.md new file mode 100644 index 000000000..e135eb231 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/list-email-templates.md @@ -0,0 +1,16 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let emailTemplateList = try await project.listEmailTemplates( + queries: [], // optional + total: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/list-mock-phones.md b/examples/1.9.x/server-swift/examples/project/list-mock-phones.md new file mode 100644 index 000000000..5a1119297 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/list-mock-phones.md @@ -0,0 +1,16 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let mockNumberList = try await project.listMockPhones( + queries: [], // optional + total: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/list-o-auth-2-providers.md b/examples/1.9.x/server-swift/examples/project/list-o-auth-2-providers.md new file mode 100644 index 000000000..6b250a915 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/list-o-auth-2-providers.md @@ -0,0 +1,13 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2ProviderList = try await project.listOAuth2Providers() + +``` diff --git a/examples/1.9.x/server-swift/examples/project/list-policies.md b/examples/1.9.x/server-swift/examples/project/list-policies.md new file mode 100644 index 000000000..5dd4fc41c --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/list-policies.md @@ -0,0 +1,16 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let policyList = try await project.listPolicies( + queries: [], // optional + total: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-auth-method.md b/examples/1.9.x/server-swift/examples/project/update-auth-method.md new file mode 100644 index 000000000..1512ab09b --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-auth-method.md @@ -0,0 +1,17 @@ +```swift +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let project = try await project.updateAuthMethod( + methodId: .emailPassword, + enabled: false +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-key.md b/examples/1.9.x/server-swift/examples/project/update-key.md index 9e361c791..b94b74f13 100644 --- a/examples/1.9.x/server-swift/examples/project/update-key.md +++ b/examples/1.9.x/server-swift/examples/project/update-key.md @@ -12,7 +12,7 @@ let project = Project(client) let key = try await project.updateKey( keyId: "", name: "", - scopes: [.sessionsWrite], + scopes: [.projectRead], expire: "2020-10-15T06:38:00.000+00:00" // optional ) diff --git a/examples/1.9.x/server-swift/examples/project/update-mock-phone.md b/examples/1.9.x/server-swift/examples/project/update-mock-phone.md new file mode 100644 index 000000000..4181189b3 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-mock-phone.md @@ -0,0 +1,16 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let mockNumber = try await project.updateMockPhone( + number: "+12065550100", + otp: "" +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-amazon.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-amazon.md new file mode 100644 index 000000000..729f57b2e --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-amazon.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Amazon = try await project.updateOAuth2Amazon( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-apple.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-apple.md new file mode 100644 index 000000000..9a5e4a23f --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-apple.md @@ -0,0 +1,19 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Apple = try await project.updateOAuth2Apple( + serviceId: "", // optional + keyId: "", // optional + teamId: "", // optional + p8File: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-auth-0.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-auth-0.md new file mode 100644 index 000000000..32fa12df4 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-auth-0.md @@ -0,0 +1,18 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Auth0 = try await project.updateOAuth2Auth0( + clientId: "", // optional + clientSecret: "", // optional + endpoint: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-authentik.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-authentik.md new file mode 100644 index 000000000..e627e0e36 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-authentik.md @@ -0,0 +1,18 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Authentik = try await project.updateOAuth2Authentik( + clientId: "", // optional + clientSecret: "", // optional + endpoint: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-autodesk.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-autodesk.md new file mode 100644 index 000000000..a20dc1a0b --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-autodesk.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Autodesk = try await project.updateOAuth2Autodesk( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-bitbucket.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-bitbucket.md new file mode 100644 index 000000000..d147529b3 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-bitbucket.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Bitbucket = try await project.updateOAuth2Bitbucket( + key: "", // optional + secret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-bitly.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-bitly.md new file mode 100644 index 000000000..5d4e87c98 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-bitly.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Bitly = try await project.updateOAuth2Bitly( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-box.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-box.md new file mode 100644 index 000000000..9a11d94d3 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-box.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Box = try await project.updateOAuth2Box( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-dailymotion.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-dailymotion.md new file mode 100644 index 000000000..598ae75eb --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-dailymotion.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Dailymotion = try await project.updateOAuth2Dailymotion( + apiKey: "", // optional + apiSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-discord.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-discord.md new file mode 100644 index 000000000..bdab08003 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-discord.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Discord = try await project.updateOAuth2Discord( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-disqus.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-disqus.md new file mode 100644 index 000000000..ec7f71955 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-disqus.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Disqus = try await project.updateOAuth2Disqus( + publicKey: "", // optional + secretKey: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-dropbox.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-dropbox.md new file mode 100644 index 000000000..81a1fde31 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-dropbox.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Dropbox = try await project.updateOAuth2Dropbox( + appKey: "", // optional + appSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-etsy.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-etsy.md new file mode 100644 index 000000000..252eb52eb --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-etsy.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Etsy = try await project.updateOAuth2Etsy( + keyString: "", // optional + sharedSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-facebook.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-facebook.md new file mode 100644 index 000000000..b2775c8af --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-facebook.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Facebook = try await project.updateOAuth2Facebook( + appId: "", // optional + appSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-figma.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-figma.md new file mode 100644 index 000000000..a29c713d1 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-figma.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Figma = try await project.updateOAuth2Figma( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-fusion-auth.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-fusion-auth.md new file mode 100644 index 000000000..64adf24f5 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-fusion-auth.md @@ -0,0 +1,18 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2FusionAuth = try await project.updateOAuth2FusionAuth( + clientId: "", // optional + clientSecret: "", // optional + endpoint: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-git-hub.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-git-hub.md new file mode 100644 index 000000000..3a31b270c --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-git-hub.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Github = try await project.updateOAuth2GitHub( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-gitlab.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-gitlab.md new file mode 100644 index 000000000..35fd4da04 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-gitlab.md @@ -0,0 +1,18 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Gitlab = try await project.updateOAuth2Gitlab( + applicationId: "", // optional + secret: "", // optional + endpoint: "https://example.com", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-google.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-google.md new file mode 100644 index 000000000..16d5170c5 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-google.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Google = try await project.updateOAuth2Google( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-keycloak.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-keycloak.md new file mode 100644 index 000000000..90f37c1c1 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-keycloak.md @@ -0,0 +1,19 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Keycloak = try await project.updateOAuth2Keycloak( + clientId: "", // optional + clientSecret: "", // optional + endpoint: "", // optional + realmName: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-kick.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-kick.md new file mode 100644 index 000000000..091f4651e --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-kick.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Kick = try await project.updateOAuth2Kick( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-linkedin.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-linkedin.md new file mode 100644 index 000000000..5045d05aa --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-linkedin.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Linkedin = try await project.updateOAuth2Linkedin( + clientId: "", // optional + primaryClientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-microsoft.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-microsoft.md new file mode 100644 index 000000000..1ec4428ba --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-microsoft.md @@ -0,0 +1,18 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Microsoft = try await project.updateOAuth2Microsoft( + applicationId: "", // optional + applicationSecret: "", // optional + tenant: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-notion.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-notion.md new file mode 100644 index 000000000..531a55591 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-notion.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Notion = try await project.updateOAuth2Notion( + oauthClientId: "", // optional + oauthClientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-oidc.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-oidc.md new file mode 100644 index 000000000..d991c1e2b --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-oidc.md @@ -0,0 +1,21 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Oidc = try await project.updateOAuth2Oidc( + clientId: "", // optional + clientSecret: "", // optional + wellKnownURL: "https://example.com", // optional + authorizationURL: "https://example.com", // optional + tokenUrl: "https://example.com", // optional + userInfoUrl: "https://example.com", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-okta.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-okta.md new file mode 100644 index 000000000..5ee9fb6de --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-okta.md @@ -0,0 +1,19 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Okta = try await project.updateOAuth2Okta( + clientId: "", // optional + clientSecret: "", // optional + domain: "", // optional + authorizationServerId: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-paypal-sandbox.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-paypal-sandbox.md new file mode 100644 index 000000000..148ac7c30 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-paypal-sandbox.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Paypal = try await project.updateOAuth2PaypalSandbox( + clientId: "", // optional + secretKey: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-paypal.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-paypal.md new file mode 100644 index 000000000..893314fb9 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-paypal.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Paypal = try await project.updateOAuth2Paypal( + clientId: "", // optional + secretKey: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-podio.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-podio.md new file mode 100644 index 000000000..489d1b47a --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-podio.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Podio = try await project.updateOAuth2Podio( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-salesforce.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-salesforce.md new file mode 100644 index 000000000..65eb7468b --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-salesforce.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Salesforce = try await project.updateOAuth2Salesforce( + customerKey: "", // optional + customerSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-slack.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-slack.md new file mode 100644 index 000000000..b60e30216 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-slack.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Slack = try await project.updateOAuth2Slack( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-spotify.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-spotify.md new file mode 100644 index 000000000..6d7570eec --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-spotify.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Spotify = try await project.updateOAuth2Spotify( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-stripe.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-stripe.md new file mode 100644 index 000000000..a600e6f99 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-stripe.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Stripe = try await project.updateOAuth2Stripe( + clientId: "", // optional + apiSecretKey: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-tradeshift-sandbox.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-tradeshift-sandbox.md new file mode 100644 index 000000000..bbfad0edf --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-tradeshift-sandbox.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Tradeshift = try await project.updateOAuth2TradeshiftSandbox( + oauth2ClientId: "", // optional + oauth2ClientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-tradeshift.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-tradeshift.md new file mode 100644 index 000000000..83f93be73 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-tradeshift.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Tradeshift = try await project.updateOAuth2Tradeshift( + oauth2ClientId: "", // optional + oauth2ClientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-twitch.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-twitch.md new file mode 100644 index 000000000..b2bcda440 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-twitch.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Twitch = try await project.updateOAuth2Twitch( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-word-press.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-word-press.md new file mode 100644 index 000000000..0025d2e5c --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-word-press.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2WordPress = try await project.updateOAuth2WordPress( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-yahoo.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-yahoo.md new file mode 100644 index 000000000..dd6bb966f --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-yahoo.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Yahoo = try await project.updateOAuth2Yahoo( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-yandex.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-yandex.md new file mode 100644 index 000000000..0aa910d35 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-yandex.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Yandex = try await project.updateOAuth2Yandex( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-zoho.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-zoho.md new file mode 100644 index 000000000..db4f04043 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-zoho.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Zoho = try await project.updateOAuth2Zoho( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2-zoom.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-zoom.md new file mode 100644 index 000000000..2adc273c8 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2-zoom.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2Zoom = try await project.updateOAuth2Zoom( + clientId: "", // optional + clientSecret: "", // optional + enabled: false // optional +) + +``` diff --git a/examples/1.9.x/server-swift/examples/project/update-o-auth-2x.md b/examples/1.9.x/server-swift/examples/project/update-o-auth-2x.md new file mode 100644 index 000000000..e04f13b25 --- /dev/null +++ b/examples/1.9.x/server-swift/examples/project/update-o-auth-2x.md @@ -0,0 +1,17 @@ +```swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint + .setProject("") // Your project ID + .setKey("") // Your secret API key + +let project = Project(client) + +let oAuth2X = try await project.updateOAuth2X( + customerKey: "", // optional + secretKey: "", // optional + enabled: false // optional +) + +``` diff --git a/specs/1.9.x/open-api3-1.9.x-client.json b/specs/1.9.x/open-api3-1.9.x-client.json index 183b351c9..636b73fed 100644 --- a/specs/1.9.x/open-api3-1.9.x-client.json +++ b/specs/1.9.x/open-api3-1.9.x-client.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.9.2", + "version": "1.9.3", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -555,7 +555,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 187, + "weight": 166, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -627,7 +627,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 189, + "weight": 168, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -751,7 +751,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 190, + "weight": 169, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -891,7 +891,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 191, + "weight": 170, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1015,7 +1015,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 195, + "weight": 174, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1149,7 +1149,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 196, + "weight": 175, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1287,7 +1287,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 188, + "weight": 167, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1388,7 +1388,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 194, + "weight": 173, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1487,7 +1487,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 192, + "weight": 171, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1586,7 +1586,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 193, + "weight": 172, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2540,7 +2540,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -2561,9 +2561,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -3473,7 +3476,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -3494,9 +3497,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -4053,7 +4059,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 198, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4181,7 +4187,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 197, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4315,7 +4321,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 201, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4375,7 +4381,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 199, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4865,7 +4871,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 200, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4949,7 +4955,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 203, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5043,7 +5049,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 202, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5137,7 +5143,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 204, + "weight": 183, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5890,7 +5896,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 703, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -5957,7 +5963,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 699, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6028,7 +6034,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 700, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6092,7 +6098,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 701, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6170,7 +6176,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 702, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6236,7 +6242,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 704, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6321,7 +6327,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 654, + "weight": 897, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6445,7 +6451,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 646, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6606,7 +6612,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 647, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6717,7 +6723,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 650, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6872,7 +6878,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 648, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -6984,7 +6990,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 652, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7091,7 +7097,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 657, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7220,7 +7226,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 656, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7349,7 +7355,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 810, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -7416,7 +7422,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 806, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -7487,7 +7493,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 807, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -7551,7 +7557,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 808, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -7629,7 +7635,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 809, + "weight": 861, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -7695,7 +7701,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 811, + "weight": 863, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -7779,7 +7785,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 803, + "weight": 898, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -7899,7 +7905,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 795, + "weight": 847, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -8076,7 +8082,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 796, + "weight": 848, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -8183,7 +8189,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 799, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -8328,7 +8334,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 797, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -8434,7 +8440,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 801, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -8536,7 +8542,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 805, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -8659,7 +8665,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 804, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -8782,14 +8788,17 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 453, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-executions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -8869,14 +8878,17 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 451, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/create-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "client", @@ -8987,14 +8999,17 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 452, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/get-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -9062,7 +9077,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 122, + "weight": 117, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -9116,7 +9131,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 121, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -9602,7 +9617,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 171, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -9686,7 +9701,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 175, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -9762,7 +9777,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 563, + "weight": 544, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -9861,7 +9876,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 1073, + "weight": 1186, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -9963,7 +9978,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 562, + "weight": 543, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -10037,7 +10052,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 564, + "weight": 545, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -10129,7 +10144,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 565, + "weight": 546, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -10198,7 +10213,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 567, + "weight": 548, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -10278,7 +10293,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 566, + "weight": 547, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -10508,7 +10523,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 568, + "weight": 549, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -10595,7 +10610,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 776, + "weight": 828, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -10665,7 +10680,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 772, + "weight": 824, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -10739,7 +10754,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 773, + "weight": 825, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -10806,7 +10821,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 774, + "weight": 826, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -10887,7 +10902,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 775, + "weight": 827, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -10956,7 +10971,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 777, + "weight": 829, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -11044,7 +11059,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 768, + "weight": 899, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -11167,7 +11182,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 760, + "weight": 812, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -11323,7 +11338,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 761, + "weight": 813, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -11433,7 +11448,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 764, + "weight": 816, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -11583,7 +11598,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 762, + "weight": 814, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -11694,7 +11709,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 766, + "weight": 818, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -11800,7 +11815,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 771, + "weight": 823, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -11928,7 +11943,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 770, + "weight": 822, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -12056,7 +12071,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 539, + "weight": 520, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -12145,7 +12160,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 537, + "weight": 518, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -12232,7 +12247,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 538, + "weight": 519, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -12296,7 +12311,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 541, + "weight": 522, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -12372,7 +12387,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 540, + "weight": 521, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -12438,7 +12453,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 546, + "weight": 527, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -12537,7 +12552,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 544, + "weight": 525, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -12653,7 +12668,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 545, + "weight": 526, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -12727,7 +12742,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 547, + "weight": 528, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -12816,7 +12831,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 1074, + "weight": 1187, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -12892,7 +12907,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 549, + "weight": 530, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -12992,7 +13007,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 542, + "weight": 523, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -13055,7 +13070,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 543, + "weight": 524, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -13139,7 +13154,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 843, + "weight": 895, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -13206,7 +13221,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 839, + "weight": 891, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -13277,7 +13292,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 840, + "weight": 892, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -13341,7 +13356,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 841, + "weight": 893, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -13419,7 +13434,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 842, + "weight": 894, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -13485,7 +13500,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 844, + "weight": 896, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -13570,7 +13585,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 833, + "weight": 885, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -13690,7 +13705,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 829, + "weight": 881, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -13840,7 +13855,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 832, + "weight": 884, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -13947,7 +13962,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 831, + "weight": 883, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -14092,7 +14107,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 830, + "weight": 882, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -14198,7 +14213,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 834, + "weight": 886, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", diff --git a/specs/1.9.x/open-api3-1.9.x-console.json b/specs/1.9.x/open-api3-1.9.x-console.json index de4045df5..6cadd0898 100644 --- a/specs/1.9.x/open-api3-1.9.x-console.json +++ b/specs/1.9.x/open-api3-1.9.x-console.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.9.2", + "version": "1.9.3", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -227,7 +227,7 @@ "x-appwrite": { "method": "listBillingAddresses", "group": null, - "weight": 1017, + "weight": 1075, "cookies": false, "type": "", "demo": "account\/list-billing-addresses.md", @@ -289,7 +289,7 @@ "x-appwrite": { "method": "createBillingAddress", "group": null, - "weight": 1015, + "weight": 1073, "cookies": false, "type": "", "demo": "account\/create-billing-address.md", @@ -384,7 +384,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 1016, + "weight": 1074, "cookies": false, "type": "", "demo": "account\/get-billing-address.md", @@ -443,7 +443,7 @@ "x-appwrite": { "method": "updateBillingAddress", "group": null, - "weight": 1018, + "weight": 1076, "cookies": false, "type": "", "demo": "account\/update-billing-address.md", @@ -541,7 +541,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 1019, + "weight": 1077, "cookies": false, "type": "", "demo": "account\/delete-billing-address.md", @@ -602,7 +602,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 1021, + "weight": 1079, "cookies": false, "type": "", "demo": "account\/get-coupon.md", @@ -877,7 +877,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 1020, + "weight": 1078, "cookies": false, "type": "", "demo": "account\/list-invoices.md", @@ -1010,7 +1010,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1003, + "weight": 1061, "cookies": false, "type": "", "demo": "account\/list-keys.md", @@ -1069,7 +1069,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1004, + "weight": 1062, "cookies": false, "type": "", "demo": "account\/create-key.md", @@ -1159,7 +1159,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1007, + "weight": 1065, "cookies": false, "type": "", "demo": "account\/get-key.md", @@ -1217,7 +1217,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1006, + "weight": 1064, "cookies": false, "type": "", "demo": "account\/update-key.md", @@ -1310,7 +1310,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1005, + "weight": 1063, "cookies": false, "type": "", "demo": "account\/delete-key.md", @@ -1448,7 +1448,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 187, + "weight": 166, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -1519,7 +1519,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 189, + "weight": 168, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -1642,7 +1642,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 190, + "weight": 169, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -1781,7 +1781,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 191, + "weight": 170, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1904,7 +1904,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 195, + "weight": 174, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -2037,7 +2037,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 196, + "weight": 175, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -2174,7 +2174,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 188, + "weight": 167, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -2274,7 +2274,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 194, + "weight": 173, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -2372,7 +2372,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 192, + "weight": 171, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -2470,7 +2470,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 193, + "weight": 172, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2718,7 +2718,7 @@ "x-appwrite": { "method": "listPaymentMethods", "group": null, - "weight": 1010, + "weight": 1068, "cookies": false, "type": "", "demo": "account\/list-payment-methods.md", @@ -2780,7 +2780,7 @@ "x-appwrite": { "method": "createPaymentMethod", "group": null, - "weight": 1008, + "weight": 1066, "cookies": false, "type": "", "demo": "account\/create-payment-method.md", @@ -2829,7 +2829,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 1009, + "weight": 1067, "cookies": false, "type": "", "demo": "account\/get-payment-method.md", @@ -2888,7 +2888,7 @@ "x-appwrite": { "method": "updatePaymentMethod", "group": null, - "weight": 1011, + "weight": 1069, "cookies": false, "type": "", "demo": "account\/update-payment-method.md", @@ -2972,7 +2972,7 @@ "x-appwrite": { "method": "deletePaymentMethod", "group": null, - "weight": 1014, + "weight": 1072, "cookies": false, "type": "", "demo": "account\/delete-payment-method.md", @@ -3033,7 +3033,7 @@ "x-appwrite": { "method": "updatePaymentMethodProvider", "group": null, - "weight": 1012, + "weight": 1070, "cookies": false, "type": "", "demo": "account\/update-payment-method-provider.md", @@ -3125,7 +3125,7 @@ "x-appwrite": { "method": "updatePaymentMethodMandateOptions", "group": null, - "weight": 1013, + "weight": 1071, "cookies": false, "type": "", "demo": "account\/update-payment-method-mandate-options.md", @@ -3878,7 +3878,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -3899,9 +3899,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -4799,7 +4802,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -4820,9 +4823,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -5381,7 +5387,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 1071, + "weight": 1184, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -5444,7 +5450,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 1072, + "weight": 1185, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -5500,7 +5506,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 198, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -5628,7 +5634,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 197, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -5762,7 +5768,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 201, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -5822,7 +5828,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 199, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -6312,7 +6318,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 200, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -6396,7 +6402,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 203, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -6490,7 +6496,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 202, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -6584,7 +6590,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 204, + "weight": 183, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -7337,7 +7343,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 997, + "weight": 1055, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -7401,7 +7407,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 998, + "weight": 1056, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -7490,7 +7496,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 996, + "weight": 1054, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -7544,7 +7550,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 999, + "weight": 1057, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -7607,7 +7613,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 992, + "weight": 1050, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -7671,7 +7677,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 993, + "weight": 1051, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -7789,7 +7795,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 991, + "weight": 1049, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -7850,7 +7856,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 994, + "weight": 1052, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -7939,7 +7945,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 995, + "weight": 1053, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -8002,7 +8008,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 1002, + "weight": 1060, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -8101,7 +8107,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 1001, + "weight": 1059, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -8167,7 +8173,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 1000, + "weight": 1058, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -8223,7 +8229,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 519, + "weight": 500, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -8291,7 +8297,7 @@ "x-appwrite": { "method": "getCampaign", "group": null, - "weight": 857, + "weight": 912, "cookies": false, "type": "", "demo": "console\/get-campaign.md", @@ -8352,7 +8358,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 854, + "weight": 909, "cookies": false, "type": "", "demo": "console\/get-coupon.md", @@ -8389,6 +8395,54 @@ ] } }, + "\/console\/oauth2-providers": { + "get": { + "summary": "List OAuth2 providers", + "operationId": "consoleListOAuth2Providers", + "tags": [ + "console" + ], + "description": "List all OAuth2 providers supported by the Appwrite server, along with the parameters required to configure each provider. The response excludes mock providers but includes sandbox providers.", + "responses": { + "200": { + "description": "Console OAuth2 Providers List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/consoleOAuth2ProviderList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listOAuth2Providers", + "group": "console", + "weight": 498, + "cookies": false, + "type": "", + "demo": "console\/list-o-auth-2-providers.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "public", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ] + } + }, "\/console\/plans": { "get": { "summary": "Get plans", @@ -8413,7 +8467,7 @@ "x-appwrite": { "method": "getPlans", "group": null, - "weight": 852, + "weight": 907, "cookies": false, "type": "", "demo": "console\/get-plans.md", @@ -8481,7 +8535,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 853, + "weight": 908, "cookies": false, "type": "", "demo": "console\/get-plan.md", @@ -8542,7 +8596,7 @@ "x-appwrite": { "method": "getProgram", "group": null, - "weight": 855, + "weight": 910, "cookies": false, "type": "", "demo": "console\/get-program.md", @@ -8603,7 +8657,7 @@ "x-appwrite": { "method": "createProgramMembership", "group": null, - "weight": 856, + "weight": 911, "cookies": false, "type": "", "demo": "console\/create-program-membership.md", @@ -8664,7 +8718,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 851, + "weight": 906, "cookies": false, "type": "", "demo": "console\/list-regions.md", @@ -8706,7 +8760,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 520, + "weight": 501, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -8757,6 +8811,54 @@ ] } }, + "\/console\/scopes\/project": { + "get": { + "summary": "List project scopes", + "operationId": "consoleListProjectScopes", + "tags": [ + "console" + ], + "description": "List all scopes available for project API keys, along with a description for each scope.", + "responses": { + "200": { + "description": "Console Key Scopes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/consoleKeyScopeList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listProjectScopes", + "group": "console", + "weight": 499, + "cookies": false, + "type": "", + "demo": "console\/list-project-scopes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "public", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ] + } + }, "\/console\/sources": { "post": { "summary": "Create source", @@ -8781,7 +8883,7 @@ "x-appwrite": { "method": "createSource", "group": null, - "weight": 858, + "weight": 913, "cookies": false, "type": "", "demo": "console\/create-source.md", @@ -8872,7 +8974,7 @@ "x-appwrite": { "method": "suggestColumns", "group": null, - "weight": 859, + "weight": 914, "cookies": false, "type": "", "demo": "console\/suggest-columns.md", @@ -8977,7 +9079,7 @@ "x-appwrite": { "method": "suggestIndexes", "group": null, - "weight": 860, + "weight": 915, "cookies": false, "type": "", "demo": "console\/suggest-indexes.md", @@ -9072,7 +9174,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 518, + "weight": 497, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -9085,7 +9187,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md", "auth": { "Project": [] } @@ -9121,7 +9222,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 635, + "weight": 687, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -9240,7 +9341,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 631, + "weight": 683, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -9357,7 +9458,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 703, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -9424,7 +9525,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 699, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -9495,7 +9596,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 700, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -9559,7 +9660,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 701, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -9637,7 +9738,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 702, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -9703,7 +9804,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 704, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -9788,7 +9889,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 638, + "weight": 690, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -9892,7 +9993,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 632, + "weight": 684, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -9986,7 +10087,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 633, + "weight": 685, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -10096,7 +10197,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 634, + "weight": 686, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -10191,7 +10292,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 643, + "weight": 695, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -10291,7 +10392,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 639, + "weight": 691, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -10418,7 +10519,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 640, + "weight": 692, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -10493,7 +10594,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 641, + "weight": 693, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -10601,7 +10702,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 642, + "weight": 694, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -10678,7 +10779,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 660, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -10779,7 +10880,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 661, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -10892,7 +10993,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 662, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -11010,7 +11111,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 663, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -11124,7 +11225,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 664, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -11243,7 +11344,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 665, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -11357,7 +11458,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 666, + "weight": 718, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -11476,7 +11577,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 667, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -11598,7 +11699,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 668, + "weight": 720, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -11725,7 +11826,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 669, + "weight": 721, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -11853,7 +11954,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 670, + "weight": 722, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -11986,7 +12087,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 671, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -12114,7 +12215,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 672, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -12247,7 +12348,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 673, + "weight": 725, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -12360,7 +12461,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 674, + "weight": 726, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -12478,7 +12579,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 675, + "weight": 727, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -12593,7 +12694,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 676, + "weight": 728, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -12717,7 +12818,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 693, + "weight": 745, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -12831,7 +12932,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 694, + "weight": 746, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -12945,7 +13046,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 691, + "weight": 743, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -13059,7 +13160,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 692, + "weight": 744, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -13173,7 +13274,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 677, + "weight": 729, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -13288,7 +13389,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 678, + "weight": 730, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -13412,7 +13513,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 679, + "weight": 731, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -13527,7 +13628,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 680, + "weight": 732, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -13651,7 +13752,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 681, + "weight": 733, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -13790,7 +13891,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 682, + "weight": 734, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -13905,7 +14006,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 683, + "weight": 735, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -14030,7 +14131,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 684, + "weight": 736, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -14155,7 +14256,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 689, + "weight": 741, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -14269,7 +14370,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 690, + "weight": 742, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -14383,7 +14484,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 685, + "weight": 737, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -14497,7 +14598,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 686, + "weight": 738, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -14616,7 +14717,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 687, + "weight": 739, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -14737,7 +14838,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 688, + "weight": 740, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -14940,7 +15041,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 658, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -15017,7 +15118,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 659, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -15103,7 +15204,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 654, + "weight": 897, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -15227,7 +15328,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 646, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -15418,7 +15519,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 651, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -15555,7 +15656,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 649, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -15660,7 +15761,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 653, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -15762,7 +15863,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 647, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -15873,7 +15974,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 650, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -16028,7 +16129,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 648, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -16140,7 +16241,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 652, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -16247,7 +16348,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 655, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -16345,7 +16446,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 657, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -16474,7 +16575,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 656, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -16603,7 +16704,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 698, + "weight": 750, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -16702,7 +16803,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 695, + "weight": 747, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -16843,7 +16944,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 696, + "weight": 748, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -16920,7 +17021,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 697, + "weight": 749, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -17006,7 +17107,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 644, + "weight": 696, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -17094,7 +17195,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 645, + "weight": 697, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -17191,7 +17292,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 636, + "weight": 688, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -17299,7 +17400,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 637, + "weight": 689, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -17416,7 +17517,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 782, + "weight": 834, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -17502,7 +17603,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 778, + "weight": 830, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -17583,7 +17684,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 810, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -17650,7 +17751,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 806, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -17721,7 +17822,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 807, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -17785,7 +17886,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 808, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -17863,7 +17964,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 809, + "weight": 861, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -17929,7 +18030,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 784, + "weight": 836, "cookies": false, "type": "", "demo": "documentsdb\/list-usage.md", @@ -18025,7 +18126,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 779, + "weight": 831, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -18086,7 +18187,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 780, + "weight": 832, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -18164,7 +18265,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 781, + "weight": 833, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -18227,7 +18328,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 789, + "weight": 841, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -18323,7 +18424,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 785, + "weight": 837, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -18446,7 +18547,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 786, + "weight": 838, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -18517,7 +18618,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 787, + "weight": 839, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -18623,7 +18724,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 788, + "weight": 840, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -18696,7 +18797,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 803, + "weight": 898, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -18816,7 +18917,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 795, + "weight": 847, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -18991,7 +19092,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 800, + "weight": 852, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -19119,7 +19220,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 798, + "weight": 850, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -19219,7 +19320,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 802, + "weight": 854, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -19316,7 +19417,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 796, + "weight": 848, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -19423,7 +19524,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 799, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -19568,7 +19669,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 797, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -19674,7 +19775,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 801, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -19776,7 +19877,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 805, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -19899,7 +20000,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 804, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -20022,7 +20123,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 794, + "weight": 846, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -20117,7 +20218,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 791, + "weight": 843, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -20253,7 +20354,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 792, + "weight": 844, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -20326,7 +20427,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 793, + "weight": 845, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -20408,7 +20509,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 790, + "weight": 842, "cookies": false, "type": "", "demo": "documentsdb\/get-collection-usage.md", @@ -20501,7 +20602,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 783, + "weight": 835, "cookies": false, "type": "", "demo": "documentsdb\/get-usage.md", @@ -20610,7 +20711,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 866, + "weight": 921, "cookies": false, "type": "", "demo": "domains\/list.md", @@ -20682,7 +20783,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 861, + "weight": 916, "cookies": false, "type": "", "demo": "domains\/create.md", @@ -20755,7 +20856,7 @@ "x-appwrite": { "method": "getPrice", "group": null, - "weight": 864, + "weight": 919, "cookies": false, "type": "", "demo": "domains\/get-price.md", @@ -20844,7 +20945,7 @@ "x-appwrite": { "method": "createPurchase", "group": null, - "weight": 911, + "weight": 966, "cookies": false, "type": "", "demo": "domains\/create-purchase.md", @@ -20952,7 +21053,7 @@ } } }, - "\/domains\/purchases\/{domainId}": { + "\/domains\/purchases\/{invoiceId}": { "patch": { "summary": "Confirm a domain purchase", "operationId": "domainsUpdatePurchase", @@ -20976,7 +21077,7 @@ "x-appwrite": { "method": "updatePurchase", "group": null, - "weight": 912, + "weight": 967, "cookies": false, "type": "", "demo": "domains\/update-purchase.md", @@ -21000,12 +21101,12 @@ ], "parameters": [ { - "name": "domainId", - "description": "Domain ID to confirm purchase for.", + "name": "invoiceId", + "description": "Invoice ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -21055,7 +21156,7 @@ "x-appwrite": { "method": "listSuggestions", "group": null, - "weight": 910, + "weight": 965, "cookies": false, "type": "", "demo": "domains\/list-suggestions.md", @@ -21174,7 +21275,7 @@ "x-appwrite": { "method": "createTransferIn", "group": null, - "weight": 871, + "weight": 926, "cookies": false, "type": "", "demo": "domains\/create-transfer-in.md", @@ -21240,7 +21341,7 @@ } } }, - "\/domains\/transfers\/in\/{domainId}": { + "\/domains\/transfers\/in\/{invoiceId}": { "patch": { "summary": "Confirm a domain transfer in", "operationId": "domainsUpdateTransferIn", @@ -21264,7 +21365,7 @@ "x-appwrite": { "method": "updateTransferIn", "group": null, - "weight": 872, + "weight": 927, "cookies": false, "type": "", "demo": "domains\/update-transfer-in.md", @@ -21288,12 +21389,12 @@ ], "parameters": [ { - "name": "domainId", - "description": "Domain ID to confirm transfer for.", + "name": "invoiceId", + "description": "Invoice ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -21343,7 +21444,7 @@ "x-appwrite": { "method": "createTransferOut", "group": null, - "weight": 873, + "weight": 928, "cookies": false, "type": "", "demo": "domains\/create-transfer-out.md", @@ -21416,7 +21517,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 863, + "weight": 918, "cookies": false, "type": "", "demo": "domains\/get.md", @@ -21467,7 +21568,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 862, + "weight": 917, "cookies": false, "type": "", "demo": "domains\/delete.md", @@ -21527,7 +21628,7 @@ "x-appwrite": { "method": "updateAutoRenewal", "group": null, - "weight": 867, + "weight": 922, "cookies": false, "type": "", "demo": "domains\/update-auto-renewal.md", @@ -21606,7 +21707,7 @@ "x-appwrite": { "method": "updateNameservers", "group": null, - "weight": 868, + "weight": 923, "cookies": false, "type": "", "demo": "domains\/update-nameservers.md", @@ -21666,7 +21767,7 @@ "x-appwrite": { "method": "getPresetGoogleWorkspace", "group": null, - "weight": 899, + "weight": 954, "cookies": false, "type": "", "demo": "domains\/get-preset-google-workspace.md", @@ -21724,7 +21825,7 @@ "x-appwrite": { "method": "createPresetGoogleWorkspace", "group": null, - "weight": 898, + "weight": 953, "cookies": false, "type": "", "demo": "domains\/create-preset-google-workspace.md", @@ -21784,7 +21885,7 @@ "x-appwrite": { "method": "getPresetICloud", "group": null, - "weight": 909, + "weight": 964, "cookies": false, "type": "", "demo": "domains\/get-preset-i-cloud.md", @@ -21842,7 +21943,7 @@ "x-appwrite": { "method": "createPresetICloud", "group": null, - "weight": 908, + "weight": 963, "cookies": false, "type": "", "demo": "domains\/create-preset-i-cloud.md", @@ -21902,7 +22003,7 @@ "x-appwrite": { "method": "getPresetMailgun", "group": null, - "weight": 901, + "weight": 956, "cookies": false, "type": "", "demo": "domains\/get-preset-mailgun.md", @@ -21960,7 +22061,7 @@ "x-appwrite": { "method": "createPresetMailgun", "group": null, - "weight": 900, + "weight": 955, "cookies": false, "type": "", "demo": "domains\/create-preset-mailgun.md", @@ -22020,7 +22121,7 @@ "x-appwrite": { "method": "getPresetOutlook", "group": null, - "weight": 907, + "weight": 962, "cookies": false, "type": "", "demo": "domains\/get-preset-outlook.md", @@ -22078,7 +22179,7 @@ "x-appwrite": { "method": "createPresetOutlook", "group": null, - "weight": 906, + "weight": 961, "cookies": false, "type": "", "demo": "domains\/create-preset-outlook.md", @@ -22138,7 +22239,7 @@ "x-appwrite": { "method": "getPresetProtonMail", "group": null, - "weight": 905, + "weight": 960, "cookies": false, "type": "", "demo": "domains\/get-preset-proton-mail.md", @@ -22196,7 +22297,7 @@ "x-appwrite": { "method": "createPresetProtonMail", "group": null, - "weight": 904, + "weight": 959, "cookies": false, "type": "", "demo": "domains\/create-preset-proton-mail.md", @@ -22256,7 +22357,7 @@ "x-appwrite": { "method": "getPresetZoho", "group": null, - "weight": 903, + "weight": 958, "cookies": false, "type": "", "demo": "domains\/get-preset-zoho.md", @@ -22314,7 +22415,7 @@ "x-appwrite": { "method": "createPresetZoho", "group": null, - "weight": 902, + "weight": 957, "cookies": false, "type": "", "demo": "domains\/create-preset-zoho.md", @@ -22374,7 +22475,7 @@ "x-appwrite": { "method": "listRecords", "group": null, - "weight": 897, + "weight": 952, "cookies": false, "type": "", "demo": "domains\/list-records.md", @@ -22447,7 +22548,7 @@ "x-appwrite": { "method": "createRecordA", "group": null, - "weight": 875, + "weight": 930, "cookies": false, "type": "", "demo": "domains\/create-record-a.md", @@ -22544,7 +22645,7 @@ "x-appwrite": { "method": "updateRecordA", "group": null, - "weight": 876, + "weight": 931, "cookies": false, "type": "", "demo": "domains\/update-record-a.md", @@ -22651,7 +22752,7 @@ "x-appwrite": { "method": "createRecordAAAA", "group": null, - "weight": 877, + "weight": 932, "cookies": false, "type": "", "demo": "domains\/create-record-aaaa.md", @@ -22748,7 +22849,7 @@ "x-appwrite": { "method": "updateRecordAAAA", "group": null, - "weight": 878, + "weight": 933, "cookies": false, "type": "", "demo": "domains\/update-record-aaaa.md", @@ -22855,7 +22956,7 @@ "x-appwrite": { "method": "createRecordAlias", "group": null, - "weight": 879, + "weight": 934, "cookies": false, "type": "", "demo": "domains\/create-record-alias.md", @@ -22952,7 +23053,7 @@ "x-appwrite": { "method": "updateRecordAlias", "group": null, - "weight": 880, + "weight": 935, "cookies": false, "type": "", "demo": "domains\/update-record-alias.md", @@ -23059,7 +23160,7 @@ "x-appwrite": { "method": "createRecordCAA", "group": null, - "weight": 881, + "weight": 936, "cookies": false, "type": "", "demo": "domains\/create-record-caa.md", @@ -23156,7 +23257,7 @@ "x-appwrite": { "method": "updateRecordCAA", "group": null, - "weight": 882, + "weight": 937, "cookies": false, "type": "", "demo": "domains\/update-record-caa.md", @@ -23263,7 +23364,7 @@ "x-appwrite": { "method": "createRecordCNAME", "group": null, - "weight": 883, + "weight": 938, "cookies": false, "type": "", "demo": "domains\/create-record-cname.md", @@ -23360,7 +23461,7 @@ "x-appwrite": { "method": "updateRecordCNAME", "group": null, - "weight": 884, + "weight": 939, "cookies": false, "type": "", "demo": "domains\/update-record-cname.md", @@ -23467,7 +23568,7 @@ "x-appwrite": { "method": "createRecordHTTPS", "group": null, - "weight": 885, + "weight": 940, "cookies": false, "type": "", "demo": "domains\/create-record-https.md", @@ -23564,7 +23665,7 @@ "x-appwrite": { "method": "updateRecordHTTPS", "group": null, - "weight": 886, + "weight": 941, "cookies": false, "type": "", "demo": "domains\/update-record-https.md", @@ -23671,7 +23772,7 @@ "x-appwrite": { "method": "createRecordMX", "group": null, - "weight": 887, + "weight": 942, "cookies": false, "type": "", "demo": "domains\/create-record-mx.md", @@ -23775,7 +23876,7 @@ "x-appwrite": { "method": "updateRecordMX", "group": null, - "weight": 888, + "weight": 943, "cookies": false, "type": "", "demo": "domains\/update-record-mx.md", @@ -23889,7 +23990,7 @@ "x-appwrite": { "method": "createRecordNS", "group": null, - "weight": 889, + "weight": 944, "cookies": false, "type": "", "demo": "domains\/create-record-ns.md", @@ -23986,7 +24087,7 @@ "x-appwrite": { "method": "updateRecordNS", "group": null, - "weight": 890, + "weight": 945, "cookies": false, "type": "", "demo": "domains\/update-record-ns.md", @@ -24093,7 +24194,7 @@ "x-appwrite": { "method": "createRecordSRV", "group": null, - "weight": 891, + "weight": 946, "cookies": false, "type": "", "demo": "domains\/create-record-srv.md", @@ -24211,7 +24312,7 @@ "x-appwrite": { "method": "updateRecordSRV", "group": null, - "weight": 892, + "weight": 947, "cookies": false, "type": "", "demo": "domains\/update-record-srv.md", @@ -24339,7 +24440,7 @@ "x-appwrite": { "method": "createRecordTXT", "group": null, - "weight": 893, + "weight": 948, "cookies": false, "type": "", "demo": "domains\/create-record-txt.md", @@ -24435,7 +24536,7 @@ "x-appwrite": { "method": "updateRecordTXT", "group": null, - "weight": 894, + "weight": 949, "cookies": false, "type": "", "demo": "domains\/update-record-txt.md", @@ -24542,7 +24643,7 @@ "x-appwrite": { "method": "getRecord", "group": null, - "weight": 896, + "weight": 951, "cookies": false, "type": "", "demo": "domains\/get-record.md", @@ -24603,7 +24704,7 @@ "x-appwrite": { "method": "deleteRecord", "group": null, - "weight": 895, + "weight": 950, "cookies": false, "type": "", "demo": "domains\/delete-record.md", @@ -24673,7 +24774,7 @@ "x-appwrite": { "method": "updateTeam", "group": null, - "weight": 870, + "weight": 925, "cookies": false, "type": "", "demo": "domains\/update-team.md", @@ -24752,7 +24853,7 @@ "x-appwrite": { "method": "getTransferStatus", "group": null, - "weight": 874, + "weight": 929, "cookies": false, "type": "", "demo": "domains\/get-transfer-status.md", @@ -24805,7 +24906,7 @@ "x-appwrite": { "method": "getZone", "group": null, - "weight": 865, + "weight": 920, "cookies": false, "type": "", "demo": "domains\/get-zone.md", @@ -24863,7 +24964,7 @@ "x-appwrite": { "method": "updateZone", "group": null, - "weight": 869, + "weight": 924, "cookies": false, "type": "", "demo": "domains\/update-zone.md", @@ -24942,7 +25043,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 437, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -25027,7 +25128,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 845, + "weight": 900, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -25155,6 +25256,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -25221,75 +25323,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -25379,7 +25488,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 439, + "weight": 418, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -25429,7 +25538,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 440, + "weight": 419, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -25479,7 +25588,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 463, + "weight": 442, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -25594,6 +25703,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -25696,7 +25806,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 462, + "weight": 441, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -25756,7 +25866,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 456, + "weight": 435, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -25828,7 +25938,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 435, + "weight": 414, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -25888,7 +25998,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 846, + "weight": 901, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -26023,6 +26133,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -26089,75 +26200,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -26237,7 +26355,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 438, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -26299,7 +26417,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 443, + "weight": 422, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -26380,7 +26498,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 444, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -26475,7 +26593,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 441, + "weight": 420, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -26575,7 +26693,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 449, + "weight": 428, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -26661,7 +26779,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 446, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -26778,7 +26896,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 447, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -26876,7 +26994,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 442, + "weight": 421, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -26939,7 +27057,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 445, + "weight": 424, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -27004,7 +27122,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 448, + "weight": 427, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -27095,7 +27213,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 450, + "weight": 429, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -27167,14 +27285,17 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 453, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-executions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -27254,14 +27375,17 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 451, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/create-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "client", @@ -27372,14 +27496,17 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 452, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/get-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -27438,14 +27565,17 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 454, + "weight": 433, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "server" @@ -27510,7 +27640,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 455, + "weight": 434, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -27592,7 +27722,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 459, + "weight": 438, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -27652,7 +27782,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 847, + "weight": 902, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -27744,7 +27874,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 458, + "weight": 437, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -27814,7 +27944,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 460, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -27908,7 +28038,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 461, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -27980,7 +28110,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 122, + "weight": 117, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -28034,7 +28164,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 121, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -28088,7 +28218,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 464, + "weight": 443, "cookies": false, "type": "", "demo": "health\/get.md", @@ -28139,7 +28269,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 473, + "weight": 452, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -28190,7 +28320,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 467, + "weight": 446, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -28241,7 +28371,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 470, + "weight": 449, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -28303,7 +28433,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 985, + "weight": 1043, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -28378,7 +28508,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 466, + "weight": 445, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -28429,7 +28559,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 468, + "weight": 447, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -28480,7 +28610,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 474, + "weight": 453, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -28544,7 +28674,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 981, + "weight": 1039, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -28608,7 +28738,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 980, + "weight": 1038, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -28672,7 +28802,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 478, + "weight": 457, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -28736,7 +28866,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 982, + "weight": 1040, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -28800,7 +28930,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 477, + "weight": 456, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -28864,7 +28994,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 479, + "weight": 458, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -28939,7 +29069,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 480, + "weight": 459, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -29003,7 +29133,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 487, + "weight": 466, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -29094,7 +29224,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 484, + "weight": 463, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -29158,7 +29288,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 476, + "weight": 455, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -29222,7 +29352,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 481, + "weight": 460, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -29286,7 +29416,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 482, + "weight": 461, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -29350,7 +29480,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 483, + "weight": 462, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -29414,7 +29544,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 983, + "weight": 1041, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -29478,7 +29608,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 485, + "weight": 464, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -29542,7 +29672,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 486, + "weight": 465, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -29606,7 +29736,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 984, + "weight": 1042, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -29670,7 +29800,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 475, + "weight": 454, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -29734,7 +29864,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 472, + "weight": 451, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -29785,7 +29915,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 471, + "weight": 450, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -29836,7 +29966,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 469, + "weight": 448, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -30295,6 +30425,307 @@ ] } }, + "\/manager\/blocks": { + "post": { + "summary": "Create a new resource block for a project", + "operationId": "managerCreateBlock", + "tags": [ + "manager" + ], + "description": "Creates a new resource block.", + "responses": { + "201": { + "description": "Block", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/block" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBlock", + "group": null, + "weight": 974, + "cookies": false, + "type": "", + "demo": "manager\/create-block.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "", + "platforms": [ + "console" + ], + "packaging": false, + "public": true + }, + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "projectId": { + "type": "string", + "description": "Project ID", + "x-example": "" + }, + "resourceType": { + "type": "string", + "description": "Resource type to block (e.g., projects, functions, databases, storage, etc.)", + "x-example": "projects", + "enum": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "resourceId": { + "type": "string", + "description": "Optional resource ID (if omitted, all resources of this type will be blocked)", + "x-example": "" + }, + "reason": { + "type": "string", + "description": "Optional reason why the resource is blocked", + "x-example": "" + }, + "expiredAt": { + "type": "string", + "description": "Optional expiration date for the block", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" + } + }, + "required": [ + "projectId", + "resourceType" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete resource blocks for a project", + "operationId": "managerDeleteBlock", + "tags": [ + "manager" + ], + "description": "Deletes resource blocks for a project.", + "responses": { + "200": { + "description": "BlockDelete", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/blockDelete" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteBlock", + "group": null, + "weight": 976, + "cookies": false, + "type": "", + "demo": "manager\/delete-block.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "", + "platforms": [ + "console" + ], + "packaging": false, + "public": true + }, + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "projectId": { + "type": "string", + "description": "Project ID", + "x-example": "" + }, + "resourceType": { + "type": "string", + "description": "Resource type to unblock", + "x-example": "projects", + "enum": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "resourceId": { + "type": "string", + "description": "Optional resource ID (if omitted, all blocks of this type will be removed)", + "x-example": "" + } + }, + "required": [ + "projectId", + "resourceType" + ] + } + } + } + } + } + }, + "\/manager\/blocks\/{projectId}": { + "get": { + "summary": "List all resource blocks for a project", + "operationId": "managerListBlocks", + "tags": [ + "manager" + ], + "description": "Lists all resource blocks for a project.", + "responses": { + "200": { + "description": "Blocks list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/blockList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listBlocks", + "group": null, + "weight": 975, + "cookies": false, + "type": "", + "demo": "manager\/list-blocks.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "", + "platforms": [ + "console" + ], + "packaging": false, + "public": true + }, + "parameters": [ + { + "name": "projectId", + "description": "Project ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/manager\/users\/status": { + "patch": { + "summary": "Update a user status by ID or email", + "operationId": "managerUpdateUserStatus", + "tags": [ + "manager" + ], + "description": "Updates a console user status using a user ID or email address.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateUserStatus", + "group": "users", + "weight": 977, + "cookies": false, + "type": "", + "demo": "manager\/update-user-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "", + "platforms": [ + "console" + ], + "packaging": false, + "public": true + }, + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email address.", + "x-example": "" + }, + "status": { + "type": "boolean", + "description": "User status. Set to `false` to block and `true` to unblock.", + "x-example": false + }, + "reason": { + "type": "string", + "description": "Optional reason when blocking a user. Accepted for parity with the CLI task but not persisted.", + "x-example": "" + } + }, + "required": [ + "status" + ] + } + } + } + } + } + }, "\/messaging\/messages": { "get": { "summary": "List messages", @@ -30319,7 +30750,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 179, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -30407,7 +30838,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 176, + "weight": 155, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -30554,7 +30985,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 183, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -30713,7 +31144,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 178, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -30892,7 +31323,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 185, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -31091,7 +31522,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 177, + "weight": 156, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -31273,7 +31704,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 184, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -31461,7 +31892,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 182, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -31515,7 +31946,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 186, + "weight": 165, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -31578,7 +32009,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 180, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -31665,7 +32096,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 181, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -31752,7 +32183,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 150, + "weight": 129, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -31840,7 +32271,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 149, + "weight": 128, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -32019,7 +32450,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 163, + "weight": 142, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -32200,7 +32631,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 148, + "weight": 127, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -32352,7 +32783,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 162, + "weight": 141, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -32505,7 +32936,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 139, + "weight": 118, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -32625,7 +33056,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 153, + "weight": 132, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -32747,7 +33178,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 143, + "weight": 122, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -32844,7 +33275,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 157, + "weight": 136, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -32944,7 +33375,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 141, + "weight": 120, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -33053,7 +33484,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 155, + "weight": 134, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -33164,7 +33595,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 140, + "weight": 119, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -33273,7 +33704,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 154, + "weight": 133, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -33384,7 +33815,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 142, + "weight": 121, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -33618,7 +34049,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 156, + "weight": 135, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -33851,7 +34282,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 144, + "weight": 123, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -33949,7 +34380,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 158, + "weight": 137, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -34049,7 +34480,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 145, + "weight": 124, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -34147,7 +34578,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 159, + "weight": 138, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -34247,7 +34678,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 146, + "weight": 125, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -34345,7 +34776,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 160, + "weight": 139, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -34445,7 +34876,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 147, + "weight": 126, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -34543,7 +34974,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 161, + "weight": 140, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -34643,7 +35074,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 152, + "weight": 131, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -34697,7 +35128,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 164, + "weight": 143, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -34760,7 +35191,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 151, + "weight": 130, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -34847,7 +35278,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 173, + "weight": 152, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -34934,7 +35365,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 166, + "weight": 145, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -35020,7 +35451,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 165, + "weight": 144, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -35104,7 +35535,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 168, + "weight": 147, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -35165,7 +35596,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 169, + "weight": 148, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -35245,7 +35676,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 170, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -35308,7 +35739,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 167, + "weight": 146, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -35395,7 +35826,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 172, + "weight": 151, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -35491,7 +35922,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 171, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -35582,7 +36013,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 174, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -35646,7 +36077,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 175, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -35722,7 +36153,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 131, + "weight": 572, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -35808,7 +36239,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 123, + "weight": 576, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -35868,7 +36299,8 @@ "message", "site", "site-deployment", - "site-variable" + "site-variable", + "backup-policy" ], "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [] @@ -35927,7 +36359,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 133, + "weight": 577, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -35984,7 +36416,8 @@ "message", "site", "site-deployment", - "site-variable" + "site-variable", + "backup-policy" ], "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [] @@ -36050,7 +36483,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 128, + "weight": 585, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -36165,7 +36598,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 127, + "weight": 584, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -36250,7 +36683,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 124, + "weight": 578, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -36341,7 +36774,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 134, + "weight": 579, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -36428,7 +36861,7 @@ "x-appwrite": { "method": "createJSONExport", "group": null, - "weight": 130, + "weight": 587, "cookies": false, "type": "", "demo": "migrations\/create-json-export.md", @@ -36523,7 +36956,7 @@ "x-appwrite": { "method": "createJSONImport", "group": null, - "weight": 129, + "weight": 586, "cookies": false, "type": "", "demo": "migrations\/create-json-import.md", @@ -36608,7 +37041,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 126, + "weight": 582, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -36736,7 +37169,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 136, + "weight": 583, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -36885,7 +37318,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 125, + "weight": 580, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -37008,7 +37441,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 135, + "weight": 581, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -37148,7 +37581,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 132, + "weight": 573, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -37207,7 +37640,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 137, + "weight": 574, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -37259,7 +37692,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 138, + "weight": 575, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -37320,7 +37753,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 932, + "weight": 989, "cookies": false, "type": "", "demo": "organizations\/list.md", @@ -37400,7 +37833,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 931, + "weight": 988, "cookies": false, "type": "", "demo": "organizations\/create.md", @@ -37530,7 +37963,7 @@ "x-appwrite": { "method": "estimationCreateOrganization", "group": null, - "weight": 965, + "weight": 1023, "cookies": false, "type": "", "demo": "organizations\/estimation-create-organization.md", @@ -37622,7 +38055,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 933, + "weight": 990, "cookies": false, "type": "", "demo": "organizations\/delete.md", @@ -37683,7 +38116,7 @@ "x-appwrite": { "method": "listAddons", "group": null, - "weight": 973, + "weight": 1031, "cookies": false, "type": "", "demo": "organizations\/list-addons.md", @@ -37744,7 +38177,7 @@ "x-appwrite": { "method": "createBaaAddon", "group": null, - "weight": 976, + "weight": 1034, "cookies": false, "type": "", "demo": "organizations\/create-baa-addon.md", @@ -37805,7 +38238,7 @@ "x-appwrite": { "method": "getAddon", "group": null, - "weight": 974, + "weight": 1032, "cookies": false, "type": "", "demo": "organizations\/get-addon.md", @@ -37867,7 +38300,7 @@ "x-appwrite": { "method": "deleteAddon", "group": null, - "weight": 977, + "weight": 1035, "cookies": false, "type": "", "demo": "organizations\/delete-addon.md", @@ -37938,7 +38371,7 @@ "x-appwrite": { "method": "confirmAddonPayment", "group": null, - "weight": 978, + "weight": 1036, "cookies": false, "type": "", "demo": "organizations\/confirm-addon-payment.md", @@ -38009,7 +38442,7 @@ "x-appwrite": { "method": "getAddonPrice", "group": null, - "weight": 975, + "weight": 1033, "cookies": false, "type": "", "demo": "organizations\/get-addon-price.md", @@ -38085,7 +38518,7 @@ "x-appwrite": { "method": "listAggregations", "group": null, - "weight": 948, + "weight": 1005, "cookies": false, "type": "", "demo": "organizations\/list-aggregations.md", @@ -38159,7 +38592,7 @@ "x-appwrite": { "method": "getAggregation", "group": null, - "weight": 949, + "weight": 1006, "cookies": false, "type": "", "demo": "organizations\/get-aggregation.md", @@ -38253,7 +38686,7 @@ "x-appwrite": { "method": "setBillingAddress", "group": null, - "weight": 941, + "weight": 998, "cookies": false, "type": "", "demo": "organizations\/set-billing-address.md", @@ -38324,7 +38757,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 942, + "weight": 999, "cookies": false, "type": "", "demo": "organizations\/delete-billing-address.md", @@ -38385,7 +38818,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 940, + "weight": 997, "cookies": false, "type": "", "demo": "organizations\/get-billing-address.md", @@ -38456,7 +38889,7 @@ "x-appwrite": { "method": "setBillingEmail", "group": null, - "weight": 960, + "weight": 1017, "cookies": false, "type": "", "demo": "organizations\/set-billing-email.md", @@ -38537,7 +38970,7 @@ "x-appwrite": { "method": "updateBudget", "group": null, - "weight": 937, + "weight": 994, "cookies": false, "type": "", "demo": "organizations\/update-budget.md", @@ -38627,7 +39060,7 @@ "x-appwrite": { "method": "listCredits", "group": null, - "weight": 952, + "weight": 1009, "cookies": false, "type": "", "demo": "organizations\/list-credits.md", @@ -38699,7 +39132,7 @@ "x-appwrite": { "method": "addCredit", "group": null, - "weight": 953, + "weight": 1010, "cookies": false, "type": "", "demo": "organizations\/add-credit.md", @@ -38779,7 +39212,7 @@ "x-appwrite": { "method": "getAvailableCredits", "group": null, - "weight": 951, + "weight": 1008, "cookies": false, "type": "", "demo": "organizations\/get-available-credits.md", @@ -38840,7 +39273,7 @@ "x-appwrite": { "method": "getCredit", "group": null, - "weight": 950, + "weight": 1007, "cookies": false, "type": "", "demo": "organizations\/get-credit.md", @@ -38911,7 +39344,7 @@ "x-appwrite": { "method": "estimationDeleteOrganization", "group": null, - "weight": 966, + "weight": 1024, "cookies": false, "type": "", "demo": "organizations\/estimation-delete-organization.md", @@ -38972,7 +39405,7 @@ "x-appwrite": { "method": "estimationUpdatePlan", "group": null, - "weight": 964, + "weight": 1021, "cookies": false, "type": "", "demo": "organizations\/estimation-update-plan.md", @@ -39066,7 +39499,7 @@ "x-appwrite": { "method": "createDowngradeFeedback", "group": null, - "weight": 967, + "weight": 1025, "cookies": false, "type": "", "demo": "organizations\/create-downgrade-feedback.md", @@ -39164,7 +39597,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 955, + "weight": 1012, "cookies": false, "type": "", "demo": "organizations\/list-invoices.md", @@ -39238,7 +39671,7 @@ "x-appwrite": { "method": "getInvoice", "group": null, - "weight": 954, + "weight": 1011, "cookies": false, "type": "", "demo": "organizations\/get-invoice.md", @@ -39309,7 +39742,7 @@ "x-appwrite": { "method": "getInvoiceDownload", "group": null, - "weight": 958, + "weight": 1015, "cookies": false, "type": "", "demo": "organizations\/get-invoice-download.md", @@ -39380,7 +39813,7 @@ "x-appwrite": { "method": "createInvoicePayment", "group": null, - "weight": 959, + "weight": 1016, "cookies": false, "type": "", "demo": "organizations\/create-invoice-payment.md", @@ -39470,7 +39903,7 @@ "x-appwrite": { "method": "validateInvoice", "group": null, - "weight": 956, + "weight": 1013, "cookies": false, "type": "", "demo": "organizations\/validate-invoice.md", @@ -39541,7 +39974,7 @@ "x-appwrite": { "method": "getInvoiceView", "group": null, - "weight": 957, + "weight": 1014, "cookies": false, "type": "", "demo": "organizations\/get-invoice-view.md", @@ -39612,7 +40045,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 970, + "weight": 1028, "cookies": false, "type": "", "demo": "organizations\/list-keys.md", @@ -39681,7 +40114,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 968, + "weight": 1026, "cookies": false, "type": "", "demo": "organizations\/create-key.md", @@ -39788,7 +40221,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 972, + "weight": 1030, "cookies": false, "type": "", "demo": "organizations\/get-key.md", @@ -39856,7 +40289,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 969, + "weight": 1027, "cookies": false, "type": "", "demo": "organizations\/update-key.md", @@ -39964,7 +40397,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 971, + "weight": 1029, "cookies": false, "type": "", "demo": "organizations\/delete-key.md", @@ -40034,7 +40467,7 @@ "x-appwrite": { "method": "setDefaultPaymentMethod", "group": null, - "weight": 944, + "weight": 1001, "cookies": false, "type": "", "demo": "organizations\/set-default-payment-method.md", @@ -40112,7 +40545,7 @@ "x-appwrite": { "method": "deleteDefaultPaymentMethod", "group": null, - "weight": 946, + "weight": 1003, "cookies": false, "type": "", "demo": "organizations\/delete-default-payment-method.md", @@ -40173,7 +40606,7 @@ "x-appwrite": { "method": "setBackupPaymentMethod", "group": null, - "weight": 945, + "weight": 1002, "cookies": false, "type": "", "demo": "organizations\/set-backup-payment-method.md", @@ -40251,7 +40684,7 @@ "x-appwrite": { "method": "deleteBackupPaymentMethod", "group": null, - "weight": 947, + "weight": 1004, "cookies": false, "type": "", "demo": "organizations\/delete-backup-payment-method.md", @@ -40312,7 +40745,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 943, + "weight": 1000, "cookies": false, "type": "", "demo": "organizations\/get-payment-method.md", @@ -40383,7 +40816,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 934, + "weight": 991, "cookies": false, "type": "", "demo": "organizations\/get-plan.md", @@ -40442,7 +40875,7 @@ "x-appwrite": { "method": "updatePlan", "group": null, - "weight": 935, + "weight": 992, "cookies": false, "type": "", "demo": "organizations\/update-plan.md", @@ -40560,7 +40993,7 @@ "x-appwrite": { "method": "cancelDowngrade", "group": null, - "weight": 936, + "weight": 993, "cookies": false, "type": "", "demo": "organizations\/cancel-downgrade.md", @@ -40597,6 +41030,100 @@ ] } }, + "\/organizations\/{organizationId}\/plan\/estimations": { + "post": { + "summary": "Create billing plan estimation (upgrade or downgrade)", + "operationId": "organizationsCreatePlanEstimation", + "tags": [ + "organizations" + ], + "description": "Create a billing plan estimation for upgrading or downgrading an organization plan.\n", + "responses": { + "200": { + "description": "EstimationPlanChange", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/estimationPlanChange" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createPlanEstimation", + "group": null, + "weight": 1022, + "cookies": false, + "type": "", + "demo": "organizations\/create-plan-estimation.md", + "rate-limit": 10, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/create-plan-estimation.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "Target billing plan", + "x-example": "tier-0" + }, + "invites": { + "type": "array", + "description": "Additional member invites", + "x-example": null, + "items": { + "type": "string" + } + }, + "couponId": { + "type": "string", + "description": "Coupon id", + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "billingPlan" + ] + } + } + } + } + } + }, "\/organizations\/{organizationId}\/regions": { "get": { "summary": "List Regions", @@ -40621,7 +41148,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 963, + "weight": 1020, "cookies": false, "type": "", "demo": "organizations\/list-regions.md", @@ -40682,7 +41209,7 @@ "x-appwrite": { "method": "getScopes", "group": null, - "weight": 962, + "weight": 1019, "cookies": false, "type": "", "demo": "organizations\/get-scopes.md", @@ -40754,7 +41281,7 @@ "x-appwrite": { "method": "setBillingTaxId", "group": null, - "weight": 938, + "weight": 995, "cookies": false, "type": "", "demo": "organizations\/set-billing-tax-id.md", @@ -40835,7 +41362,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 939, + "weight": 996, "cookies": false, "type": "", "demo": "organizations\/get-usage.md", @@ -40918,7 +41445,7 @@ "x-appwrite": { "method": "validatePayment", "group": null, - "weight": 961, + "weight": 1018, "cookies": false, "type": "", "demo": "organizations\/validate-payment.md", @@ -40974,34 +41501,27 @@ } } }, - "\/project\/auth\/canonical-emails": { - "patch": { - "summary": "Update project auth canonical emails", - "operationId": "projectUpdateCanonicalEmails", + "\/project": { + "delete": { + "summary": "Delete project", + "operationId": "projectDelete", "tags": [ "project" ], - "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", + "description": "Delete a project.", "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateCanonicalEmails", - "group": "auth", - "weight": 1068, + "method": "delete", + "group": null, + "weight": 1087, "cookies": false, "type": "", - "demo": "project\/update-canonical-emails.md", + "demo": "project\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41021,36 +41541,17 @@ "Project": [], "Key": [] } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Set whether or not to require canonical email addresses during signup and email updates.", - "x-example": false - } - }, - "required": [ - "enabled" - ] - } - } - } - } + ] } }, - "\/project\/auth\/disposable-emails": { + "\/project\/auth-methods\/{methodId}": { "patch": { - "summary": "Update project auth disposable emails", - "operationId": "projectUpdateDisposableEmails", + "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", + "operationId": "projectUpdateAuthMethod", "tags": [ "project" ], - "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", + "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", "responses": { "200": { "description": "Project", @@ -41065,12 +41566,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDisposableEmails", - "group": "auth", - "weight": 1069, + "method": "updateAuthMethod", + "group": null, + "weight": 1136, "cookies": false, "type": "", - "demo": "project\/update-disposable-emails.md", + "demo": "project\/update-auth-method.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41091,6 +41592,29 @@ "Key": [] } ], + "parameters": [ + { + "name": "methodId", + "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "required": true, + "schema": { + "type": "string", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { @@ -41099,7 +41623,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "description": "Auth method status.", "x-example": false } }, @@ -41112,14 +41636,14 @@ } } }, - "\/project\/auth\/free-emails": { + "\/project\/auth\/canonical-emails": { "patch": { - "summary": "Update project auth free emails", - "operationId": "projectUpdateFreeEmails", + "summary": "Update project auth canonical emails", + "operationId": "projectUpdateCanonicalEmails", "tags": [ "project" ], - "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", + "description": "Configure if canonical emails (alias subaddresses and emails with suffixes) are allowed during new users sign-ups in this project.", "responses": { "200": { "description": "Project", @@ -41134,12 +41658,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFreeEmails", + "method": "updateCanonicalEmails", "group": "auth", - "weight": 1070, + "weight": 1181, "cookies": false, "type": "", - "demo": "project\/update-free-emails.md", + "demo": "project\/update-canonical-emails.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41168,7 +41692,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Set whether or not to block free email addresses during signup and email updates.", + "description": "Set whether or not to require canonical email addresses during signup and email updates.", "x-example": false } }, @@ -41181,21 +41705,21 @@ } } }, - "\/project\/keys": { - "get": { - "summary": "List project keys", - "operationId": "projectListKeys", + "\/project\/auth\/disposable-emails": { + "patch": { + "summary": "Update project auth disposable emails", + "operationId": "projectUpdateDisposableEmails", "tags": [ "project" ], - "description": "Get a list of all API keys from the current project.", + "description": "Configure if disposable emails (emails of known temporary domains) are allowed during new users sign-ups in this project.", "responses": { "200": { - "description": "API Keys List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/keyList" + "$ref": "#\/components\/schemas\/project" } } } @@ -41203,16 +41727,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listKeys", - "group": "keys", - "weight": 1042, + "method": "updateDisposableEmails", + "group": "auth", + "weight": 1182, "cookies": false, "type": "", - "demo": "project\/list-keys.md", + "demo": "project\/update-disposable-emails.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.read", + "scope": "project.write", "platforms": [ "console", "server" @@ -41229,47 +41753,42 @@ "Key": [] } ], - "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: expire, accessedAt, name, scopes", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Set whether or not to block disposable email addresses during signup and email updates.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } } - ] - }, - "post": { - "summary": "Create project key", - "operationId": "projectCreateKey", + } + } + }, + "\/project\/auth\/free-emails": { + "patch": { + "summary": "Update project auth free emails", + "operationId": "projectUpdateFreeEmails", "tags": [ "project" ], - "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", + "description": "Configure if free emails (non-commercial and not a custom domain) are allowed during new users sign-ups in this project.", "responses": { - "201": { - "description": "Key", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/key" + "$ref": "#\/components\/schemas\/project" } } } @@ -41277,16 +41796,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createKey", - "group": "keys", - "weight": 1041, + "method": "updateFreeEmails", + "group": "auth", + "weight": 1183, "cookies": false, "type": "", - "demo": "project\/create-key.md", + "demo": "project\/update-free-emails.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "keys.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -41309,116 +41828,14 @@ "schema": { "type": "object", "properties": { - "keyId": { - "type": "string", - "description": "Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Key name. Max length: 128 chars.", - "x-example": "" - }, - "scopes": { - "type": "array", - "description": "Key scopes list. Maximum of 100 scopes are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] - } - }, - "expire": { - "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true + "enabled": { + "type": "boolean", + "description": "Set whether or not to block free email addresses during signup and email updates.", + "x-example": false } }, "required": [ - "keyId", - "name", - "scopes" + "enabled" ] } } @@ -41426,21 +41843,21 @@ } } }, - "\/project\/keys\/{keyId}": { + "\/project\/keys": { "get": { - "summary": "Get project key", - "operationId": "projectGetKey", + "summary": "List project keys", + "operationId": "projectListKeys", "tags": [ "project" ], - "description": "Get a key by its unique ID. ", + "description": "Get a list of all API keys from the current project.", "responses": { "200": { - "description": "Key", + "description": "API Keys List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/key" + "$ref": "#\/components\/schemas\/keyList" } } } @@ -41448,12 +41865,430 @@ }, "deprecated": false, "x-appwrite": { - "method": "getKey", + "method": "listKeys", "group": "keys", - "weight": 1043, + "weight": 1103, "cookies": false, "type": "", - "demo": "project\/get-key.md", + "demo": "project\/list-keys.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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: expire, accessedAt, name, scopes", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create project key", + "operationId": "projectCreateKey", + "tags": [ + "project" + ], + "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create an ephemeral API key if you need a short-lived key instead.", + "responses": { + "201": { + "description": "Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/key" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createKey", + "group": "keys", + "weight": 1101, + "cookies": false, + "type": "", + "demo": "project\/create-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "keyId": { + "type": "string", + "description": "Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Key name. Max length: 128 chars.", + "x-example": "" + }, + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "rules.read", + "rules.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + } + }, + "required": [ + "keyId", + "name", + "scopes" + ] + } + } + } + } + } + }, + "\/project\/keys\/ephemeral": { + "post": { + "summary": "Create ephemeral project key", + "operationId": "projectCreateEphemeralKey", + "tags": [ + "project" + ], + "description": "Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create a standard API key if you need a longer-lived key instead.", + "responses": { + "201": { + "description": "Ephemeral Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/ephemeralKey" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createEphemeralKey", + "group": "keys", + "weight": 1102, + "cookies": false, + "type": "", + "demo": "project\/create-ephemeral-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "rules.read", + "rules.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "duration": { + "type": "integer", + "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", + "x-example": 1, + "format": "int32" + } + }, + "required": [ + "scopes", + "duration" + ] + } + } + } + } + } + }, + "\/project\/keys\/{keyId}": { + "get": { + "summary": "Get project key", + "operationId": "projectGetKey", + "tags": [ + "project" + ], + "description": "Get a key by its unique ID. ", + "responses": { + "200": { + "description": "Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/key" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getKey", + "group": "keys", + "weight": 1104, + "cookies": false, + "type": "", + "demo": "project\/get-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41510,7 +42345,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1045, + "weight": 1106, "cookies": false, "type": "", "demo": "project\/update-key.md", @@ -41564,75 +42399,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -41678,7 +42520,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1044, + "weight": 1105, "cookies": false, "type": "", "demo": "project\/delete-key.md", @@ -41740,7 +42582,7 @@ "x-appwrite": { "method": "updateLabels", "group": null, - "weight": 1029, + "weight": 1088, "cookies": false, "type": "", "demo": "project\/update-labels.md", @@ -41788,21 +42630,21 @@ } } }, - "\/project\/platforms": { + "\/project\/mock-phones": { "get": { - "summary": "List project platforms", - "operationId": "projectListPlatforms", + "summary": "List project mock phones", + "operationId": "projectListMockPhones", "tags": [ "project" ], - "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", + "description": "Get a list of all mock phones in the project. This endpoint returns an array of all mock phones and their OTPs.", "responses": { "200": { - "description": "Platforms List", + "description": "Mock Numbers List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformList" + "$ref": "#\/components\/schemas\/mockNumberList" } } } @@ -41810,16 +42652,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listPlatforms", - "group": "platforms", - "weight": 1058, + "method": "listMockPhones", + "group": "mocks", + "weight": 1121, "cookies": false, "type": "", - "demo": "project\/list-platforms.md", + "demo": "project\/list-mock-phones.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "mocks.read", "platforms": [ "console", "server" @@ -41839,7 +42681,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "schema": { "type": "array", @@ -41862,23 +42704,21 @@ "in": "query" } ] - } - }, - "\/project\/platforms\/android": { + }, "post": { - "summary": "Create project Android platform", - "operationId": "projectCreateAndroidPlatform", + "summary": "Create project mock phone", + "operationId": "projectCreateMockPhone", "tags": [ "project" ], - "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", + "description": "Create a new mock phone for your project. Use this endpoint to register a mock phone number and its sign-in OTP for your testers.", "responses": { "201": { - "description": "Platform Android", + "description": "Mock Number", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformAndroid" + "$ref": "#\/components\/schemas\/mockNumber" } } } @@ -41886,16 +42726,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createAndroidPlatform", - "group": "platforms", - "weight": 1054, + "method": "createMockPhone", + "group": "mocks", + "weight": 1120, "cookies": false, "type": "", - "demo": "project\/create-android-platform.md", + "demo": "project\/create-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -41918,26 +42758,21 @@ "schema": { "type": "object", "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { + "number": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.", + "x-example": "+12065550100", + "format": "phone" }, - "applicationId": { + "otp": { "type": "string", - "description": "Android application ID. Max length: 256 chars.", - "x-example": "" + "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", + "x-example": "" } }, "required": [ - "platformId", - "name", - "applicationId" + "number", + "otp" ] } } @@ -41945,21 +42780,21 @@ } } }, - "\/project\/platforms\/android\/{platformId}": { - "put": { - "summary": "Update project Android platform", - "operationId": "projectUpdateAndroidPlatform", + "\/project\/mock-phones\/{number}": { + "get": { + "summary": "Get project mock phone", + "operationId": "projectGetMockPhone", "tags": [ "project" ], - "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", + "description": "Get a mock phone by its unique number. This endpoint returns the mock phone's OTP.", "responses": { "200": { - "description": "Platform Android", + "description": "Mock Number", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformAndroid" + "$ref": "#\/components\/schemas\/mockNumber" } } } @@ -41967,16 +42802,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAndroidPlatform", - "group": "platforms", - "weight": 1049, + "method": "getMockPhone", + "group": "mocks", + "weight": 1122, "cookies": false, "type": "", - "demo": "project\/update-android-platform.md", + "demo": "project\/get-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.read", "platforms": [ "console", "server" @@ -41995,58 +42830,32 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", "required": true, "schema": { "type": "string", - "x-example": "" + "format": "phone", + "x-example": "+12065550100" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" - }, - "applicationId": { - "type": "string", - "description": "Android application ID. Max length: 256 chars.", - "x-example": "" - } - }, - "required": [ - "name", - "applicationId" - ] - } - } - } - } - } - }, - "\/project\/platforms\/apple": { - "post": { - "summary": "Create project Apple platform", - "operationId": "projectCreateApplePlatform", + ] + }, + "put": { + "summary": "Update project mock phone", + "operationId": "projectUpdateMockPhone", "tags": [ "project" ], - "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update a mock phone by its unique number. Use this endpoint to update the mock phone's OTP.", "responses": { - "201": { - "description": "Platform Apple", + "200": { + "description": "Mock Number", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformApple" + "$ref": "#\/components\/schemas\/mockNumber" } } } @@ -42054,16 +42863,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createApplePlatform", - "group": "platforms", - "weight": 1053, + "method": "updateMockPhone", + "group": "mocks", + "weight": 1123, "cookies": false, "type": "", - "demo": "project\/create-apple-platform.md", + "demo": "project\/update-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -42080,54 +42889,109 @@ "Key": [] } ], + "parameters": [ + { + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", + "required": true, + "schema": { + "type": "string", + "format": "phone", + "x-example": "+12065550100" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" - }, - "bundleIdentifier": { + "otp": { "type": "string", - "description": "Apple bundle identifier. Max length: 256 chars.", - "x-example": "" + "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", + "x-example": "" } }, "required": [ - "platformId", - "name", - "bundleIdentifier" + "otp" ] } } } } + }, + "delete": { + "summary": "Delete project mock phone", + "operationId": "projectDeleteMockPhone", + "tags": [ + "project" + ], + "description": "Delete a mock phone by its unique number. This endpoint removes the mock phone and its OTP configuration from the project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteMockPhone", + "group": "mocks", + "weight": 1124, + "cookies": false, + "type": "", + "demo": "project\/delete-mock-phone.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "mocks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", + "required": true, + "schema": { + "type": "string", + "format": "phone", + "x-example": "+12065550100" + }, + "in": "path" + } + ] } }, - "\/project\/platforms\/apple\/{platformId}": { - "put": { - "summary": "Update project Apple platform", - "operationId": "projectUpdateApplePlatform", + "\/project\/oauth2": { + "get": { + "summary": "List project OAuth2 providers", + "operationId": "projectListOAuth2Providers", "tags": [ "project" ], - "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", + "description": "Get a list of all OAuth2 providers supported by the server, along with the project's configuration for each. Credential fields are write-only and always returned empty.", "responses": { "200": { - "description": "Platform Apple", + "description": "OAuth2 Providers List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformApple" + "$ref": "#\/components\/schemas\/oAuth2ProviderList" } } } @@ -42135,16 +42999,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateApplePlatform", - "group": "platforms", - "weight": 1048, + "method": "listOAuth2Providers", + "group": "oauth2", + "weight": 1137, "cookies": false, "type": "", - "demo": "project\/update-apple-platform.md", + "demo": "project\/list-o-auth-2-providers.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.read", "platforms": [ "console", "server" @@ -42160,17 +43024,55 @@ "Project": [], "Key": [] } + ] + } + }, + "\/project\/oauth2\/amazon": { + "patch": { + "summary": "Update project OAuth2 Amazon", + "operationId": "projectUpdateOAuth2Amazon", + "tags": [ + "project" ], - "parameters": [ + "description": "Update the project OAuth2 Amazon configuration.", + "responses": { + "200": { + "description": "OAuth2Amazon", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Amazon" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Amazon", + "group": "oauth2", + "weight": 1164, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-amazon.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -42179,42 +43081,46 @@ "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2", + "x-example": "", + "x-nullable": true }, - "bundleIdentifier": { + "clientSecret": { "type": "string", - "description": "Apple bundle identifier. Max length: 256 chars.", - "x-example": "" + "description": "'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "bundleIdentifier" - ] + } } } } } } }, - "\/project\/platforms\/linux": { - "post": { - "summary": "Create project Linux platform", - "operationId": "projectCreateLinuxPlatform", + "\/project\/oauth2\/apple": { + "patch": { + "summary": "Update project OAuth2 Apple", + "operationId": "projectUpdateOAuth2Apple", "tags": [ "project" ], - "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Apple configuration.", "responses": { - "201": { - "description": "Platform Linux", + "200": { + "description": "OAuth2Apple", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformLinux" + "$ref": "#\/components\/schemas\/oAuth2Apple" } } } @@ -42222,16 +43128,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLinuxPlatform", - "group": "platforms", - "weight": 1056, + "method": "updateOAuth2Apple", + "group": "oauth2", + "weight": 1179, "cookies": false, "type": "", - "demo": "project\/create-linux-platform.md", + "demo": "project\/update-o-auth-2-apple.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42254,48 +43160,58 @@ "schema": { "type": "object", "properties": { - "platformId": { + "serviceId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web", + "x-example": "", + "x-nullable": true }, - "name": { + "keyId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Key ID' of Apple OAuth2 app. For example: P4000000N8", + "x-example": "", + "x-nullable": true }, - "packageName": { + "teamId": { "type": "string", - "description": "Linux package name. Max length: 256 chars.", - "x-example": "" + "description": "'Team ID' of Apple OAuth2 app. For example: D4000000R6", + "x-example": "", + "x-nullable": true + }, + "p8File": { + "type": "string", + "description": "Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "packageName" - ] + } } } } } } }, - "\/project\/platforms\/linux\/{platformId}": { - "put": { - "summary": "Update project Linux platform", - "operationId": "projectUpdateLinuxPlatform", + "\/project\/oauth2\/auth0": { + "patch": { + "summary": "Update project OAuth2 Auth0", + "operationId": "projectUpdateOAuth2Auth0", "tags": [ "project" ], - "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", + "description": "Update the project OAuth2 Auth0 configuration.", "responses": { "200": { - "description": "Platform Linux", + "description": "OAuth2Auth0", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformLinux" + "$ref": "#\/components\/schemas\/oAuth2Auth0" } } } @@ -42303,16 +43219,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLinuxPlatform", - "group": "platforms", - "weight": 1051, + "method": "updateOAuth2Auth0", + "group": "oauth2", + "weight": 1173, "cookies": false, "type": "", - "demo": "project\/update-linux-platform.md", + "demo": "project\/update-o-auth-2-auth-0.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42329,60 +43245,58 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq", + "x-example": "", + "x-nullable": true }, - "packageName": { + "clientSecret": { "type": "string", - "description": "Linux package name. Max length: 256 chars.", - "x-example": "" + "description": "'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of Auth0 instance. For example: example.us.auth0.com", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "packageName" - ] + } } } } } } }, - "\/project\/platforms\/web": { - "post": { - "summary": "Create project web platform", - "operationId": "projectCreateWebPlatform", + "\/project\/oauth2\/authentik": { + "patch": { + "summary": "Update project OAuth2 Authentik", + "operationId": "projectUpdateOAuth2Authentik", "tags": [ "project" ], - "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Authentik configuration.", "responses": { - "201": { - "description": "Platform Web", + "200": { + "description": "OAuth2Authentik", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformWeb" + "$ref": "#\/components\/schemas\/oAuth2Authentik" } } } @@ -42390,16 +43304,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createWebPlatform", - "group": "platforms", - "weight": 1052, + "method": "updateOAuth2Authentik", + "group": "oauth2", + "weight": 1172, "cookies": false, "type": "", - "demo": "project\/create-web-platform.md", + "demo": "project\/update-o-auth-2-authentik.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42422,48 +43336,52 @@ "schema": { "type": "object", "properties": { - "platformId": { + "clientId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv", + "x-example": "", + "x-nullable": true }, - "name": { + "clientSecret": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", + "x-example": "", + "x-nullable": true }, - "hostname": { + "endpoint": { "type": "string", - "description": "Platform web hostname. Max length: 256 chars.", - "x-example": "app.example.com" + "description": "Domain of Authentik instance. For example: example.authentik.com", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "hostname" - ] + } } } } } } }, - "\/project\/platforms\/web\/{platformId}": { - "put": { - "summary": "Update project web platform", - "operationId": "projectUpdateWebPlatform", + "\/project\/oauth2\/autodesk": { + "patch": { + "summary": "Update project OAuth2 Autodesk", + "operationId": "projectUpdateOAuth2Autodesk", "tags": [ "project" ], - "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", + "description": "Update the project OAuth2 Autodesk configuration.", "responses": { "200": { - "description": "Platform Web", + "description": "OAuth2Autodesk", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformWeb" + "$ref": "#\/components\/schemas\/oAuth2Autodesk" } } } @@ -42471,16 +43389,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateWebPlatform", - "group": "platforms", - "weight": 1047, + "method": "updateOAuth2Autodesk", + "group": "oauth2", + "weight": 1147, "cookies": false, "type": "", - "demo": "project\/update-web-platform.md", + "demo": "project\/update-o-auth-2-autodesk.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42497,60 +43415,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7", + "x-example": "", + "x-nullable": true }, - "hostname": { + "clientSecret": { "type": "string", - "description": "Platform web hostname. Max length: 256 chars.", - "x-example": "app.example.com" + "description": "'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "hostname" - ] + } } } } } } }, - "\/project\/platforms\/windows": { - "post": { - "summary": "Create project Windows platform", - "operationId": "projectCreateWindowsPlatform", + "\/project\/oauth2\/bitbucket": { + "patch": { + "summary": "Update project OAuth2 Bitbucket", + "operationId": "projectUpdateOAuth2Bitbucket", "tags": [ "project" ], - "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Bitbucket configuration.", "responses": { - "201": { - "description": "Platform Windows", + "200": { + "description": "OAuth2Bitbucket", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformWindows" + "$ref": "#\/components\/schemas\/oAuth2Bitbucket" } } } @@ -42558,16 +43468,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createWindowsPlatform", - "group": "platforms", - "weight": 1055, + "method": "updateOAuth2Bitbucket", + "group": "oauth2", + "weight": 1144, "cookies": false, "type": "", - "demo": "project\/create-windows-platform.md", + "demo": "project\/update-o-auth-2-bitbucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42590,48 +43500,46 @@ "schema": { "type": "object", "properties": { - "platformId": { + "key": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc", + "x-example": "", + "x-nullable": true }, - "name": { + "secret": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx", + "x-example": "", + "x-nullable": true }, - "packageIdentifierName": { - "type": "string", - "description": "Windows package identifier name. Max length: 256 chars.", - "x-example": "" + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "packageIdentifierName" - ] + } } } } } } }, - "\/project\/platforms\/windows\/{platformId}": { - "put": { - "summary": "Update project Windows platform", - "operationId": "projectUpdateWindowsPlatform", + "\/project\/oauth2\/bitly": { + "patch": { + "summary": "Update project OAuth2 Bitly", + "operationId": "projectUpdateOAuth2Bitly", "tags": [ "project" ], - "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", + "description": "Update the project OAuth2 Bitly configuration.", "responses": { "200": { - "description": "Platform Windows", + "description": "OAuth2Bitly", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformWindows" + "$ref": "#\/components\/schemas\/oAuth2Bitly" } } } @@ -42639,16 +43547,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateWindowsPlatform", - "group": "platforms", - "weight": 1050, + "method": "updateOAuth2Bitly", + "group": "oauth2", + "weight": 1145, "cookies": false, "type": "", - "demo": "project\/update-windows-platform.md", + "demo": "project\/update-o-auth-2-bitly.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42665,86 +43573,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b", + "x-example": "", + "x-nullable": true }, - "packageIdentifierName": { + "clientSecret": { "type": "string", - "description": "Windows package identifier name. Max length: 256 chars.", - "x-example": "" + "description": "'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "packageIdentifierName" - ] + } } } } } } }, - "\/project\/platforms\/{platformId}": { - "get": { - "summary": "Get project platform", - "operationId": "projectGetPlatform", + "\/project\/oauth2\/box": { + "patch": { + "summary": "Update project OAuth2 Box", + "operationId": "projectUpdateOAuth2Box", "tags": [ "project" ], - "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", + "description": "Update the project OAuth2 Box configuration.", "responses": { "200": { - "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", + "description": "OAuth2Box", "content": { "application\/json": { "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/platformWeb" - }, - { - "$ref": "#\/components\/schemas\/platformApple" - }, - { - "$ref": "#\/components\/schemas\/platformAndroid" - }, - { - "$ref": "#\/components\/schemas\/platformWindows" - }, - { - "$ref": "#\/components\/schemas\/platformLinux" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/components\/schemas\/platformWeb", - "apple": "#\/components\/schemas\/platformApple", - "android": "#\/components\/schemas\/platformAndroid", - "windows": "#\/components\/schemas\/platformWindows", - "linux": "#\/components\/schemas\/platformLinux" - } - } + "$ref": "#\/components\/schemas\/oAuth2Box" } } } @@ -42752,16 +43626,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPlatform", - "group": "platforms", - "weight": 1057, + "method": "updateOAuth2Box", + "group": "oauth2", + "weight": 1146, "cookies": false, "type": "", - "demo": "project\/get-platform.md", + "demo": "project\/update-o-auth-2-box.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42778,43 +43652,69 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "delete": { - "summary": "Delete project platform", - "operationId": "projectDeletePlatform", + } + } + }, + "\/project\/oauth2\/dailymotion": { + "patch": { + "summary": "Update project OAuth2 Dailymotion", + "operationId": "projectUpdateOAuth2Dailymotion", "tags": [ "project" ], - "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", + "description": "Update the project OAuth2 Dailymotion configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Dailymotion", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Dailymotion" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deletePlatform", - "group": "platforms", - "weight": 1046, + "method": "updateOAuth2Dailymotion", + "group": "oauth2", + "weight": 1143, "cookies": false, "type": "", - "demo": "project\/delete-platform.md", + "demo": "project\/update-o-auth-2-dailymotion.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42831,35 +43731,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "apiKey": { + "type": "string", + "description": "'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f", + "x-example": "", + "x-nullable": true + }, + "apiSecret": { + "type": "string", + "description": "'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/project\/policies\/membership-privacy": { + "\/project\/oauth2\/discord": { "patch": { - "summary": "Update membership privacy policy", - "operationId": "projectUpdateMembershipPrivacyPolicy", + "summary": "Update project OAuth2 Discord", + "operationId": "projectUpdateOAuth2Discord", "tags": [ "project" ], - "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", + "description": "Update the project OAuth2 Discord configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Discord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Discord" } } } @@ -42867,16 +43784,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipPrivacyPolicy", - "group": "policies", - "weight": 1059, + "method": "updateOAuth2Discord", + "group": "oauth2", + "weight": 1140, "cookies": false, "type": "", - "demo": "project\/update-membership-privacy-policy.md", + "demo": "project\/update-o-auth-2-discord.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42899,30 +43816,23 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "boolean", - "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "x-example": false - }, - "userPhone": { - "type": "boolean", - "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", - "x-example": false + "clientId": { + "type": "string", + "description": "'Client ID' of Discord OAuth2 app. For example: 950722000000343754", + "x-example": "", + "x-nullable": true }, - "userName": { - "type": "boolean", - "description": "Set to true if you want make user name visible to all team members, or false to hide it.", - "x-example": false + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D", + "x-example": "", + "x-nullable": true }, - "userMFA": { + "enabled": { "type": "boolean", - "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } } } @@ -42931,21 +43841,21 @@ } } }, - "\/project\/policies\/password-dictionary": { + "\/project\/oauth2\/disqus": { "patch": { - "summary": "Update password dictionary policy", - "operationId": "projectUpdatePasswordDictionaryPolicy", + "summary": "Update project OAuth2 Disqus", + "operationId": "projectUpdateOAuth2Disqus", "tags": [ "project" ], - "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "description": "Update the project OAuth2 Disqus configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Disqus", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Disqus" } } } @@ -42953,16 +43863,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordDictionaryPolicy", - "group": "policies", - "weight": 1060, + "method": "updateOAuth2Disqus", + "group": "oauth2", + "weight": 1163, "cookies": false, "type": "", - "demo": "project\/update-password-dictionary-policy.md", + "demo": "project\/update-o-auth-2-disqus.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42985,36 +43895,46 @@ "schema": { "type": "object", "properties": { + "publicKey": { + "type": "string", + "description": "'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/password-history": { + "\/project\/oauth2\/dropbox": { "patch": { - "summary": "Update password history policy", - "operationId": "projectUpdatePasswordHistoryPolicy", + "summary": "Update project OAuth2 Dropbox", + "operationId": "projectUpdateOAuth2Dropbox", "tags": [ "project" ], - "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", + "description": "Update the project OAuth2 Dropbox configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Dropbox", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Dropbox" } } } @@ -43022,16 +43942,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordHistoryPolicy", - "group": "policies", - "weight": 1061, + "method": "updateOAuth2Dropbox", + "group": "oauth2", + "weight": 1142, "cookies": false, "type": "", - "demo": "project\/update-password-history-policy.md", + "demo": "project\/update-o-auth-2-dropbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43054,38 +43974,46 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", + "appKey": { + "type": "string", + "description": "'App Key' of Dropbox OAuth2 app. For example: jl000000000009t", + "x-example": "", + "x-nullable": true + }, + "appSecret": { + "type": "string", + "description": "'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } } } } }, - "\/project\/policies\/password-personal-data": { + "\/project\/oauth2\/etsy": { "patch": { - "summary": "Update password personal data policy", - "operationId": "projectUpdatePasswordPersonalDataPolicy", + "summary": "Update project OAuth2 Etsy", + "operationId": "projectUpdateOAuth2Etsy", "tags": [ "project" ], - "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", + "description": "Update the project OAuth2 Etsy configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Etsy", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Etsy" } } } @@ -43093,16 +44021,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordPersonalDataPolicy", - "group": "policies", - "weight": 1062, + "method": "updateOAuth2Etsy", + "group": "oauth2", + "weight": 1165, "cookies": false, "type": "", - "demo": "project\/update-password-personal-data-policy.md", + "demo": "project\/update-o-auth-2-etsy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43125,36 +44053,46 @@ "schema": { "type": "object", "properties": { + "keyString": { + "type": "string", + "description": "'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2", + "x-example": "", + "x-nullable": true + }, + "sharedSecret": { + "type": "string", + "description": "'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/session-alert": { + "\/project\/oauth2\/facebook": { "patch": { - "summary": "Update session alert policy", - "operationId": "projectUpdateSessionAlertPolicy", + "summary": "Update project OAuth2 Facebook", + "operationId": "projectUpdateOAuth2Facebook", "tags": [ "project" ], - "description": "Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.", + "description": "Update the project OAuth2 Facebook configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Facebook", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Facebook" } } } @@ -43162,16 +44100,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSessionAlertPolicy", - "group": "policies", - "weight": 1063, + "method": "updateOAuth2Facebook", + "group": "oauth2", + "weight": 1166, "cookies": false, "type": "", - "demo": "project\/update-session-alert-policy.md", + "demo": "project\/update-o-auth-2-facebook.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43194,36 +44132,46 @@ "schema": { "type": "object", "properties": { + "appId": { + "type": "string", + "description": "'App ID' of Facebook OAuth2 app. For example: 260600000007694", + "x-example": "", + "x-nullable": true + }, + "appSecret": { + "type": "string", + "description": "'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/session-duration": { + "\/project\/oauth2\/figma": { "patch": { - "summary": "Update session duration policy", - "operationId": "projectUpdateSessionDurationPolicy", + "summary": "Update project OAuth2 Figma", + "operationId": "projectUpdateOAuth2Figma", "tags": [ "project" ], - "description": "Update maximum duration how long sessions created within a project should stay active for.", + "description": "Update the project OAuth2 Figma configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Figma", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Figma" } } } @@ -43231,16 +44179,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSessionDurationPolicy", - "group": "policies", - "weight": 1064, + "method": "updateOAuth2Figma", + "group": "oauth2", + "weight": 1141, "cookies": false, "type": "", - "demo": "project\/update-session-duration-policy.md", + "demo": "project\/update-o-auth-2-figma.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43263,37 +44211,46 @@ "schema": { "type": "object", "properties": { - "duration": { - "type": "integer", - "description": "Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.", - "x-example": 5, - "format": "int32" + "clientId": { + "type": "string", + "description": "'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "duration" - ] + } } } } } } }, - "\/project\/policies\/session-invalidation": { + "\/project\/oauth2\/fusionauth": { "patch": { - "summary": "Update session invalidation policy", - "operationId": "projectUpdateSessionInvalidationPolicy", + "summary": "Update project OAuth2 FusionAuth", + "operationId": "projectUpdateOAuth2FusionAuth", "tags": [ "project" ], - "description": "Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.", + "description": "Update the project OAuth2 FusionAuth configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2FusionAuth", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2FusionAuth" } } } @@ -43301,16 +44258,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSessionInvalidationPolicy", - "group": "policies", - "weight": 1065, + "method": "updateOAuth2FusionAuth", + "group": "oauth2", + "weight": 1174, "cookies": false, "type": "", - "demo": "project\/update-session-invalidation-policy.md", + "demo": "project\/update-o-auth-2-fusion-auth.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43333,36 +44290,52 @@ "schema": { "type": "object", "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc", + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of FusionAuth instance. For example: example.fusionauth.io", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/session-limit": { + "\/project\/oauth2\/github": { "patch": { - "summary": "Update session limit policy", - "operationId": "projectUpdateSessionLimitPolicy", + "summary": "Update project OAuth2 GitHub", + "operationId": "projectUpdateOAuth2GitHub", "tags": [ "project" ], - "description": "Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.", + "description": "Update the project OAuth2 GitHub configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2GitHub", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Github" } } } @@ -43370,16 +44343,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSessionLimitPolicy", - "group": "policies", - "weight": 1066, + "method": "updateOAuth2GitHub", + "group": "oauth2", + "weight": 1139, "cookies": false, "type": "", - "demo": "project\/update-session-limit-policy.md", + "demo": "project\/update-o-auth-2-git-hub.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43402,38 +44375,46 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", + "clientId": { + "type": "string", + "description": "'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } } } } }, - "\/project\/policies\/user-limit": { + "\/project\/oauth2\/gitlab": { "patch": { - "summary": "Update user limit policy", - "operationId": "projectUpdateUserLimitPolicy", + "summary": "Update project OAuth2 Gitlab", + "operationId": "projectUpdateOAuth2Gitlab", "tags": [ "project" ], - "description": "Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.", + "description": "Update the project OAuth2 Gitlab configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Gitlab", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Gitlab" } } } @@ -43441,16 +44422,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateUserLimitPolicy", - "group": "policies", - "weight": 1067, + "method": "updateOAuth2Gitlab", + "group": "oauth2", + "weight": 1171, "cookies": false, "type": "", - "demo": "project\/update-user-limit-policy.md", + "demo": "project\/update-o-auth-2-gitlab.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43473,38 +44454,53 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", + "applicationId": { + "type": "string", + "description": "'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "string", + "description": "'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Endpoint URL of self-hosted GitLab instance. For example: https:\/\/gitlab.com", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } } } } }, - "\/project\/protocols\/{protocolId}": { + "\/project\/oauth2\/google": { "patch": { - "summary": "Update project protocol", - "operationId": "projectUpdateProtocol", + "summary": "Update project OAuth2 Google", + "operationId": "projectUpdateOAuth2Google", "tags": [ "project" ], - "description": "Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project. ", + "description": "Update the project OAuth2 Google configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Google", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Google" } } } @@ -43512,16 +44508,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateProtocol", - "group": null, - "weight": 1030, + "method": "updateOAuth2Google", + "group": "oauth2", + "weight": 1148, "cookies": false, "type": "", - "demo": "project\/update-protocol.md", + "demo": "project\/update-o-auth-2-google.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43538,61 +44534,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "protocolId", - "description": "Protocol name. Can be one of: rest, graphql, websocket", - "required": true, - "schema": { - "type": "string", - "x-example": "rest", - "enum": [ - "rest", - "graphql", - "websocket" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Protocol status.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/services\/{serviceId}": { + "\/project\/oauth2\/keycloak": { "patch": { - "summary": "Update project service", - "operationId": "projectUpdateService", + "summary": "Update project OAuth2 Keycloak", + "operationId": "projectUpdateOAuth2Keycloak", "tags": [ "project" ], - "description": "Update properties of a specific service. Use this endpoint to enable or disable a service in your project. ", + "description": "Update the project OAuth2 Keycloak configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Keycloak", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Keycloak" } } } @@ -43600,16 +44587,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateService", - "group": null, - "weight": 1031, + "method": "updateOAuth2Keycloak", + "group": "oauth2", + "weight": 1175, "cookies": false, "type": "", - "demo": "project\/update-service.md", + "demo": "project\/update-o-auth-2-keycloak.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43626,75 +44613,64 @@ "Key": [] } ], - "parameters": [ - { - "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", - "required": true, - "schema": { - "type": "string", - "x-example": "account", - "enum": [ - "account", - "avatars", - "databases", - "tablesdb", - "locale", - "health", - "project", - "storage", - "teams", - "users", - "vcs", - "sites", - "functions", - "proxy", - "graphql", - "migrations", - "messaging" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO", + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of Keycloak instance. For example: keycloak.example.com", + "x-example": "", + "x-nullable": true + }, + "realmName": { + "type": "string", + "description": "Keycloak realm name. For example: appwrite-realm", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Service status.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/smtp": { + "\/project\/oauth2\/kick": { "patch": { - "summary": "Update project SMTP configuration", - "operationId": "projectUpdateSMTP", + "summary": "Update project OAuth2 Kick", + "operationId": "projectUpdateOAuth2Kick", "tags": [ "project" ], - "description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.", + "description": "Update the project OAuth2 Kick configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Kick", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Kick" } } } @@ -43702,16 +44678,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSMTP", - "group": "smtp", - "weight": 1032, + "method": "updateOAuth2Kick", + "group": "oauth2", + "weight": 1178, "cookies": false, "type": "", - "demo": "project\/update-smtp.md", + "demo": "project\/update-o-auth-2-kick.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43734,73 +44710,22 @@ "schema": { "type": "object", "properties": { - "host": { + "clientId": { "type": "string", - "description": "SMTP server hostname (domain)", - "x-example": null, - "x-nullable": true - }, - "port": { - "type": "integer", - "description": "SMTP server port", - "x-example": null, - "format": "int32", - "x-nullable": true - }, - "username": { - "type": "string", - "description": "SMTP server username. Leave empty for no authorization.", - "x-example": "", - "x-nullable": true - }, - "password": { - "type": "string", - "description": "SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).", - "x-example": "", + "description": "'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32", + "x-example": "", "x-nullable": true }, - "senderEmail": { + "clientSecret": { "type": "string", - "description": "Email address shown in inbox as the sender of the email.", - "x-example": "email@example.com", - "format": "email", + "description": "'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b", + "x-example": "", "x-nullable": true }, - "senderName": { - "type": "string", - "description": "Name shown in inbox as the sender of the email.", - "x-example": "", - "x-nullable": true - }, - "replyToEmail": { - "type": "string", - "description": "Email used when user replies to the email.", - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "replyToName": { - "type": "string", - "description": "Name used when user replies to the email.", - "x-example": "", - "x-nullable": true - }, - "secure": { - "type": "string", - "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", - "x-example": "tls", - "enum": [ - "tls", - "ssl" - ], - "x-enum-name": null, - "x-enum-keys": [], - "x-nullable": true - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", - "x-example": false, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } } @@ -43810,31 +44735,38 @@ } } }, - "\/project\/smtp\/tests": { - "post": { - "summary": "Create project SMTP test", - "operationId": "projectCreateSMTPTest", + "\/project\/oauth2\/linkedin": { + "patch": { + "summary": "Update project OAuth2 Linkedin", + "operationId": "projectUpdateOAuth2Linkedin", "tags": [ "project" ], - "description": "Send a test email to verify SMTP configuration. ", + "description": "Update the project OAuth2 Linkedin configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Linkedin", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Linkedin" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "createSMTPTest", - "group": "smtp", - "weight": 1033, + "method": "updateOAuth2Linkedin", + "group": "oauth2", + "weight": 1162, "cookies": false, "type": "", - "demo": "project\/create-smtp-test.md", + "demo": "project\/update-o-auth-2-linkedin.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43857,39 +44789,46 @@ "schema": { "type": "object", "properties": { - "emails": { - "type": "array", - "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", - "x-example": null, - "items": { - "type": "string" - } + "clientId": { + "type": "string", + "description": "'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv", + "x-example": "", + "x-nullable": true + }, + "primaryClientSecret": { + "type": "string", + "description": "'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000.\/HtlYw==", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "emails" - ] + } } } } } } }, - "\/project\/templates\/email": { + "\/project\/oauth2\/microsoft": { "patch": { - "summary": "Update project email template", - "operationId": "projectUpdateEmailTemplate", + "summary": "Update project OAuth2 Microsoft", + "operationId": "projectUpdateOAuth2Microsoft", "tags": [ "project" ], - "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", + "description": "Update the project OAuth2 Microsoft configuration.", "responses": { "200": { - "description": "EmailTemplate", + "description": "OAuth2Microsoft", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/emailTemplate" + "$ref": "#\/components\/schemas\/oAuth2Microsoft" } } } @@ -43897,16 +44836,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailTemplate", - "group": "templates", - "weight": 1035, + "method": "updateOAuth2Microsoft", + "group": "oauth2", + "weight": 1180, "cookies": false, "type": "", - "demo": "project\/update-email-template.md", + "demo": "project\/update-o-auth-2-microsoft.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "templates.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43929,225 +44868,52 @@ "schema": { "type": "object", "properties": { - "templateId": { - "type": "string", - "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [] - }, - "locale": { - "type": "string", - "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [] - }, - "subject": { - "type": "string", - "description": "Subject of the email template. Can be up to 255 characters.", - "x-example": "", - "x-nullable": true - }, - "message": { - "type": "string", - "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", - "x-example": "", - "x-nullable": true - }, - "senderName": { + "applicationId": { "type": "string", - "description": "Name of the email sender.", - "x-example": "", + "description": "'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444", + "x-example": "", "x-nullable": true }, - "senderEmail": { + "applicationSecret": { "type": "string", - "description": "Email of the sender.", - "x-example": "email@example.com", - "format": "email", + "description": "'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", + "x-example": "", "x-nullable": true }, - "replyToEmail": { + "tenant": { "type": "string", - "description": "Reply to email.", - "x-example": "email@example.com", - "format": "email", + "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common", + "x-example": "", "x-nullable": true }, - "replyToName": { - "type": "string", - "description": "Reply to name.", - "x-example": "", + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } - }, - "required": [ - "templateId" - ] + } } } } } } }, - "\/project\/templates\/email\/{templateId}": { - "get": { - "summary": "Get project email template", - "operationId": "projectGetEmailTemplate", + "\/project\/oauth2\/notion": { + "patch": { + "summary": "Update project OAuth2 Notion", + "operationId": "projectUpdateOAuth2Notion", "tags": [ "project" ], - "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.", + "description": "Update the project OAuth2 Notion configuration.", "responses": { "200": { - "description": "EmailTemplate", + "description": "OAuth2Notion", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/emailTemplate" + "$ref": "#\/components\/schemas\/oAuth2Notion" } } } @@ -44155,16 +44921,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getEmailTemplate", - "group": "templates", - "weight": 1034, + "method": "updateOAuth2Notion", + "group": "oauth2", + "weight": 1159, "cookies": false, "type": "", - "demo": "project\/get-email-template.md", + "demo": "project\/update-o-auth-2-notion.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "templates.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44181,192 +44947,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "templateId", - "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", - "required": true, - "schema": { - "type": "string", - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [] - }, - "in": "path" - }, - { - "name": "locale", - "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "required": false, - "schema": { - "type": "string", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [], - "default": "" - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "oauthClientId": { + "type": "string", + "description": "'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3", + "x-example": "", + "x-nullable": true + }, + "oauthClientSecret": { + "type": "string", + "description": "'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/project\/usage": { - "get": { - "summary": "Get project usage stats", - "operationId": "projectGetUsage", + "\/project\/oauth2\/oidc": { + "patch": { + "summary": "Update project OAuth2 Oidc", + "operationId": "projectUpdateOAuth2Oidc", "tags": [ "project" ], - "description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.", + "description": "Update the project OAuth2 Oidc configuration.", "responses": { "200": { - "description": "UsageProject", + "description": "OAuth2Oidc", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageProject" + "$ref": "#\/components\/schemas\/oAuth2Oidc" } } } @@ -44374,92 +45000,106 @@ }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 630, + "method": "updateOAuth2Oidc", + "group": "oauth2", + "weight": 1176, "cookies": false, "type": "", - "demo": "project\/get-usage.md", + "demo": "project\/update-o-auth-2-oidc.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "startDate", - "description": "Starting date for the usage", - "required": true, - "schema": { - "type": "string", - "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "in": "query" - }, - { - "name": "endDate", - "description": "End date for the usage", - "required": true, - "schema": { - "type": "string", - "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "in": "query" - }, - { - "name": "period", - "description": "Period used", - "required": false, - "schema": { - "type": "string", - "x-example": "1h", - "enum": [ - "1h", - "1d" - ], - "x-enum-name": "ProjectUsageRange", - "x-enum-keys": [ - "One Hour", - "One Day" - ], - "default": "1d" - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", + "x-example": "", + "x-nullable": true + }, + "wellKnownURL": { + "type": "string", + "description": "OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https:\/\/myoauth.com\/.well-known\/openid-configuration", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "authorizationURL": { + "type": "string", + "description": "OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/authorize", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "tokenUrl": { + "type": "string", + "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "userInfoUrl": { + "type": "string", + "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/project\/variables": { - "get": { - "summary": "List project variables", - "operationId": "projectListVariables", + "\/project\/oauth2\/okta": { + "patch": { + "summary": "Update project OAuth2 Okta", + "operationId": "projectUpdateOAuth2Okta", "tags": [ "project" ], - "description": "Get a list of all project environment variables.", + "description": "Update the project OAuth2 Okta configuration.", "responses": { "200": { - "description": "Variables List", + "description": "OAuth2Okta", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variableList" + "$ref": "#\/components\/schemas\/oAuth2Okta" } } } @@ -44467,16 +45107,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 1037, + "method": "updateOAuth2Okta", + "group": "oauth2", + "weight": 1177, "cookies": false, "type": "", - "demo": "project\/list-variables.md", + "demo": "project\/update-o-auth-2-okta.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44493,47 +45133,64 @@ "Key": [] } ], - "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: key, resourceType, resourceId, secret", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "x-example": "", + "x-nullable": true + }, + "domain": { + "type": "string", + "description": "Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https:\/\/trial-6400025.okta.com\/", + "x-example": null, + "x-nullable": true + }, + "authorizationServerId": { + "type": "string", + "description": "Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", + } + } + }, + "\/project\/oauth2\/paypal": { + "patch": { + "summary": "Update project OAuth2 Paypal", + "operationId": "projectUpdateOAuth2Paypal", "tags": [ "project" ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "description": "Update the project OAuth2 Paypal configuration.", "responses": { - "201": { - "description": "Variable", + "200": { + "description": "OAuth2Paypal", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/oAuth2Paypal" } } } @@ -44541,16 +45198,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 1036, + "method": "updateOAuth2Paypal", + "group": "oauth2", + "weight": 1169, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "project\/update-o-auth-2-paypal.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44573,53 +45230,46 @@ "schema": { "type": "object", "properties": { - "variableId": { - "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "key": { + "clientId": { "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "description": "'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "x-example": "", + "x-nullable": true }, - "value": { + "secretKey": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "" + "description": "'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", + "x-example": "", + "x-nullable": true }, - "secret": { + "enabled": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "variableId", - "key", - "value" - ] + } } } } } } }, - "\/project\/variables\/{variableId}": { - "get": { - "summary": "Get project variable", - "operationId": "projectGetVariable", + "\/project\/oauth2\/paypalSandbox": { + "patch": { + "summary": "Update project OAuth2 PaypalSandbox", + "operationId": "projectUpdateOAuth2PaypalSandbox", "tags": [ "project" ], - "description": "Get a variable by its unique ID. ", + "description": "Update the project OAuth2 PaypalSandbox configuration.", "responses": { "200": { - "description": "Variable", + "description": "OAuth2Paypal", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/oAuth2Paypal" } } } @@ -44627,16 +45277,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 1038, + "method": "updateOAuth2PaypalSandbox", + "group": "oauth2", + "weight": 1170, "cookies": false, "type": "", - "demo": "project\/get-variable.md", + "demo": "project\/update-o-auth-2-paypal-sandbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44653,33 +45303,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "put": { - "summary": "Update project variable", - "operationId": "projectUpdateVariable", + } + } + }, + "\/project\/oauth2\/podio": { + "patch": { + "summary": "Update project OAuth2 Podio", + "operationId": "projectUpdateOAuth2Podio", "tags": [ "project" ], - "description": "Update variable by its unique ID.", + "description": "Update the project OAuth2 Podio configuration.", "responses": { "200": { - "description": "Variable", + "description": "OAuth2Podio", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/oAuth2Podio" } } } @@ -44687,16 +45356,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 1040, + "method": "updateOAuth2Podio", + "group": "oauth2", + "weight": 1158, "cookies": false, "type": "", - "demo": "project\/update-variable.md", + "demo": "project\/update-o-auth-2-podio.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44713,39 +45382,27 @@ "Key": [] } ], - "parameters": [ - { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "key": { + "clientId": { "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "", + "description": "'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app", + "x-example": "", "x-nullable": true }, - "value": { + "clientSecret": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "", + "description": "'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN", + "x-example": "", "x-nullable": true }, - "secret": { + "enabled": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "x-example": false, "x-nullable": true } @@ -44754,31 +45411,40 @@ } } } - }, - "delete": { - "summary": "Delete project variable", - "operationId": "projectDeleteVariable", + } + }, + "\/project\/oauth2\/salesforce": { + "patch": { + "summary": "Update project OAuth2 Salesforce", + "operationId": "projectUpdateOAuth2Salesforce", "tags": [ "project" ], - "description": "Delete a variable by its unique ID. ", + "description": "Update the project OAuth2 Salesforce configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Salesforce", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Salesforce" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 1039, + "method": "updateOAuth2Salesforce", + "group": "oauth2", + "weight": 1160, "cookies": false, "type": "", - "demo": "project\/delete-variable.md", + "demo": "project\/update-o-auth-2-salesforce.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44795,35 +45461,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "customerKey": { + "type": "string", + "description": "'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", + "x-example": "", + "x-nullable": true + }, + "customerSecret": { + "type": "string", + "description": "'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/projects": { - "get": { - "summary": "List projects", - "operationId": "projectsList", + "\/project\/oauth2\/slack": { + "patch": { + "summary": "Update project OAuth2 Slack", + "operationId": "projectUpdateOAuth2Slack", "tags": [ - "projects" + "project" ], - "description": "Get a list of all projects. You can use the query params to filter your results. ", + "description": "Update the project OAuth2 Slack configuration.", "responses": { "200": { - "description": "Projects List", + "description": "OAuth2Slack", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/projectList" + "$ref": "#\/components\/schemas\/oAuth2Slack" } } } @@ -44831,18 +45514,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "projects", - "weight": 1027, + "method": "updateOAuth2Slack", + "group": "oauth2", + "weight": 1157, "cookies": false, "type": "", - "demo": "projects\/list.md", + "demo": "project\/update-o-auth-2-slack.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -44852,61 +45536,56 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "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: name, teamId, labels, search", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "post": { - "summary": "Create project", - "operationId": "projectsCreate", + } + } + }, + "\/project\/oauth2\/spotify": { + "patch": { + "summary": "Update project OAuth2 Spotify", + "operationId": "projectUpdateOAuth2Spotify", "tags": [ - "projects" + "project" ], - "description": "Create a new project. You can create a maximum of 100 projects per account. ", + "description": "Update the project OAuth2 Spotify configuration.", "responses": { - "201": { - "description": "Project", + "200": { + "description": "OAuth2Spotify", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Spotify" } } } @@ -44914,29 +45593,30 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "projects", - "weight": 1025, + "method": "updateOAuth2Spotify", + "group": "oauth2", + "weight": 1156, "cookies": false, "type": "", - "demo": "projects\/create.md", + "demo": "project\/update-o-auth-2-spotify.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "requestBody": { @@ -44945,109 +45625,46 @@ "schema": { "type": "object", "properties": { - "projectId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", - "x-example": null - }, - "name": { - "type": "string", - "description": "Project name. Max length: 128 chars.", - "x-example": "" - }, - "teamId": { - "type": "string", - "description": "Team unique ID.", - "x-example": "" - }, - "region": { - "type": "string", - "description": "Project Region.", - "x-example": "fra", - "enum": [ - "fra", - "nyc", - "syd", - "sfo", - "sgp", - "tor" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "description": { + "clientId": { "type": "string", - "description": "Project description. Max length: 256 chars.", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "legalName": { - "type": "string", - "description": "Project legal Name. Max length: 256 chars.", - "x-example": "" - }, - "legalCountry": { - "type": "string", - "description": "Project legal Country. Max length: 256 chars.", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal State. Max length: 256 chars.", - "x-example": "" - }, - "legalCity": { - "type": "string", - "description": "Project legal City. Max length: 256 chars.", - "x-example": "" + "description": "'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace", + "x-example": "", + "x-nullable": true }, - "legalAddress": { + "clientSecret": { "type": "string", - "description": "Project legal Address. Max length: 256 chars.", - "x-example": "" + "description": "'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f", + "x-example": "", + "x-nullable": true }, - "legalTaxId": { - "type": "string", - "description": "Project legal Tax ID. Max length: 256 chars.", - "x-example": "" + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "projectId", - "name", - "teamId" - ] + } } } } } } }, - "\/projects\/{projectId}": { - "get": { - "summary": "Get project", - "operationId": "projectsGet", + "\/project\/oauth2\/stripe": { + "patch": { + "summary": "Update project OAuth2 Stripe", + "operationId": "projectUpdateOAuth2Stripe", "tags": [ - "projects" + "project" ], - "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", + "description": "Update the project OAuth2 Stripe configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Stripe", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Stripe" } } } @@ -45055,58 +45672,78 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "projects", - "weight": 57, + "method": "updateOAuth2Stripe", + "group": "oauth2", + "weight": 1155, "cookies": false, "type": "", - "demo": "projects\/get.md", + "demo": "project\/update-o-auth-2-stripe.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR", + "x-example": "", + "x-nullable": true + }, + "apiSecretKey": { + "type": "string", + "description": "'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, + } + } + }, + "\/project\/oauth2\/tradeshift": { "patch": { - "summary": "Update project", - "operationId": "projectsUpdate", + "summary": "Update project OAuth2 Tradeshift", + "operationId": "projectUpdateOAuth2Tradeshift", "tags": [ - "projects" + "project" ], - "description": "Update a project by its unique ID.", + "description": "Update the project OAuth2 Tradeshift configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Tradeshift", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Tradeshift" } } } @@ -45114,41 +45751,30 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "projects", - "weight": 1026, + "method": "updateOAuth2Tradeshift", + "group": "oauth2", + "weight": 1167, "cookies": false, "type": "", - "demo": "projects\/update.md", + "demo": "project\/update-o-auth-2-tradeshift.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -45157,134 +45783,125 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Project name. Max length: 128 chars.", - "x-example": "" - }, - "description": { - "type": "string", - "description": "Project description. Max length: 256 chars.", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "legalName": { - "type": "string", - "description": "Project legal name. Max length: 256 chars.", - "x-example": "" - }, - "legalCountry": { - "type": "string", - "description": "Project legal country. Max length: 256 chars.", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal state. Max length: 256 chars.", - "x-example": "" - }, - "legalCity": { + "oauth2ClientId": { "type": "string", - "description": "Project legal city. Max length: 256 chars.", - "x-example": "" + "description": "'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app", + "x-example": "", + "x-nullable": true }, - "legalAddress": { + "oauth2ClientSecret": { "type": "string", - "description": "Project legal address. Max length: 256 chars.", - "x-example": "" + "description": "'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", + "x-example": "", + "x-nullable": true }, - "legalTaxId": { - "type": "string", - "description": "Project legal tax ID. Max length: 256 chars.", - "x-example": "" + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name" - ] + } } } } } - }, - "delete": { - "summary": "Delete project", - "operationId": "projectsDelete", + } + }, + "\/project\/oauth2\/tradeshiftBox": { + "patch": { + "summary": "Update project OAuth2 Tradeshift Sandbox", + "operationId": "projectUpdateOAuth2TradeshiftSandbox", "tags": [ - "projects" + "project" ], - "description": "Delete a project by its unique ID.", + "description": "Update the project OAuth2 Tradeshift Sandbox configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Tradeshift", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Tradeshift" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "projects", - "weight": 63, + "method": "updateOAuth2TradeshiftSandbox", + "group": "oauth2", + "weight": 1168, "cookies": false, "type": "", - "demo": "projects\/delete.md", + "demo": "project\/update-o-auth-2-tradeshift-sandbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "oauth2ClientId": { + "type": "string", + "description": "'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app", + "x-example": "", + "x-nullable": true + }, + "oauth2ClientSecret": { + "type": "string", + "description": "'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/projects\/{projectId}\/auth\/mock-numbers": { + "\/project\/oauth2\/twitch": { "patch": { - "summary": "Update the mock numbers for the project", - "operationId": "projectsUpdateMockNumbers", + "summary": "Update project OAuth2 Twitch", + "operationId": "projectUpdateOAuth2Twitch", "tags": [ - "projects" + "project" ], - "description": "Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. ", + "description": "Update the project OAuth2 Twitch configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Twitch", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Twitch" } } } @@ -45292,41 +45909,30 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMockNumbers", - "group": "auth", - "weight": 62, + "method": "updateOAuth2Twitch", + "group": "oauth2", + "weight": 1154, "cookies": false, "type": "", - "demo": "projects\/update-mock-numbers.md", + "demo": "project\/update-o-auth-2-twitch.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -45335,39 +45941,46 @@ "schema": { "type": "object", "properties": { - "numbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.", - "x-example": null, - "items": { - "type": "object" - } + "clientId": { + "type": "string", + "description": "'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "numbers" - ] + } } } } } } }, - "\/projects\/{projectId}\/auth\/{method}": { + "\/project\/oauth2\/wordpress": { "patch": { - "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", - "operationId": "projectsUpdateAuthStatus", + "summary": "Update project OAuth2 WordPress", + "operationId": "projectUpdateOAuth2WordPress", "tags": [ - "projects" + "project" ], - "description": "Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project. ", + "description": "Update the project OAuth2 WordPress configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2WordPress", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2WordPress" } } } @@ -45375,62 +45988,30 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAuthStatus", - "group": "auth", - "weight": 61, + "method": "updateOAuth2WordPress", + "group": "oauth2", + "weight": 1153, "cookies": false, "type": "", - "demo": "projects\/update-auth-status.md", + "demo": "project\/update-o-auth-2-word-press.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "method", - "description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", - "required": true, - "schema": { - "type": "string", - "x-example": "email-password", - "enum": [ - "email-password", - "magic-url", - "email-otp", - "anonymous", - "invites", - "jwt", - "phone" - ], - "x-enum-name": "AuthMethod", - "x-enum-keys": [] - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -45439,90 +46020,125 @@ "schema": { "type": "object", "properties": { - "status": { + "clientId": { + "type": "string", + "description": "'Client ID' of WordPress OAuth2 app. For example: 130005", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk", + "x-example": "", + "x-nullable": true + }, + "enabled": { "type": "boolean", - "description": "Set the status of this auth method.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "status" - ] + } } } } } } }, - "\/projects\/{projectId}\/console-access": { + "\/project\/oauth2\/x": { "patch": { - "summary": "Record console access to a project", - "operationId": "projectsUpdateConsoleAccess", + "summary": "Update project OAuth2 X", + "operationId": "projectUpdateOAuth2X", "tags": [ - "projects" + "project" ], - "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", + "description": "Update the project OAuth2 X configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2X", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2X" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "updateConsoleAccess", - "group": null, - "weight": 1022, + "method": "updateOAuth2X", + "group": "oauth2", + "weight": 1152, "cookies": false, "type": "", - "demo": "projects\/update-console-access.md", + "demo": "project\/update-o-auth-2x.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "projectId", - "description": "Project ID", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "customerKey": { + "type": "string", + "description": "'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT", + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/projects\/{projectId}\/dev-keys": { - "get": { - "summary": "List dev keys", - "operationId": "projectsListDevKeys", + "\/project\/oauth2\/yahoo": { + "patch": { + "summary": "Update project OAuth2 Yahoo", + "operationId": "projectUpdateOAuth2Yahoo", "tags": [ - "projects" + "project" ], - "description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", + "description": "Update the project OAuth2 Yahoo configuration.", "responses": { "200": { - "description": "Dev Keys List", + "description": "OAuth2Yahoo", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/devKeyList" + "$ref": "#\/components\/schemas\/oAuth2Yahoo" } } } @@ -45530,18 +46146,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "listDevKeys", - "group": "devKeys", - "weight": 425, + "method": "updateOAuth2Yahoo", + "group": "oauth2", + "weight": 1161, "cookies": false, "type": "", - "demo": "projects\/list-dev-keys.md", + "demo": "project\/update-o-auth-2-yahoo.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45551,49 +46168,56 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: accessedAt, expire", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "post": { - "summary": "Create dev key", - "operationId": "projectsCreateDevKey", + } + } + }, + "\/project\/oauth2\/yandex": { + "patch": { + "summary": "Update project OAuth2 Yandex", + "operationId": "projectUpdateOAuth2Yandex", "tags": [ - "projects" + "project" ], - "description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", + "description": "Update the project OAuth2 Yandex configuration.", "responses": { - "201": { - "description": "DevKey", + "200": { + "description": "OAuth2Yandex", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/devKey" + "$ref": "#\/components\/schemas\/oAuth2Yandex" } } } @@ -45601,18 +46225,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDevKey", - "group": "devKeys", - "weight": 422, + "method": "updateOAuth2Yandex", + "group": "oauth2", + "weight": 1151, "cookies": false, "type": "", - "demo": "projects\/create-dev-key.md", + "demo": "project\/update-o-auth-2-yandex.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45622,19 +46247,8 @@ }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -45643,43 +46257,46 @@ "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Key name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c", + "x-example": "", + "x-nullable": true }, - "expire": { + "clientSecret": { "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime" + "description": "'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "expire" - ] + } } } } } } }, - "\/projects\/{projectId}\/dev-keys\/{keyId}": { - "get": { - "summary": "Get dev key", - "operationId": "projectsGetDevKey", + "\/project\/oauth2\/zoho": { + "patch": { + "summary": "Update project OAuth2 Zoho", + "operationId": "projectUpdateOAuth2Zoho", "tags": [ - "projects" + "project" ], - "description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", + "description": "Update the project OAuth2 Zoho configuration.", "responses": { "200": { - "description": "DevKey", + "description": "OAuth2Zoho", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/devKey" + "$ref": "#\/components\/schemas\/oAuth2Zoho" } } } @@ -45687,18 +46304,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "getDevKey", - "group": "devKeys", - "weight": 424, + "method": "updateOAuth2Zoho", + "group": "oauth2", + "weight": 1150, "cookies": false, "type": "", - "demo": "projects\/get-dev-key.md", + "demo": "project\/update-o-auth-2-zoho.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45708,46 +46326,56 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "put": { - "summary": "Update dev key", - "operationId": "projectsUpdateDevKey", + } + } + }, + "\/project\/oauth2\/zoom": { + "patch": { + "summary": "Update project OAuth2 Zoom", + "operationId": "projectUpdateOAuth2Zoom", "tags": [ - "projects" + "project" ], - "description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", + "description": "Update the project OAuth2 Zoom configuration.", "responses": { "200": { - "description": "DevKey", + "description": "OAuth2Zoom", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/devKey" + "$ref": "#\/components\/schemas\/oAuth2Zoom" } } } @@ -45755,18 +46383,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDevKey", - "group": "devKeys", - "weight": 423, + "method": "updateOAuth2Zoom", + "group": "oauth2", + "weight": 1149, "cookies": false, "type": "", - "demo": "projects\/update-dev-key.md", + "demo": "project\/update-o-auth-2-zoom.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45776,29 +46405,8 @@ }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -45807,53 +46415,234 @@ "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Key name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ", + "x-example": "", + "x-nullable": true }, - "expire": { + "clientSecret": { "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime" + "description": "'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "expire" - ] + } } } } } - }, - "delete": { - "summary": "Delete dev key", - "operationId": "projectsDeleteDevKey", + } + }, + "\/project\/oauth2\/{provider}": { + "get": { + "summary": "Get project OAuth2 provider", + "operationId": "projectGetOAuth2Provider", "tags": [ - "projects" + "project" ], - "description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", + "description": "Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key\/team IDs) are write-only and always returned empty.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2GitHub, or OAuth2Discord, or OAuth2Figma, or OAuth2Dropbox, or OAuth2Dailymotion, or OAuth2Bitbucket, or OAuth2Bitly, or OAuth2Box, or OAuth2Autodesk, or OAuth2Google, or OAuth2Zoom, or OAuth2Zoho, or OAuth2Yandex, or OAuth2X, or OAuth2WordPress, or OAuth2Twitch, or OAuth2Stripe, or OAuth2Spotify, or OAuth2Slack, or OAuth2Podio, or OAuth2Notion, or OAuth2Salesforce, or OAuth2Yahoo, or OAuth2Linkedin, or OAuth2Disqus, or OAuth2Amazon, or OAuth2Etsy, or OAuth2Facebook, or OAuth2Tradeshift, or OAuth2Paypal, or OAuth2Gitlab, or OAuth2Authentik, or OAuth2Auth0, or OAuth2FusionAuth, or OAuth2Keycloak, or OAuth2Oidc, or OAuth2Apple, or OAuth2Okta, or OAuth2Kick, or OAuth2Microsoft", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/oAuth2Github" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Discord" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Figma" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Dropbox" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Dailymotion" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Bitbucket" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Bitly" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Box" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Autodesk" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Google" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Zoom" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Zoho" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Yandex" + }, + { + "$ref": "#\/components\/schemas\/oAuth2X" + }, + { + "$ref": "#\/components\/schemas\/oAuth2WordPress" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Twitch" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Stripe" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Spotify" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Slack" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Podio" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Notion" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Salesforce" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Yahoo" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Linkedin" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Disqus" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Amazon" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Etsy" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Facebook" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Tradeshift" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Paypal" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Gitlab" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Authentik" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Auth0" + }, + { + "$ref": "#\/components\/schemas\/oAuth2FusionAuth" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Keycloak" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Oidc" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Apple" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Okta" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Kick" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Microsoft" + } + ], + "discriminator": { + "propertyName": "$id", + "mapping": { + "github": "#\/components\/schemas\/oAuth2Github", + "discord": "#\/components\/schemas\/oAuth2Discord", + "figma": "#\/components\/schemas\/oAuth2Figma", + "dropbox": "#\/components\/schemas\/oAuth2Dropbox", + "dailymotion": "#\/components\/schemas\/oAuth2Dailymotion", + "bitbucket": "#\/components\/schemas\/oAuth2Bitbucket", + "bitly": "#\/components\/schemas\/oAuth2Bitly", + "box": "#\/components\/schemas\/oAuth2Box", + "autodesk": "#\/components\/schemas\/oAuth2Autodesk", + "google": "#\/components\/schemas\/oAuth2Google", + "zoom": "#\/components\/schemas\/oAuth2Zoom", + "zoho": "#\/components\/schemas\/oAuth2Zoho", + "yandex": "#\/components\/schemas\/oAuth2Yandex", + "x": "#\/components\/schemas\/oAuth2X", + "wordpress": "#\/components\/schemas\/oAuth2WordPress", + "twitch": "#\/components\/schemas\/oAuth2Twitch", + "stripe": "#\/components\/schemas\/oAuth2Stripe", + "spotify": "#\/components\/schemas\/oAuth2Spotify", + "slack": "#\/components\/schemas\/oAuth2Slack", + "podio": "#\/components\/schemas\/oAuth2Podio", + "notion": "#\/components\/schemas\/oAuth2Notion", + "salesforce": "#\/components\/schemas\/oAuth2Salesforce", + "yahoo": "#\/components\/schemas\/oAuth2Yahoo", + "linkedin": "#\/components\/schemas\/oAuth2Linkedin", + "disqus": "#\/components\/schemas\/oAuth2Disqus", + "amazon": "#\/components\/schemas\/oAuth2Amazon", + "etsy": "#\/components\/schemas\/oAuth2Etsy", + "facebook": "#\/components\/schemas\/oAuth2Facebook", + "tradeshift": "#\/components\/schemas\/oAuth2Tradeshift", + "tradeshiftBox": "#\/components\/schemas\/oAuth2Tradeshift", + "paypal": "#\/components\/schemas\/oAuth2Paypal", + "paypalSandbox": "#\/components\/schemas\/oAuth2Paypal", + "gitlab": "#\/components\/schemas\/oAuth2Gitlab", + "authentik": "#\/components\/schemas\/oAuth2Authentik", + "auth0": "#\/components\/schemas\/oAuth2Auth0", + "fusionauth": "#\/components\/schemas\/oAuth2FusionAuth", + "keycloak": "#\/components\/schemas\/oAuth2Keycloak", + "oidc": "#\/components\/schemas\/oAuth2Oidc", + "apple": "#\/components\/schemas\/oAuth2Apple", + "okta": "#\/components\/schemas\/oAuth2Okta", + "kick": "#\/components\/schemas\/oAuth2Kick", + "microsoft": "#\/components\/schemas\/oAuth2Microsoft" + } + } + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDevKey", - "group": "devKeys", - "weight": 426, + "method": "getOAuth2Provider", + "group": "oauth2", + "weight": 1138, "cookies": false, "type": "", - "demo": "projects\/delete-dev-key.md", + "demo": "project\/get-o-auth-2-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "oauth2.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45863,48 +46652,39 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", + "name": "provider", + "description": "OAuth2 provider key. For example: github, google, apple.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/projects\/{projectId}\/jwts": { - "post": { - "summary": "Create JWT", - "operationId": "projectsCreateJWT", + "\/project\/platforms": { + "get": { + "summary": "List project platforms", + "operationId": "projectListPlatforms", "tags": [ - "projects" + "project" ], - "description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ", + "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", "responses": { - "201": { - "description": "JWT", + "200": { + "description": "Platforms List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/jwt" + "$ref": "#\/components\/schemas\/platformList" } } } @@ -45912,168 +46692,75 @@ }, "deprecated": false, "x-appwrite": { - "method": "createJWT", - "group": "auth", - "weight": 64, + "method": "listPlatforms", + "group": "platforms", + "weight": 1119, "cookies": false, "type": "", - "demo": "projects\/create-jwt.md", + "demo": "project\/list-platforms.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "scopes": { - "type": "array", - "description": "List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] - } - }, - "duration": { - "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", - "x-example": 0, - "format": "int32" - } - }, - "required": [ - "scopes" - ] - } - } + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } + ] } }, - "\/projects\/{projectId}\/oauth2": { - "patch": { - "summary": "Update project OAuth2", - "operationId": "projectsUpdateOAuth2", + "\/project\/platforms\/android": { + "post": { + "summary": "Create project Android platform", + "operationId": "projectCreateAndroidPlatform", "tags": [ - "projects" + "project" ], - "description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ", + "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Platform Android", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/platformAndroid" } } } @@ -46081,41 +46768,30 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateOAuth2", - "group": "auth", - "weight": 60, + "method": "createAndroidPlatform", + "group": "platforms", + "weight": 1115, "cookies": false, "type": "", - "demo": "projects\/update-o-auth-2.md", + "demo": "project\/create-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -46124,76 +46800,26 @@ "schema": { "type": "object", "properties": { - "provider": { + "platformId": { "type": "string", - "description": "Provider Name", - "x-example": "amazon", - "enum": [ - "amazon", - "apple", - "auth0", - "authentik", - "autodesk", - "bitbucket", - "bitly", - "box", - "dailymotion", - "discord", - "disqus", - "dropbox", - "etsy", - "facebook", - "figma", - "github", - "gitlab", - "google", - "linkedin", - "microsoft", - "notion", - "oidc", - "okta", - "paypal", - "paypalSandbox", - "podio", - "salesforce", - "slack", - "spotify", - "stripe", - "tradeshift", - "tradeshiftBox", - "twitch", - "wordpress", - "x", - "yahoo", - "yammer", - "yandex", - "zoho", - "zoom" - ], - "x-enum-name": "OAuthProvider", - "x-enum-keys": [] + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "appId": { + "name": { "type": "string", - "description": "Provider app ID. Max length: 256 chars.", - "x-example": "", - "x-nullable": true + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "secret": { + "applicationId": { "type": "string", - "description": "Provider secret key. Max length: 512 chars.", - "x-example": "", - "x-nullable": true - }, - "enabled": { - "type": "boolean", - "description": "Provider status. Set to 'false' to disable new session creation.", - "x-example": false, - "x-nullable": true + "description": "Android application ID. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "provider" + "platformId", + "name", + "applicationId" ] } } @@ -46201,21 +46827,21 @@ } } }, - "\/projects\/{projectId}\/schedules": { - "get": { - "summary": "List schedules", - "operationId": "projectsListSchedules", + "\/project\/platforms\/android\/{platformId}": { + "put": { + "summary": "Update project Android platform", + "operationId": "projectUpdateAndroidPlatform", "tags": [ - "projects" + "project" ], - "description": "Get a list of all the project's schedules. You can use the query params to filter your results.", + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", "responses": { "200": { - "description": "Schedules List", + "description": "Platform Android", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/scheduleList" + "$ref": "#\/components\/schemas\/platformAndroid" } } } @@ -46223,82 +46849,86 @@ }, "deprecated": false, "x-appwrite": { - "method": "listSchedules", - "group": "schedules", - "weight": 433, + "method": "updateAndroidPlatform", + "group": "platforms", + "weight": 1110, "cookies": false, "type": "", - "demo": "projects\/list-schedules.md", + "demo": "project\/update-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "schedules.read", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-schedules.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: resourceType, resourceId, projectId, schedule, active, region", - "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", - "x-example": false, - "default": true - }, - "in": "query" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "applicationId" + ] + } + } + } + } + } + }, + "\/project\/platforms\/apple": { "post": { - "summary": "Create schedule", - "operationId": "projectsCreateSchedule", + "summary": "Create project Apple platform", + "operationId": "projectCreateApplePlatform", "tags": [ - "projects" + "project" ], - "description": "Create a new schedule for a resource.", + "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", "responses": { "201": { - "description": "Schedule", + "description": "Platform Apple", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/schedule" + "$ref": "#\/components\/schemas\/platformApple" } } } @@ -46306,41 +46936,30 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSchedule", - "group": "schedules", - "weight": 1028, + "method": "createApplePlatform", + "group": "platforms", + "weight": 1114, "cookies": false, "type": "", - "demo": "projects\/create-schedule.md", + "demo": "project\/create-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "schedules.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-schedule.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -46349,44 +46968,26 @@ "schema": { "type": "object", "properties": { - "resourceType": { + "platformId": { "type": "string", - "description": "The resource type for the schedule. Possible values: function, execution, message, backup.", - "x-example": "function", - "enum": [ - "function", - "execution", - "message", - "backup" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "resourceId": { + "name": { "type": "string", - "description": "The resource ID to associate with this schedule.", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "schedule": { + "bundleIdentifier": { "type": "string", - "description": "Schedule CRON expression.", - "x-example": null - }, - "active": { - "type": "boolean", - "description": "Whether the schedule is active.", - "x-example": false - }, - "data": { - "type": "object", - "description": "Schedule data as a JSON string. Used to store resource-specific context needed for execution.", - "x-example": "{}" + "description": "Apple bundle identifier. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "resourceType", - "resourceId", - "schedule" + "platformId", + "name", + "bundleIdentifier" ] } } @@ -46394,21 +46995,21 @@ } } }, - "\/projects\/{projectId}\/schedules\/{scheduleId}": { - "get": { - "summary": "Get schedule", - "operationId": "projectsGetSchedule", + "\/project\/platforms\/apple\/{platformId}": { + "put": { + "summary": "Update project Apple platform", + "operationId": "projectUpdateApplePlatform", "tags": [ - "projects" + "project" ], - "description": "Get a schedule by its unique ID.", + "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", "responses": { "200": { - "description": "Schedule", + "description": "Platform Apple", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/schedule" + "$ref": "#\/components\/schemas\/platformApple" } } } @@ -46416,105 +47017,117 @@ }, "deprecated": false, "x-appwrite": { - "method": "getSchedule", - "group": "schedules", - "weight": 432, + "method": "updateApplePlatform", + "group": "platforms", + "weight": 1109, "cookies": false, "type": "", - "demo": "projects\/get-schedule.md", + "demo": "project\/update-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "schedules.read", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-schedule.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "scheduleId", - "description": "Schedule ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "bundleIdentifier" + ] + } + } + } + } } }, - "\/projects\/{projectId}\/status": { - "patch": { - "summary": "Update the status of a project", - "operationId": "projectsUpdateStatus", + "\/project\/platforms\/linux": { + "post": { + "summary": "Create project Linux platform", + "operationId": "projectCreateLinuxPlatform", "tags": [ - "projects" + "project" ], - "description": "Update the status of a project. Can be used to archive\/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.\n", + "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Platform Linux", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformLinux" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "updateStatus", - "group": null, - "weight": 1023, + "method": "createLinuxPlatform", + "group": "platforms", + "weight": 1117, "cookies": false, "type": "", - "demo": "projects\/update-status.md", - "rate-limit": 10, + "demo": "project\/create-linux-platform.md", + "rate-limit": 0, "rate-time": 3600, - "rate-key": "ip:{ip},userId:{userId}", - "scope": "projects.write", + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-status.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] - } - ], - "parameters": [ - { - "name": "projectId", - "description": "Project ID", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -46523,19 +47136,26 @@ "schema": { "type": "object", "properties": { - "status": { + "platformId": { "type": "string", - "description": "New status for the project", - "x-example": "active", - "enum": [ - "active" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "status" + "platformId", + "name", + "packageName" ] } } @@ -46543,21 +47163,21 @@ } } }, - "\/projects\/{projectId}\/team": { - "patch": { - "summary": "Update project team", - "operationId": "projectsUpdateTeam", + "\/project\/platforms\/linux\/{platformId}": { + "put": { + "summary": "Update project Linux platform", + "operationId": "projectUpdateLinuxPlatform", "tags": [ - "projects" + "project" ], - "description": "Update the team ID of a project allowing for it to be transferred to another team.", + "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", "responses": { "200": { - "description": "Project", + "description": "Platform Linux", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/platformLinux" } } } @@ -46565,39 +47185,40 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTeam", - "group": "projects", - "weight": 1024, + "method": "updateLinuxPlatform", + "group": "platforms", + "weight": 1112, "cookies": false, "type": "", - "demo": "projects\/update-team.md", + "demo": "project\/update-linux-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -46608,14 +47229,20 @@ "schema": { "type": "object", "properties": { - "teamId": { + "name": { "type": "string", - "description": "Team ID of the team to transfer project to.", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "teamId" + "name", + "packageName" ] } } @@ -46623,21 +47250,21 @@ } } }, - "\/proxy\/rules": { - "get": { - "summary": "List rules", - "operationId": "proxyListRules", + "\/project\/platforms\/web": { + "post": { + "summary": "Create project web platform", + "operationId": "projectCreateWebPlatform", "tags": [ - "proxy" + "project" ], - "description": "Get a list of all the proxy rules. You can use the query params to filter your results.", + "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Rule List", + "201": { + "description": "Platform Web", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/proxyRuleList" + "$ref": "#\/components\/schemas\/platformWeb" } } } @@ -46645,18 +47272,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "listRules", - "group": null, - "weight": 1080, + "method": "createWebPlatform", + "group": "platforms", + "weight": 1113, "cookies": false, "type": "", - "demo": "proxy\/list-rules.md", + "demo": "project\/create-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.read", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -46666,63 +47294,58 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "x-example": "app.example.com" + } + }, + "required": [ + "platformId", + "name", + "hostname" + ] + } + } } - ] + } } }, - "\/proxy\/rules\/api": { - "post": { - "summary": "Create API rule", - "operationId": "proxyCreateAPIRule", + "\/project\/platforms\/web\/{platformId}": { + "put": { + "summary": "Update project web platform", + "operationId": "projectUpdateWebPlatform", "tags": [ - "proxy" + "project" ], - "description": "Create a new proxy rule for serving Appwrite's API on custom domain.", + "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", "responses": { - "201": { - "description": "Rule", + "200": { + "description": "Platform Web", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/proxyRule" + "$ref": "#\/components\/schemas\/platformWeb" } } } @@ -46730,18 +47353,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "createAPIRule", - "group": null, - "weight": 1075, + "method": "updateWebPlatform", + "group": "platforms", + "weight": 1108, "cookies": false, "type": "", - "demo": "proxy\/create-api-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", - "scope": "rules.write", + "demo": "project\/update-web-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -46751,7 +47375,20 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -46760,14 +47397,20 @@ "schema": { "type": "object", "properties": { - "domain": { + "name": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "x-example": "app.example.com" } }, "required": [ - "domain" + "name", + "hostname" ] } } @@ -46775,21 +47418,21 @@ } } }, - "\/proxy\/rules\/function": { + "\/project\/platforms\/windows": { "post": { - "summary": "Create function rule", - "operationId": "proxyCreateFunctionRule", + "summary": "Create project Windows platform", + "operationId": "projectCreateWindowsPlatform", "tags": [ - "proxy" + "project" ], - "description": "Create a new proxy rule for executing Appwrite Function on custom domain.", + "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", "responses": { "201": { - "description": "Rule", + "description": "Platform Windows", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/proxyRule" + "$ref": "#\/components\/schemas\/platformWindows" } } } @@ -46797,18 +47440,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFunctionRule", - "group": null, - "weight": 1077, + "method": "createWindowsPlatform", + "group": "platforms", + "weight": 1116, "cookies": false, "type": "", - "demo": "proxy\/create-function-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", - "scope": "rules.write", - "platforms": [ - "console" + "demo": "project\/create-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" ], "packaging": false, "public": true, @@ -46818,7 +47462,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "requestBody": { @@ -46827,25 +47472,26 @@ "schema": { "type": "object", "properties": { - "domain": { + "platformId": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "functionId": { + "name": { "type": "string", - "description": "ID of function to be executed.", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "branch": { + "packageIdentifierName": { "type": "string", - "description": "Name of VCS branch to deploy changes automatically", - "x-example": "" + "description": "Windows package identifier name. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "domain", - "functionId" + "platformId", + "name", + "packageIdentifierName" ] } } @@ -46853,21 +47499,21 @@ } } }, - "\/proxy\/rules\/redirect": { - "post": { - "summary": "Create Redirect rule", - "operationId": "proxyCreateRedirectRule", + "\/project\/platforms\/windows\/{platformId}": { + "put": { + "summary": "Update project Windows platform", + "operationId": "projectUpdateWindowsPlatform", "tags": [ - "proxy" + "project" ], - "description": "Create a new proxy rule for to redirect from custom domain to another domain.", + "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", "responses": { - "201": { - "description": "Rule", + "200": { + "description": "Platform Windows", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/proxyRule" + "$ref": "#\/components\/schemas\/platformWindows" } } } @@ -46875,18 +47521,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRedirectRule", - "group": null, - "weight": 1078, + "method": "updateWindowsPlatform", + "group": "platforms", + "weight": 1111, "cookies": false, "type": "", - "demo": "proxy\/create-redirect-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", - "scope": "rules.write", + "demo": "project\/update-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -46896,121 +47543,20 @@ }, "security": [ { - "Project": [] - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "domain": { - "type": "string", - "description": "Domain name.", - "x-example": null - }, - "url": { - "type": "string", - "description": "Target URL of redirection", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "statusCode": { - "type": "string", - "description": "Status code of redirection", - "x-example": "301", - "enum": [ - "301", - "302", - "307", - "308" - ], - "x-enum-name": null, - "x-enum-keys": [ - "Moved Permanently 301", - "Found 302", - "Temporary Redirect 307", - "Permanent Redirect 308" - ] - }, - "resourceId": { - "type": "string", - "description": "ID of parent resource.", - "x-example": "" - }, - "resourceType": { - "type": "string", - "description": "Type of parent resource.", - "x-example": "site", - "enum": [ - "site", - "function" - ], - "x-enum-name": "ProxyResourceType", - "x-enum-keys": [ - "Site", - "Function" - ] - } - }, - "required": [ - "domain", - "url", - "statusCode", - "resourceId", - "resourceType" - ] - } - } + "Project": [], + "Key": [] } - } - } - }, - "\/proxy\/rules\/site": { - "post": { - "summary": "Create site rule", - "operationId": "proxyCreateSiteRule", - "tags": [ - "proxy" ], - "description": "Create a new proxy rule for serving Appwrite Site on custom domain.", - "responses": { - "201": { - "description": "Rule", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/proxyRule" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createSiteRule", - "group": null, - "weight": 1076, - "cookies": false, - "type": "", - "demo": "proxy\/create-site-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", - "scope": "rules.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ + "parameters": [ { - "Project": [] + "name": "platformId", + "description": "Platform ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -47019,25 +47565,20 @@ "schema": { "type": "object", "properties": { - "domain": { - "type": "string", - "description": "Domain name.", - "x-example": null - }, - "siteId": { + "name": { "type": "string", - "description": "ID of site to be executed.", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "branch": { + "packageIdentifierName": { "type": "string", - "description": "Name of VCS branch to deploy changes automatically", - "x-example": "" + "description": "Windows package identifier name. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "domain", - "siteId" + "name", + "packageIdentifierName" ] } } @@ -47045,21 +47586,47 @@ } } }, - "\/proxy\/rules\/{ruleId}": { + "\/project\/platforms\/{platformId}": { "get": { - "summary": "Get rule", - "operationId": "proxyGetRule", + "summary": "Get project platform", + "operationId": "projectGetPlatform", "tags": [ - "proxy" + "project" ], - "description": "Get a proxy rule by its unique ID.", + "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", "responses": { "200": { - "description": "Rule", + "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/proxyRule" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "web": "#\/components\/schemas\/platformWeb", + "apple": "#\/components\/schemas\/platformApple", + "android": "#\/components\/schemas\/platformAndroid", + "windows": "#\/components\/schemas\/platformWindows", + "linux": "#\/components\/schemas\/platformLinux" + } + } } } } @@ -47067,18 +47634,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "getRule", - "group": null, - "weight": 1079, + "method": "getPlatform", + "group": "platforms", + "weight": 1118, "cookies": false, "type": "", - "demo": "proxy\/get-rule.md", + "demo": "project\/get-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.read", + "scope": "platforms.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47088,29 +47656,30 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, "delete": { - "summary": "Delete rule", - "operationId": "proxyDeleteRule", + "summary": "Delete project platform", + "operationId": "projectDeletePlatform", "tags": [ - "proxy" + "project" ], - "description": "Delete a proxy rule by its unique ID.", + "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", "responses": { "204": { "description": "No content" @@ -47118,18 +47687,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteRule", - "group": null, - "weight": 1081, + "method": "deletePlatform", + "group": "platforms", + "weight": 1107, "cookies": false, "type": "", - "demo": "proxy\/delete-rule.md", + "demo": "project\/delete-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47139,38 +47709,39 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/proxy\/rules\/{ruleId}\/verification": { - "patch": { - "summary": "Update rule verification status", - "operationId": "proxyUpdateRuleVerification", + "\/project\/policies": { + "get": { + "summary": "List project policies", + "operationId": "projectListPolicies", "tags": [ - "proxy" + "project" ], - "description": "Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.", + "description": "Get a list of all project policies and their current configuration.", "responses": { "200": { - "description": "Rule", + "description": "Policies List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/proxyRule" + "$ref": "#\/components\/schemas\/policyList" } } } @@ -47178,18 +47749,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRuleVerification", - "group": null, - "weight": 1082, + "method": "listPolicies", + "group": "policies", + "weight": 1125, "cookies": false, "type": "", - "demo": "proxy\/update-rule-verification.md", + "demo": "project\/list-policies.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.write", + "scope": "policies.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47199,38 +47771,53 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "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", + "x-example": false, + "default": true + }, + "in": "query" } ] } }, - "\/sites": { - "get": { - "summary": "List sites", - "operationId": "sitesList", + "\/project\/policies\/membership-privacy": { + "patch": { + "summary": "Update membership privacy policy", + "operationId": "projectUpdateMembershipPrivacyPolicy", "tags": [ - "sites" + "project" ], - "description": "Get a list of all the project's sites. You can use the query params to filter your results.", + "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", "responses": { "200": { - "description": "Sites List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/siteList" + "$ref": "#\/components\/schemas\/project" } } } @@ -47238,16 +47825,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "sites", - "weight": 491, + "method": "updateMembershipPrivacyPolicy", + "group": "policies", + "weight": 1127, "cookies": false, "type": "", - "demo": "sites\/list.md", + "demo": "project\/update-membership-privacy-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "policies.write", "platforms": [ "console", "server" @@ -47264,58 +47851,59 @@ "Key": [] } ], - "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: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "boolean", + "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", + "x-example": false + }, + "userEmail": { + "type": "boolean", + "description": "Set to true if you want make user email visible to all team members, or false to hide it.", + "x-example": false + }, + "userPhone": { + "type": "boolean", + "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", + "x-example": false + }, + "userName": { + "type": "boolean", + "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "x-example": false + }, + "userMFA": { + "type": "boolean", + "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "x-example": false + } + } + } + } } - ] - }, - "post": { - "summary": "Create site", - "operationId": "sitesCreate", + } + } + }, + "\/project\/policies\/password-dictionary": { + "patch": { + "summary": "Update password dictionary policy", + "operationId": "projectUpdatePasswordDictionaryPolicy", "tags": [ - "sites" + "project" ], - "description": "Create a new site.", + "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", "responses": { - "201": { - "description": "Site", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/site" + "$ref": "#\/components\/schemas\/project" } } } @@ -47323,16 +47911,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "sites", - "weight": 848, + "method": "updatePasswordDictionaryPolicy", + "group": "policies", + "weight": 1128, "cookies": false, "type": "", - "demo": "sites\/create.md", + "demo": "project\/update-password-dictionary-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "policies.write", "platforms": [ "console", "server" @@ -47355,239 +47943,14 @@ "schema": { "type": "object", "properties": { - "siteId": { - "type": "string", - "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Site name. Max length: 128 chars.", - "x-example": "" - }, - "framework": { - "type": "string", - "description": "Sites framework.", - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, "enabled": { "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false - }, - "timeout": { - "type": "integer", - "description": "Maximum request time in seconds.", - "x-example": 1, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "Install Command.", - "x-example": "" - }, - "buildCommand": { - "type": "string", - "description": "Build Command.", - "x-example": "" - }, - "startCommand": { - "type": "string", - "description": "Custom start command. Leave empty to use default.", - "x-example": "" - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory for site.", - "x-example": "" - }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dart-3.11", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "flutter-3.41" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "x-example": "" - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "x-example": "" - }, - "providerRepositoryId": { - "type": "string", - "description": "Repository ID of the repo linked to the site.", - "x-example": "" - }, - "providerBranch": { - "type": "string", - "description": "Production branch for the repo linked to the site.", - "x-example": "" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", + "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "x-example": "" - }, - "buildSpecification": { - "type": "string", - "description": "Build specification for the site deployments.", - "x-example": null - }, - "runtimeSpecification": { - "type": "string", - "description": "Runtime specification for the SSR executions.", - "x-example": null - }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "x-example": 0, - "format": "int32" } }, "required": [ - "siteId", - "name", - "framework", - "buildRuntime" + "enabled" ] } } @@ -47595,21 +47958,21 @@ } } }, - "\/sites\/frameworks": { - "get": { - "summary": "List frameworks", - "operationId": "sitesListFrameworks", + "\/project\/policies\/password-history": { + "patch": { + "summary": "Update password history policy", + "operationId": "projectUpdatePasswordHistoryPolicy", "tags": [ - "sites" + "project" ], - "description": "Get a list of all frameworks that are currently available on the server instance.", + "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", "responses": { "200": { - "description": "Frameworks List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/frameworkList" + "$ref": "#\/components\/schemas\/project" } } } @@ -47617,16 +47980,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listFrameworks", - "group": "frameworks", - "weight": 494, + "method": "updatePasswordHistoryPolicy", + "group": "policies", + "weight": 1129, "cookies": false, "type": "", - "demo": "sites\/list-frameworks.md", + "demo": "project\/update-password-history-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "policies.write", "platforms": [ "console", "server" @@ -47642,24 +48005,45 @@ "Project": [], "Key": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } + } + } + } } }, - "\/sites\/specifications": { - "get": { - "summary": "List specifications", - "operationId": "sitesListSpecifications", + "\/project\/policies\/password-personal-data": { + "patch": { + "summary": "Update password personal data policy", + "operationId": "projectUpdatePasswordPersonalDataPolicy", "tags": [ - "sites" + "project" ], - "description": "List allowed site specifications for this instance.", + "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", "responses": { "200": { - "description": "Specifications List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/specificationList" + "$ref": "#\/components\/schemas\/project" } } } @@ -47667,19 +48051,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "listSpecifications", - "group": "frameworks", - "weight": 517, + "method": "updatePasswordPersonalDataPolicy", + "group": "policies", + "weight": 1130, "cookies": false, "type": "", - "demo": "sites\/list-specifications.md", + "demo": "project\/update-password-personal-data-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "policies.write", "platforms": [ - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47692,24 +48076,43 @@ "Project": [], "Key": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } } }, - "\/sites\/templates": { - "get": { - "summary": "List templates", - "operationId": "sitesListTemplates", + "\/project\/policies\/session-alert": { + "patch": { + "summary": "Update session alert policy", + "operationId": "projectUpdateSessionAlertPolicy", "tags": [ - "sites" + "project" ], - "description": "List available site templates. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.", + "description": "Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.", "responses": { "200": { - "description": "Site Templates List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/templateSiteList" + "$ref": "#\/components\/schemas\/project" } } } @@ -47717,18 +48120,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTemplates", - "group": "templates", - "weight": 513, + "method": "updateSessionAlertPolicy", + "group": "policies", + "weight": 1131, "cookies": false, "type": "", - "demo": "sites\/list-templates.md", + "demo": "project\/update-session-alert-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "policies.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47738,110 +48142,46 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "frameworks", - "description": "List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "default": [] - }, - "in": "query" - }, - { - "name": "useCases", - "description": "List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "portfolio", - "starter", - "events", - "ecommerce", - "documentation", - "blog", - "ai", - "forms", - "dashboard" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "default": [] - }, - "in": "query" - }, - { - "name": "limit", - "description": "Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 1, - "default": 25 - }, - "in": "query" - }, - { - "name": "offset", - "description": "Offset the list of returned templates. Maximum offset is 5000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } } - ] + } } }, - "\/sites\/templates\/{templateId}": { - "get": { - "summary": "Get site template", - "operationId": "sitesGetTemplate", + "\/project\/policies\/session-duration": { + "patch": { + "summary": "Update session duration policy", + "operationId": "projectUpdateSessionDurationPolicy", "tags": [ - "sites" + "project" ], - "description": "Get a site template using ID. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.", + "description": "Update maximum duration how long sessions created within a project should stay active for.", "responses": { "200": { - "description": "Template Site", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/templateSite" + "$ref": "#\/components\/schemas\/project" } } } @@ -47849,18 +48189,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "getTemplate", - "group": "templates", - "weight": 514, + "method": "updateSessionDurationPolicy", + "group": "policies", + "weight": 1132, "cookies": false, "type": "", - "demo": "sites\/get-template.md", + "demo": "project\/update-session-duration-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "policies.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47870,38 +48211,47 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "templateId", - "description": "Template ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "duration": { + "type": "integer", + "description": "Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.", + "x-example": 5, + "format": "int32" + } + }, + "required": [ + "duration" + ] + } + } } - ] + } } }, - "\/sites\/usage": { - "get": { - "summary": "Get sites usage", - "operationId": "sitesListUsage", + "\/project\/policies\/session-invalidation": { + "patch": { + "summary": "Update session invalidation policy", + "operationId": "projectUpdateSessionInvalidationPolicy", "tags": [ - "sites" + "project" ], - "description": "Get usage metrics and statistics for all sites in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", + "description": "Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.", "responses": { "200": { - "description": "UsageSites", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageSites" + "$ref": "#\/components\/schemas\/project" } } } @@ -47909,18 +48259,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "listUsage", - "group": null, - "weight": 515, + "method": "updateSessionInvalidationPolicy", + "group": "policies", + "weight": 1133, "cookies": false, "type": "", - "demo": "sites\/list-usage.md", + "demo": "project\/update-session-invalidation-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "policies.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47930,50 +48281,46 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], - "parameters": [ - { - "name": "range", - "description": "Date range.", - "required": false, - "schema": { - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } } - ] + } } }, - "\/sites\/{siteId}": { - "get": { - "summary": "Get site", - "operationId": "sitesGet", + "\/project\/policies\/session-limit": { + "patch": { + "summary": "Update session limit policy", + "operationId": "projectUpdateSessionLimitPolicy", "tags": [ - "sites" + "project" ], - "description": "Get a site by its unique ID.", + "description": "Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.", "responses": { "200": { - "description": "Site", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/site" + "$ref": "#\/components\/schemas\/project" } } } @@ -47981,16 +48328,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "sites", - "weight": 490, + "method": "updateSessionLimitPolicy", + "group": "policies", + "weight": 1134, "cookies": false, "type": "", - "demo": "sites\/get.md", + "demo": "project\/update-session-limit-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "policies.write", "platforms": [ "console", "server" @@ -48007,33 +48354,44 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.", + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } + } } - ] - }, - "put": { - "summary": "Update site", - "operationId": "sitesUpdate", + } + } + }, + "\/project\/policies\/user-limit": { + "patch": { + "summary": "Update user limit policy", + "operationId": "projectUpdateUserLimitPolicy", "tags": [ - "sites" + "project" ], - "description": "Update site by its unique ID.", + "description": "Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.", "responses": { "200": { - "description": "Site", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/site" + "$ref": "#\/components\/schemas\/project" } } } @@ -48041,16 +48399,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "sites", - "weight": 849, + "method": "updateUserLimitPolicy", + "group": "policies", + "weight": 1135, "cookies": false, "type": "", - "demo": "sites\/update.md", + "demo": "project\/update-user-limit-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "policies.write", "platforms": [ "console", "server" @@ -48067,280 +48425,103 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Site name. Max length: 128 chars.", - "x-example": "" - }, - "framework": { - "type": "string", - "description": "Sites framework.", - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "enabled": { - "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false - }, - "timeout": { + "total": { "type": "integer", - "description": "Maximum request time in seconds.", + "description": "Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.", "x-example": 1, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "Install Command.", - "x-example": "" - }, - "buildCommand": { - "type": "string", - "description": "Build Command.", - "x-example": "" - }, - "startCommand": { - "type": "string", - "description": "Custom start command. Leave empty to use default.", - "x-example": "" - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory for site.", - "x-example": "" - }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dart-3.11", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "flutter-3.41" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "x-example": "" - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "x-example": "" - }, - "providerRepositoryId": { - "type": "string", - "description": "Repository ID of the repo linked to the site.", - "x-example": "" - }, - "providerBranch": { - "type": "string", - "description": "Production branch for the repo linked to the site.", - "x-example": "" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", - "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "x-example": "" - }, - "buildSpecification": { - "type": "string", - "description": "Build specification for the site deployments.", - "x-example": null - }, - "runtimeSpecification": { - "type": "string", - "description": "Runtime specification for the SSR executions.", - "x-example": null - }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "x-example": 0, - "format": "int32" + "format": "int32", + "x-nullable": true } }, "required": [ - "name", - "framework" + "total" ] } } } } - }, - "delete": { - "summary": "Delete site", - "operationId": "sitesDelete", + } + }, + "\/project\/policies\/{policyId}": { + "get": { + "summary": "Get project policy", + "operationId": "projectGetPolicy", "tags": [ - "sites" + "project" ], - "description": "Delete a site by its unique ID.", + "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/policyPasswordDictionary" + }, + { + "$ref": "#\/components\/schemas\/policyPasswordHistory" + }, + { + "$ref": "#\/components\/schemas\/policyPasswordPersonalData" + }, + { + "$ref": "#\/components\/schemas\/policySessionAlert" + }, + { + "$ref": "#\/components\/schemas\/policySessionDuration" + }, + { + "$ref": "#\/components\/schemas\/policySessionInvalidation" + }, + { + "$ref": "#\/components\/schemas\/policySessionLimit" + }, + { + "$ref": "#\/components\/schemas\/policyUserLimit" + }, + { + "$ref": "#\/components\/schemas\/policyMembershipPrivacy" + } + ], + "discriminator": { + "propertyName": "$id", + "mapping": { + "password-dictionary": "#\/components\/schemas\/policyPasswordDictionary", + "password-history": "#\/components\/schemas\/policyPasswordHistory", + "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", + "session-alert": "#\/components\/schemas\/policySessionAlert", + "session-duration": "#\/components\/schemas\/policySessionDuration", + "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", + "session-limit": "#\/components\/schemas\/policySessionLimit", + "user-limit": "#\/components\/schemas\/policyUserLimit", + "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy" + } + } + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "sites", - "weight": 493, + "method": "getPolicy", + "group": "policies", + "weight": 1126, "cookies": false, "type": "", - "demo": "sites\/delete.md", + "demo": "project\/get-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "policies.read", "platforms": [ "console", "server" @@ -48359,33 +48540,46 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "policyId", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "password-dictionary", + "enum": [ + "password-dictionary", + "password-history", + "password-personal-data", + "session-alert", + "session-duration", + "session-invalidation", + "session-limit", + "user-limit", + "membership-privacy" + ], + "x-enum-name": null, + "x-enum-keys": [] }, "in": "path" } ] } }, - "\/sites\/{siteId}\/deployment": { + "\/project\/protocols\/{protocolId}": { "patch": { - "summary": "Update site's deployment", - "operationId": "sitesUpdateSiteDeployment", + "summary": "Update project protocol", + "operationId": "projectUpdateProtocol", "tags": [ - "sites" + "project" ], - "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "description": "Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project. ", "responses": { "200": { - "description": "Site", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/site" + "$ref": "#\/components\/schemas\/project" } } } @@ -48393,16 +48587,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSiteDeployment", - "group": "sites", - "weight": 500, + "method": "updateProtocol", + "group": null, + "weight": 1089, "cookies": false, "type": "", - "demo": "sites\/update-site-deployment.md", + "demo": "project\/update-protocol.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -48421,12 +48615,19 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "protocolId", + "description": "Protocol name. Can be one of: rest, graphql, websocket", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "rest", + "enum": [ + "rest", + "graphql", + "websocket" + ], + "x-enum-name": null, + "x-enum-keys": [] }, "in": "path" } @@ -48437,14 +48638,14 @@ "schema": { "type": "object", "properties": { - "deploymentId": { - "type": "string", - "description": "Deployment ID.", - "x-example": "" + "enabled": { + "type": "boolean", + "description": "Protocol status.", + "x-example": false } }, "required": [ - "deploymentId" + "enabled" ] } } @@ -48452,21 +48653,21 @@ } } }, - "\/sites\/{siteId}\/deployments": { - "get": { - "summary": "List deployments", - "operationId": "sitesListDeployments", + "\/project\/services\/{serviceId}": { + "patch": { + "summary": "Update project service", + "operationId": "projectUpdateService", "tags": [ - "sites" + "project" ], - "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", + "description": "Update properties of a specific service. Use this endpoint to enable or disable a service in your project. ", "responses": { "200": { - "description": "Deployments List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deploymentList" + "$ref": "#\/components\/schemas\/project" } } } @@ -48474,16 +48675,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listDeployments", - "group": "deployments", - "weight": 499, + "method": "updateService", + "group": null, + "weight": 1090, "cookies": false, "type": "", - "demo": "sites\/list-deployments.md", + "demo": "project\/update-service.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "project.write", "platforms": [ "console", "server" @@ -48502,149 +48703,51 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "serviceId", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create deployment", - "operationId": "sitesCreateDeployment", - "tags": [ - "sites" - ], - "description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.", - "responses": { - "202": { - "description": "Deployment", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/deployment" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createDeployment", - "group": "deployments", - "weight": 495, - "cookies": false, - "type": "upload", - "demo": "sites\/create-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": true, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" + "x-example": "account", + "enum": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging" + ], + "x-enum-name": null, + "x-enum-keys": [] }, "in": "path" } ], "requestBody": { "content": { - "multipart\/form-data": { + "application\/json": { "schema": { "type": "object", "properties": { - "installCommand": { - "type": "string", - "description": "Install Commands.", - "x-example": "", - "x-nullable": true - }, - "buildCommand": { - "type": "string", - "description": "Build Commands.", - "x-example": "", - "x-nullable": true - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory.", - "x-example": "", - "x-nullable": true - }, - "code": { - "type": "string", - "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "x-example": null, - "format": "binary" - }, - "activate": { + "enabled": { "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", + "description": "Service status.", "x-example": false } }, "required": [ - "code" + "enabled" ] } } @@ -48652,21 +48755,21 @@ } } }, - "\/sites\/{siteId}\/deployments\/duplicate": { - "post": { - "summary": "Create duplicate deployment", - "operationId": "sitesCreateDuplicateDeployment", + "\/project\/smtp": { + "patch": { + "summary": "Update project SMTP configuration", + "operationId": "projectUpdateSMTP", "tags": [ - "sites" + "project" ], - "description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.", + "description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deployment" + "$ref": "#\/components\/schemas\/project" } } } @@ -48674,16 +48777,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDuplicateDeployment", - "group": "deployments", - "weight": 503, + "method": "updateSMTP", + "group": "smtp", + "weight": 1091, "cookies": false, "type": "", - "demo": "sites\/create-duplicate-deployment.md", + "demo": "project\/update-smtp.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -48700,188 +48803,113 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "deploymentId": { + "host": { "type": "string", - "description": "Deployment ID.", - "x-example": "" - } - }, - "required": [ - "deploymentId" - ] - } - } - } - } - } - }, - "\/sites\/{siteId}\/deployments\/template": { - "post": { - "summary": "Create template deployment", - "operationId": "sitesCreateTemplateDeployment", - "tags": [ - "sites" - ], - "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", - "responses": { - "202": { - "description": "Deployment", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/deployment" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createTemplateDeployment", - "group": "deployments", - "weight": 496, - "cookies": false, - "type": "", - "demo": "sites\/create-template-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "repository": { + "description": "SMTP server hostname (domain)", + "x-example": null, + "x-nullable": true + }, + "port": { + "type": "integer", + "description": "SMTP server port", + "x-example": null, + "format": "int32", + "x-nullable": true + }, + "username": { "type": "string", - "description": "Repository name of the template.", - "x-example": "" + "description": "SMTP server username. Leave empty for no authorization.", + "x-example": "", + "x-nullable": true }, - "owner": { + "password": { "type": "string", - "description": "The name of the owner of the template.", - "x-example": "" + "description": "SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).", + "x-example": "", + "x-nullable": true }, - "rootDirectory": { + "senderEmail": { "type": "string", - "description": "Path to site code in the template repo.", - "x-example": "" + "description": "Email address shown in inbox as the sender of the email.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true }, - "type": { + "senderName": { "type": "string", - "description": "Type for the reference provided. Can be commit, branch, or tag", - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "TemplateReferenceType", - "x-enum-keys": [] + "description": "Name shown in inbox as the sender of the email.", + "x-example": "", + "x-nullable": true }, - "reference": { + "replyToEmail": { "type": "string", - "description": "Reference value, can be a commit hash, branch name, or release tag", - "x-example": "" + "description": "Email used when user replies to the email.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true }, - "activate": { + "replyToName": { + "type": "string", + "description": "Name used when user replies to the email.", + "x-example": "", + "x-nullable": true + }, + "secure": { + "type": "string", + "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", + "x-example": "tls", + "enum": [ + "tls", + "ssl" + ], + "x-enum-name": null, + "x-enum-keys": [], + "x-nullable": true + }, + "enabled": { "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "x-example": false + "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "repository", - "owner", - "rootDirectory", - "type", - "reference" - ] + } } } } } } }, - "\/sites\/{siteId}\/deployments\/vcs": { + "\/project\/smtp\/tests": { "post": { - "summary": "Create VCS deployment", - "operationId": "sitesCreateVcsDeployment", + "summary": "Create project SMTP test", + "operationId": "projectCreateSMTPTest", "tags": [ - "sites" + "project" ], - "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", + "description": "Send a test email to verify SMTP configuration. ", "responses": { - "202": { - "description": "Deployment", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/deployment" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createVcsDeployment", - "group": "deployments", - "weight": 497, + "method": "createSMTPTest", + "group": "smtp", + "weight": 1092, "cookies": false, "type": "", - "demo": "sites\/create-vcs-deployment.md", + "demo": "project\/create-smtp-test.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -48898,50 +48926,23 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Type of reference passed. Allowed values are: branch, commit", - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "VCSReferenceType", - "x-enum-keys": [] - }, - "reference": { - "type": "string", - "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "x-example": "" - }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "x-example": false + "emails": { + "type": "array", + "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "type", - "reference" + "emails" ] } } @@ -48949,21 +48950,21 @@ } } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}": { + "\/project\/templates\/email": { "get": { - "summary": "Get deployment", - "operationId": "sitesGetDeployment", + "summary": "List project email templates", + "operationId": "projectListEmailTemplates", "tags": [ - "sites" + "project" ], - "description": "Get a site deployment by its unique ID.", + "description": "Get a list of all custom email templates configured for the project. This endpoint returns an array of all configured email templates and their locales.", "responses": { "200": { - "description": "Deployment", + "description": "Email Templates List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deployment" + "$ref": "#\/components\/schemas\/emailTemplateList" } } } @@ -48971,16 +48972,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getDeployment", - "group": "deployments", - "weight": 498, + "method": "listEmailTemplates", + "group": "templates", + "weight": 1093, "cookies": false, "type": "", - "demo": "sites\/get-deployment.md", + "demo": "project\/list-email-templates.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "templates.read", "platforms": [ "console", "server" @@ -48999,51 +49000,62 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "boolean", + "x-example": false, + "default": true }, - "in": "path" + "in": "query" } ] }, - "delete": { - "summary": "Delete deployment", - "operationId": "sitesDeleteDeployment", + "patch": { + "summary": "Update project email template", + "operationId": "projectUpdateEmailTemplate", "tags": [ - "sites" + "project" ], - "description": "Delete a site deployment by its unique ID.", + "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "EmailTemplate", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/emailTemplate" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDeployment", - "group": "deployments", - "weight": 501, + "method": "updateEmailTemplate", + "group": "templates", + "weight": 1095, "cookies": false, "type": "", - "demo": "sites\/delete-deployment.md", + "demo": "project\/update-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "templates.write", "platforms": [ "console", "server" @@ -49060,58 +49072,250 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "templateId": { + "type": "string", + "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", + "x-example": "verification", + "enum": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ], + "x-enum-name": "EmailTemplateType", + "x-enum-keys": [] + }, + "locale": { + "type": "string", + "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "EmailTemplateLocale", + "x-enum-keys": [] + }, + "subject": { + "type": "string", + "description": "Subject of the email template. Can be up to 255 characters.", + "x-example": "", + "x-nullable": true + }, + "message": { + "type": "string", + "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", + "x-example": "", + "x-nullable": true + }, + "senderName": { + "type": "string", + "description": "Name of the email sender.", + "x-example": "", + "x-nullable": true + }, + "senderEmail": { + "type": "string", + "description": "Email of the sender.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToEmail": { + "type": "string", + "description": "Reply to email.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToName": { + "type": "string", + "description": "Reply to name.", + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "templateId" + ] + } + } + } + } } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { + "\/project\/templates\/email\/{templateId}": { "get": { - "summary": "Get deployment download", - "operationId": "sitesGetDeploymentDownload", + "summary": "Get project email template", + "operationId": "projectGetEmailTemplate", "tags": [ - "sites" + "project" ], - "description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.", "responses": { "200": { - "description": "File" + "description": "EmailTemplate", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/emailTemplate" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getDeploymentDownload", - "group": "deployments", - "weight": 502, + "method": "getEmailTemplate", + "group": "templates", + "weight": 1094, "cookies": false, - "type": "location", - "demo": "sites\/get-deployment-download.md", + "type": "", + "demo": "project\/get-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "templates.read", "platforms": [ "console", - "server", "server" ], "packaging": false, @@ -49123,66 +49327,195 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", + "name": "templateId", + "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "verification", + "enum": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ], + "x-enum-name": "EmailTemplateType", + "x-enum-keys": [] }, "in": "path" }, { - "name": "type", - "description": "Deployment file to download. Can be: \"source\", \"output\".", + "name": "locale", + "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", "required": false, "schema": { "type": "string", - "x-example": "source", + "x-example": "af", "enum": [ - "source", - "output" + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" ], - "x-enum-name": "DeploymentDownloadType", + "x-enum-name": "EmailTemplateLocale", "x-enum-keys": [], - "default": "source" + "default": "" }, "in": "query" } ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { - "patch": { - "summary": "Update deployment status", - "operationId": "sitesUpdateDeploymentStatus", + "\/project\/usage": { + "get": { + "summary": "Get project usage stats", + "operationId": "projectGetUsage", "tags": [ - "sites" + "project" ], - "description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", + "description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.", "responses": { "200": { - "description": "Deployment", + "description": "UsageProject", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deployment" + "$ref": "#\/components\/schemas\/usageProject" } } } @@ -49190,71 +49523,92 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDeploymentStatus", - "group": "deployments", - "weight": 504, + "method": "getUsage", + "group": null, + "weight": 682, "cookies": false, "type": "", - "demo": "sites\/update-deployment-status.md", + "demo": "project\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "projects.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "startDate", + "description": "Starting date for the usage", "required": true, "schema": { "type": "string", - "x-example": "" + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "in": "path" + "in": "query" }, { - "name": "deploymentId", - "description": "Deployment ID.", + "name": "endDate", + "description": "End date for the usage", "required": true, "schema": { "type": "string", - "x-example": "" + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "in": "path" + "in": "query" + }, + { + "name": "period", + "description": "Period used", + "required": false, + "schema": { + "type": "string", + "x-example": "1h", + "enum": [ + "1h", + "1d" + ], + "x-enum-name": "ProjectUsageRange", + "x-enum-keys": [ + "One Hour", + "One Day" + ], + "default": "1d" + }, + "in": "query" } ] } }, - "\/sites\/{siteId}\/logs": { + "\/project\/variables": { "get": { - "summary": "List logs", - "operationId": "sitesListLogs", + "summary": "List project variables", + "operationId": "projectListVariables", "tags": [ - "sites" + "project" ], - "description": "Get a list of all site logs. You can use the query params to filter your results.", + "description": "Get a list of all project environment variables.", "responses": { "200": { - "description": "Executions List", + "description": "Variables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/executionList" + "$ref": "#\/components\/schemas\/variableList" } } } @@ -49262,16 +49616,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 506, + "method": "listVariables", + "group": "variables", + "weight": 1097, "cookies": false, "type": "", - "demo": "sites\/list-logs.md", + "demo": "project\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "project.read", "platforms": [ "console", "server" @@ -49290,19 +49644,9 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", - "required": false, + "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: key, resourceType, resourceId, secret", + "required": false, "schema": { "type": "array", "items": { @@ -49324,293 +49668,14 @@ "in": "query" } ] - } - }, - "\/sites\/{siteId}\/logs\/{logId}": { - "get": { - "summary": "Get log", - "operationId": "sitesGetLog", - "tags": [ - "sites" - ], - "description": "Get a site request log by its unique ID.", - "responses": { - "200": { - "description": "Execution", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/execution" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getLog", - "group": "logs", - "weight": 505, - "cookies": false, - "type": "", - "demo": "sites\/get-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete log", - "operationId": "sitesDeleteLog", - "tags": [ - "sites" - ], - "description": "Delete a site log by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteLog", - "group": "logs", - "weight": 507, - "cookies": false, - "type": "", - "demo": "sites\/delete-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/usage": { - "get": { - "summary": "Get site usage", - "operationId": "sitesGetUsage", - "tags": [ - "sites" - ], - "description": "Get usage metrics and statistics for a for a specific site. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", - "responses": { - "200": { - "description": "UsageSite", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/usageSite" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 516, - "cookies": false, - "type": "", - "demo": "sites\/get-usage.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "range", - "description": "Date range.", - "required": false, - "schema": { - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" - }, - "in": "query" - } - ] - } - }, - "\/sites\/{siteId}\/variables": { - "get": { - "summary": "List variables", - "operationId": "sitesListVariables", - "tags": [ - "sites" - ], - "description": "Get a list of all variables of a specific site.", - "responses": { - "200": { - "description": "Variables List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/variableList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 510, - "cookies": false, - "type": "", - "demo": "sites\/list-variables.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] }, "post": { - "summary": "Create variable", - "operationId": "sitesCreateVariable", + "summary": "Create project variable", + "operationId": "projectCreateVariable", "tags": [ - "sites" + "project" ], - "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", "responses": { "201": { "description": "Variable", @@ -49627,14 +49692,14 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 850, + "weight": 1096, "cookies": false, "type": "", - "demo": "sites\/create-variable.md", + "demo": "project\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -49651,24 +49716,17 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -49681,11 +49739,12 @@ }, "secret": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", "x-example": false } }, "required": [ + "variableId", "key", "value" ] @@ -49695,14 +49754,14 @@ } } }, - "\/sites\/{siteId}\/variables\/{variableId}": { + "\/project\/variables\/{variableId}": { "get": { - "summary": "Get variable", - "operationId": "sitesGetVariable", + "summary": "Get project variable", + "operationId": "projectGetVariable", "tags": [ - "sites" + "project" ], - "description": "Get a variable by its unique ID.", + "description": "Get a variable by its unique ID. ", "responses": { "200": { "description": "Variable", @@ -49719,14 +49778,14 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 509, + "weight": 1098, "cookies": false, "type": "", - "demo": "sites\/get-variable.md", + "demo": "project\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "project.read", "platforms": [ "console", "server" @@ -49744,19 +49803,9 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "variableId", - "description": "Variable unique ID.", + "description": "Variable ID.", "required": true, "schema": { "type": "string", @@ -49767,10 +49816,10 @@ ] }, "put": { - "summary": "Update variable", - "operationId": "sitesUpdateVariable", + "summary": "Update project variable", + "operationId": "projectUpdateVariable", "tags": [ - "sites" + "project" ], "description": "Update variable by its unique ID.", "responses": { @@ -49789,14 +49838,14 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 511, + "weight": 1100, "cookies": false, "type": "", - "demo": "sites\/update-variable.md", + "demo": "project\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -49814,19 +49863,9 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "variableId", - "description": "Variable unique ID.", + "description": "Variable ID.", "required": true, "schema": { "type": "string", @@ -49844,7 +49883,8 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -49854,26 +49894,23 @@ }, "secret": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } } } }, "delete": { - "summary": "Delete variable", - "operationId": "sitesDeleteVariable", + "summary": "Delete project variable", + "operationId": "projectDeleteVariable", "tags": [ - "sites" + "project" ], - "description": "Delete a variable by its unique ID.", + "description": "Delete a variable by its unique ID. ", "responses": { "204": { "description": "No content" @@ -49883,14 +49920,14 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 512, + "weight": 1099, "cookies": false, "type": "", - "demo": "sites\/delete-variable.md", + "demo": "project\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -49908,19 +49945,9 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "variableId", - "description": "Variable unique ID.", + "description": "Variable ID.", "required": true, "schema": { "type": "string", @@ -49931,21 +49958,21 @@ ] } }, - "\/storage\/buckets": { + "\/projects": { "get": { - "summary": "List buckets", - "operationId": "storageListBuckets", + "summary": "List projects", + "operationId": "projectsList", "tags": [ - "storage" + "projects" ], - "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", + "description": "Get a list of all projects. You can use the query params to filter your results. ", "responses": { "200": { - "description": "Buckets List", + "description": "Projects List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/bucketList" + "$ref": "#\/components\/schemas\/projectList" } } } @@ -49953,37 +49980,34 @@ }, "deprecated": false, "x-appwrite": { - "method": "listBuckets", - "group": "buckets", - "weight": 558, + "method": "list", + "group": "projects", + "weight": 1085, "cookies": false, "type": "", - "demo": "storage\/list-buckets.md", + "demo": "projects\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "projects.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "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: name, teamId, labels, search", "required": false, "schema": { "type": "array", @@ -50019,19 +50043,19 @@ ] }, "post": { - "summary": "Create bucket", - "operationId": "storageCreateBucket", + "summary": "Create project", + "operationId": "projectsCreate", "tags": [ - "storage" + "projects" ], - "description": "Create a new storage bucket.", + "description": "Create a new project. You can create a maximum of 100 projects per account. ", "responses": { "201": { - "description": "Bucket", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/bucket" + "$ref": "#\/components\/schemas\/project" } } } @@ -50039,31 +50063,29 @@ }, "deprecated": false, "x-appwrite": { - "method": "createBucket", - "group": "buckets", - "weight": 556, + "method": "create", + "group": "projects", + "weight": 1083, "cookies": false, "type": "", - "demo": "storage\/create-bucket.md", + "demo": "projects\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "projects.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "requestBody": { @@ -50072,80 +50094,87 @@ "schema": { "type": "object", "properties": { - "bucketId": { + "projectId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", + "x-example": null }, "name": { "type": "string", - "description": "Bucket name", + "description": "Project name. Max length: 128 chars.", "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "x-example": false - }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "x-example": null, - "items": { - "type": "string" - } + "teamId": { + "type": "string", + "description": "Team unique ID.", + "x-example": "" }, - "compression": { + "region": { "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "x-example": "none", + "description": "Project Region.", + "x-example": "fra", "enum": [ - "none", - "gzip", - "zstd" + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" ], "x-enum-name": null, "x-enum-keys": [] }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "x-example": false + "description": { + "type": "string", + "description": "Project description. Max length: 256 chars.", + "x-example": "" }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "x-example": false + "logo": { + "type": "string", + "description": "Project logo.", + "x-example": "" }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "x-example": false + "url": { + "type": "string", + "description": "Project URL.", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "legalName": { + "type": "string", + "description": "Project legal Name. Max length: 256 chars.", + "x-example": "" + }, + "legalCountry": { + "type": "string", + "description": "Project legal Country. Max length: 256 chars.", + "x-example": "" + }, + "legalState": { + "type": "string", + "description": "Project legal State. Max length: 256 chars.", + "x-example": "" + }, + "legalCity": { + "type": "string", + "description": "Project legal City. Max length: 256 chars.", + "x-example": "" + }, + "legalAddress": { + "type": "string", + "description": "Project legal Address. Max length: 256 chars.", + "x-example": "" + }, + "legalTaxId": { + "type": "string", + "description": "Project legal Tax ID. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "bucketId", - "name" + "projectId", + "name", + "teamId" ] } } @@ -50153,21 +50182,21 @@ } } }, - "\/storage\/buckets\/{bucketId}": { + "\/projects\/{projectId}": { "get": { - "summary": "Get bucket", - "operationId": "storageGetBucket", + "summary": "Get project", + "operationId": "projectsGet", "tags": [ - "storage" + "projects" ], - "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", + "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", "responses": { "200": { - "description": "Bucket", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/bucket" + "$ref": "#\/components\/schemas\/project" } } } @@ -50175,60 +50204,58 @@ }, "deprecated": false, "x-appwrite": { - "method": "getBucket", - "group": "buckets", - "weight": 557, + "method": "get", + "group": "projects", + "weight": 57, "cookies": false, "type": "", - "demo": "storage\/get-bucket.md", + "demo": "projects\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "projects.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, - "put": { - "summary": "Update bucket", - "operationId": "storageUpdateBucket", + "patch": { + "summary": "Update project", + "operationId": "projectsUpdate", "tags": [ - "storage" + "projects" ], - "description": "Update a storage bucket by its unique ID.", + "description": "Update a project by its unique ID.", "responses": { "200": { - "description": "Bucket", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/bucket" + "$ref": "#\/components\/schemas\/project" } } } @@ -50236,41 +50263,39 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateBucket", - "group": "buckets", - "weight": 559, + "method": "update", + "group": "projects", + "weight": 1084, "cookies": false, "type": "", - "demo": "storage\/update-bucket.md", + "demo": "projects\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "projects.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -50283,68 +50308,54 @@ "properties": { "name": { "type": "string", - "description": "Bucket name", + "description": "Project name. Max length: 128 chars.", "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true + "description": { + "type": "string", + "description": "Project description. Max length: 256 chars.", + "x-example": "" }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false + "logo": { + "type": "string", + "description": "Project logo.", + "x-example": "" }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "x-example": false + "url": { + "type": "string", + "description": "Project URL.", + "x-example": "https:\/\/example.com", + "format": "url" }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "x-example": 1, - "format": "int32" + "legalName": { + "type": "string", + "description": "Project legal name. Max length: 256 chars.", + "x-example": "" }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "x-example": null, - "items": { - "type": "string" - } + "legalCountry": { + "type": "string", + "description": "Project legal country. Max length: 256 chars.", + "x-example": "" }, - "compression": { + "legalState": { "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "Project legal state. Max length: 256 chars.", + "x-example": "" }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "x-example": false + "legalCity": { + "type": "string", + "description": "Project legal city. Max length: 256 chars.", + "x-example": "" }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "x-example": false + "legalAddress": { + "type": "string", + "description": "Project legal address. Max length: 256 chars.", + "x-example": "" }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "x-example": false + "legalTaxId": { + "type": "string", + "description": "Project legal tax ID. Max length: 256 chars.", + "x-example": "" } }, "required": [ @@ -50354,14 +50365,16 @@ } } } - }, - "delete": { - "summary": "Delete bucket", - "operationId": "storageDeleteBucket", + } + }, + "\/projects\/{projectId}\/console-access": { + "patch": { + "summary": "Record console access to a project", + "operationId": "projectsUpdateConsoleAccess", "tags": [ - "storage" + "projects" ], - "description": "Delete a storage bucket by its unique ID.", + "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", "responses": { "204": { "description": "No content" @@ -50369,62 +50382,60 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteBucket", - "group": "buckets", - "weight": 560, + "method": "updateConsoleAccess", + "group": null, + "weight": 1080, "cookies": false, "type": "", - "demo": "storage\/delete-bucket.md", + "demo": "projects\/update-console-access.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "projects.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "projectId", + "description": "Project ID", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/storage\/buckets\/{bucketId}\/files": { + "\/projects\/{projectId}\/dev-keys": { "get": { - "summary": "List files", - "operationId": "storageListFiles", + "summary": "List dev keys", + "operationId": "projectsListDevKeys", "tags": [ - "storage" + "projects" ], - "description": "Get a list of all the user files. You can use the query params to filter your results.", + "description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", "responses": { "200": { - "description": "Files List", + "description": "Dev Keys List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/fileList" + "$ref": "#\/components\/schemas\/devKeyList" } } } @@ -50432,50 +50443,44 @@ }, "deprecated": false, "x-appwrite": { - "method": "listFiles", - "group": "files", - "weight": 563, + "method": "listDevKeys", + "group": "devKeys", + "weight": 404, "cookies": false, "type": "", - "demo": "storage\/list-files.md", + "demo": "projects\/list-dev-keys.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "devKeys.read", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "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: accessedAt, expire", "required": false, "schema": { "type": "array", @@ -50485,45 +50490,23 @@ "default": [] }, "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" } ] }, "post": { - "summary": "Create file", - "operationId": "storageCreateFile", + "summary": "Create dev key", + "operationId": "projectsCreateDevKey", "tags": [ - "storage" + "projects" ], - "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", "responses": { "201": { - "description": "File", + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/devKey" } } } @@ -50531,79 +50514,63 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFile", - "group": "files", - "weight": 1073, + "method": "createDevKey", + "group": "devKeys", + "weight": 401, "cookies": false, - "type": "upload", - "demo": "storage\/create-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", - "scope": "files.write", + "type": "", + "demo": "projects\/create-dev-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "devKeys.write", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ], "requestBody": { "content": { - "multipart\/form-data": { + "application\/json": { "schema": { "type": "object", "properties": { - "fileId": { + "name": { "type": "string", - "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", - "x-upload-id": true + "description": "Key name. Max length: 128 chars.", + "x-example": "" }, - "file": { + "expire": { "type": "string", - "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "x-example": null, - "format": "binary" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" } }, "required": [ - "fileId", - "file" + "name", + "expire" ] } } @@ -50611,21 +50578,21 @@ } } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "\/projects\/{projectId}\/dev-keys\/{keyId}": { "get": { - "summary": "Get file", - "operationId": "storageGetFile", + "summary": "Get dev key", + "operationId": "projectsGetDevKey", "tags": [ - "storage" + "projects" ], - "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", "responses": { "200": { - "description": "File", + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/devKey" } } } @@ -50633,73 +50600,67 @@ }, "deprecated": false, "x-appwrite": { - "method": "getFile", - "group": "files", - "weight": 562, + "method": "getDevKey", + "group": "devKeys", + "weight": 403, "cookies": false, "type": "", - "demo": "storage\/get-file.md", + "demo": "projects\/get-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "devKeys.read", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, "put": { - "summary": "Update file", - "operationId": "storageUpdateFile", + "summary": "Update dev key", + "operationId": "projectsUpdateDevKey", "tags": [ - "storage" + "projects" ], - "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", + "description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", "responses": { "200": { - "description": "File", + "description": "DevKey", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/devKey" } } } @@ -50707,54 +50668,48 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFile", - "group": "files", - "weight": 564, + "method": "updateDevKey", + "group": "devKeys", + "weight": 402, "cookies": false, "type": "", - "demo": "storage\/update-file.md", + "demo": "projects\/update-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.write", + "scope": "devKeys.write", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -50767,31 +50722,32 @@ "properties": { "name": { "type": "string", - "description": "File name.", + "description": "Key name. Max length: 128 chars.", "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" } - } - } - } + }, + "required": [ + "name", + "expire" + ] + } + } } } }, "delete": { - "summary": "Delete file", - "operationId": "storageDeleteFile", + "summary": "Delete dev key", + "operationId": "projectsDeleteDevKey", "tags": [ - "storage" + "projects" ], - "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", "responses": { "204": { "description": "No content" @@ -50799,488 +50755,349 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteFile", - "group": "files", - "weight": 565, + "method": "deleteDevKey", + "group": "devKeys", + "weight": 405, "cookies": false, "type": "", - "demo": "storage\/delete-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "files.write", + "demo": "projects\/delete-dev-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "devKeys.write", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "\/projects\/{projectId}\/schedules": { "get": { - "summary": "Get file for download", - "operationId": "storageGetFileDownload", + "summary": "List schedules", + "operationId": "projectsListSchedules", "tags": [ - "storage" + "projects" ], - "description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "description": "Get a list of all the project's schedules. You can use the query params to filter your results.", "responses": { "200": { - "description": "File" + "description": "Schedules List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/scheduleList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getFileDownload", - "group": "files", - "weight": 567, + "method": "listSchedules", + "group": "schedules", + "weight": 412, "cookies": false, - "type": "location", - "demo": "storage\/get-file-download.md", + "type": "", + "demo": "projects\/list-schedules.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "schedules.read", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-schedules.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: resourceType, resourceId, projectId, schedule, active, region", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "token", - "description": "File token for accessing this file.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, "schema": { - "type": "string", - "x-example": "", - "default": "" + "type": "boolean", + "x-example": false, + "default": true }, "in": "query" } ] - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { - "get": { - "summary": "Get file preview", - "operationId": "storageGetFilePreview", + }, + "post": { + "summary": "Create schedule", + "operationId": "projectsCreateSchedule", "tags": [ - "storage" + "projects" ], - "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", + "description": "Create a new schedule for a resource.", "responses": { - "200": { - "description": "Image" + "201": { + "description": "Schedule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/schedule" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getFilePreview", - "group": "files", - "weight": 566, + "method": "createSchedule", + "group": "schedules", + "weight": 1086, "cookies": false, - "type": "location", - "demo": "storage\/get-file-preview.md", + "type": "", + "demo": "projects\/create-schedule.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "schedules.write", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-schedule.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "width", - "description": "Resize preview image width, Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "height", - "description": "Resize preview image height, Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "gravity", - "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", - "required": false, - "schema": { - "type": "string", - "x-example": "center", - "enum": [ - "center", - "top-left", - "top", - "top-right", - "left", - "right", - "bottom-left", - "bottom", - "bottom-right" - ], - "x-enum-name": "ImageGravity", - "x-enum-keys": [], - "default": "center" - }, - "in": "query" - }, - { - "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1 - }, - "in": "query" - }, - { - "name": "borderWidth", - "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "borderColor", - "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", - "required": false, - "schema": { - "type": "string", - "default": "" - }, - "in": "query" - }, - { - "name": "borderRadius", - "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "opacity", - "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", - "required": false, - "schema": { - "type": "number", - "format": "float", - "x-example": 0, - "default": 1 - }, - "in": "query" - }, - { - "name": "rotation", - "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": -360, - "default": 0 - }, - "in": "query" - }, - { - "name": "background", - "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", - "required": false, - "schema": { - "type": "string", - "default": "" - }, - "in": "query" - }, - { - "name": "output", - "description": "Output format type (jpeg, jpg, png, gif and webp).", - "required": false, - "schema": { - "type": "string", - "x-example": "jpg", - "enum": [ - "jpg", - "jpeg", - "png", - "webp", - "heic", - "avif", - "gif" - ], - "x-enum-name": "ImageFormat", - "x-enum-keys": [], - "default": "" - }, - "in": "query" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type for the schedule. Possible values: function, execution, message, backup.", + "x-example": "function", + "enum": [ + "function", + "execution", + "message", + "backup" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "resourceId": { + "type": "string", + "description": "The resource ID to associate with this schedule.", + "x-example": "" + }, + "schedule": { + "type": "string", + "description": "Schedule CRON expression.", + "x-example": null + }, + "active": { + "type": "boolean", + "description": "Whether the schedule is active.", + "x-example": false + }, + "data": { + "type": "object", + "description": "Schedule data as a JSON string. Used to store resource-specific context needed for execution.", + "x-example": "{}" + } + }, + "required": [ + "resourceType", + "resourceId", + "schedule" + ] + } + } + } + } } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { + "\/projects\/{projectId}\/schedules\/{scheduleId}": { "get": { - "summary": "Get file for view", - "operationId": "storageGetFileView", + "summary": "Get schedule", + "operationId": "projectsGetSchedule", "tags": [ - "storage" + "projects" ], - "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", + "description": "Get a schedule by its unique ID.", "responses": { "200": { - "description": "File" + "description": "Schedule", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/schedule" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getFileView", - "group": "files", - "weight": 568, + "method": "getSchedule", + "group": "schedules", + "weight": 411, "cookies": false, - "type": "location", - "demo": "storage\/get-file-view.md", + "type": "", + "demo": "projects\/get-schedule.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "schedules.read", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-schedule.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "scheduleId", + "description": "Schedule ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" } ] } }, - "\/storage\/usage": { - "get": { - "summary": "Get storage usage stats", - "operationId": "storageGetUsage", + "\/projects\/{projectId}\/status": { + "patch": { + "summary": "Update the status of a project", + "operationId": "projectsUpdateStatus", "tags": [ - "storage" + "projects" ], - "description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", + "description": "Update the status of a project. Can be used to archive\/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.\n", "responses": { - "200": { - "description": "StorageUsage", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/usageStorage" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getUsage", + "method": "updateStatus", "group": null, - "weight": 570, + "weight": 1081, "cookies": false, "type": "", - "demo": "storage\/get-usage.md", - "rate-limit": 0, + "demo": "projects\/update-status.md", + "rate-limit": 10, "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "rate-key": "ip:{ip},userId:{userId}", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-status.md", "auth": { "Project": [] } @@ -51292,45 +51109,57 @@ ], "parameters": [ { - "name": "range", - "description": "Date range.", - "required": false, + "name": "projectId", + "description": "Project ID", + "required": true, "schema": { "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" + "x-example": "" }, - "in": "query" + "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "New status for the project", + "x-example": "active", + "enum": [ + "active" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "status" + ] + } + } + } + } } }, - "\/storage\/{bucketId}\/usage": { - "get": { - "summary": "Get bucket usage stats", - "operationId": "storageGetBucketUsage", + "\/projects\/{projectId}\/team": { + "patch": { + "summary": "Update project team", + "operationId": "projectsUpdateTeam", "tags": [ - "storage" + "projects" ], - "description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", + "description": "Update the team ID of a project allowing for it to be transferred to another team.", "responses": { "200": { - "description": "UsageBuckets", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageBuckets" + "$ref": "#\/components\/schemas\/project" } } } @@ -51338,22 +51167,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "getBucketUsage", - "group": null, - "weight": 571, + "method": "updateTeam", + "group": "projects", + "weight": 1082, "cookies": false, "type": "", - "demo": "storage\/get-bucket-usage.md", + "demo": "projects\/update-team.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md", "auth": { "Project": [] } @@ -51365,55 +51194,52 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Bucket ID.", + "name": "projectId", + "description": "Project unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "range", - "description": "Date range.", - "required": false, - "schema": { - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" - }, - "in": "query" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer project to.", + "x-example": "" + } + }, + "required": [ + "teamId" + ] + } + } + } + } } }, - "\/tablesdb": { + "\/proxy\/rules": { "get": { - "summary": "List databases", - "operationId": "tablesDBList", + "summary": "List rules", + "operationId": "proxyListRules", "tags": [ - "tablesDB" + "proxy" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "Get a list of all the proxy rules. You can use the query params to filter your results.", "responses": { "200": { - "description": "Databases List", + "description": "Rule List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/databaseList" + "$ref": "#\/components\/schemas\/proxyRuleList" } } } @@ -51421,37 +51247,34 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "tablesdb", - "weight": 709, + "method": "listRules", + "group": null, + "weight": 1193, "cookies": false, "type": "", - "demo": "tablesdb\/list.md", + "demo": "proxy\/list-rules.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "rules.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "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 columns: name", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch", "required": false, "schema": { "type": "array", @@ -51485,21 +51308,23 @@ "in": "query" } ] - }, + } + }, + "\/proxy\/rules\/api": { "post": { - "summary": "Create database", - "operationId": "tablesDBCreate", + "summary": "Create API rule", + "operationId": "proxyCreateAPIRule", "tags": [ - "tablesDB" + "proxy" ], - "description": "Create a new Database.\n", + "description": "Create a new proxy rule for serving Appwrite's API on custom domain.", "responses": { "201": { - "description": "Database", + "description": "Rule", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/proxyRule" } } } @@ -51507,31 +51332,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "tablesdb", - "weight": 705, + "method": "createAPIRule", + "group": null, + "weight": 1188, "cookies": false, "type": "", - "demo": "tablesdb\/create.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "demo": "proxy\/create-api-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "requestBody": { @@ -51540,25 +51362,14 @@ "schema": { "type": "object", "properties": { - "databaseId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { + "domain": { "type": "string", - "description": "Database name. Max length: 128 chars.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "x-example": false + "description": "Domain name.", + "x-example": null } }, "required": [ - "databaseId", - "name" + "domain" ] } } @@ -51566,21 +51377,21 @@ } } }, - "\/tablesdb\/transactions": { - "get": { - "summary": "List transactions", - "operationId": "tablesDBListTransactions", + "\/proxy\/rules\/function": { + "post": { + "summary": "Create function rule", + "operationId": "proxyCreateFunctionRule", "tags": [ - "tablesDB" + "proxy" ], - "description": "List transactions across all databases.", + "description": "Create a new proxy rule for executing Appwrite Function on custom domain.", "responses": { - "200": { - "description": "Transaction List", + "201": { + "description": "Rule", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transactionList" + "$ref": "#\/components\/schemas\/proxyRule" } } } @@ -51588,69 +51399,77 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 776, + "method": "createFunctionRule", + "group": null, + "weight": 1190, "cookies": false, "type": "", - "demo": "tablesdb\/list-transactions.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "demo": "proxy\/create-function-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", "platforms": [ - "console", - "server", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "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).", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": null + }, + "functionId": { + "type": "string", + "description": "ID of function to be executed.", + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "x-example": "" + } + }, + "required": [ + "domain", + "functionId" + ] + } + } } - ] - }, + } + } + }, + "\/proxy\/rules\/redirect": { "post": { - "summary": "Create transaction", - "operationId": "tablesDBCreateTransaction", + "summary": "Create Redirect rule", + "operationId": "proxyCreateRedirectRule", "tags": [ - "tablesDB" + "proxy" ], - "description": "Create a new transaction.", + "description": "Create a new proxy rule for to redirect from custom domain to another domain.", "responses": { "201": { - "description": "Transaction", + "description": "Rule", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/proxyRule" } } } @@ -51658,37 +51477,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 772, + "method": "createRedirectRule", + "group": null, + "weight": 1191, "cookies": false, "type": "", - "demo": "tablesdb\/create-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "demo": "proxy\/create-redirect-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", "platforms": [ - "console", - "server", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "requestBody": { @@ -51697,34 +51507,83 @@ "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "x-example": 60, - "format": "int32" + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": null + }, + "url": { + "type": "string", + "description": "Target URL of redirection", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "statusCode": { + "type": "string", + "description": "Status code of redirection", + "x-example": "301", + "enum": [ + "301", + "302", + "307", + "308" + ], + "x-enum-name": null, + "x-enum-keys": [ + "Moved Permanently 301", + "Found 302", + "Temporary Redirect 307", + "Permanent Redirect 308" + ] + }, + "resourceId": { + "type": "string", + "description": "ID of parent resource.", + "x-example": "" + }, + "resourceType": { + "type": "string", + "description": "Type of parent resource.", + "x-example": "site", + "enum": [ + "site", + "function" + ], + "x-enum-name": "ProxyResourceType", + "x-enum-keys": [ + "Site", + "Function" + ] } - } + }, + "required": [ + "domain", + "url", + "statusCode", + "resourceId", + "resourceType" + ] } } } } } }, - "\/tablesdb\/transactions\/{transactionId}": { - "get": { - "summary": "Get transaction", - "operationId": "tablesDBGetTransaction", + "\/proxy\/rules\/site": { + "post": { + "summary": "Create site rule", + "operationId": "proxyCreateSiteRule", "tags": [ - "tablesDB" + "proxy" ], - "description": "Get a transaction by its unique ID.", + "description": "Create a new proxy rule for serving Appwrite Site on custom domain.", "responses": { - "200": { - "description": "Transaction", + "201": { + "description": "Rule", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/proxyRule" } } } @@ -51732,66 +51591,77 @@ }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 773, + "method": "createSiteRule", + "group": null, + "weight": 1189, "cookies": false, "type": "", - "demo": "tablesdb\/get-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "demo": "proxy\/create-site-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", "platforms": [ - "console", - "server", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "x-example": null + }, + "siteId": { + "type": "string", + "description": "ID of site to be executed.", + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "x-example": "" + } + }, + "required": [ + "domain", + "siteId" + ] + } + } } - ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "tablesDBUpdateTransaction", + } + } + }, + "\/proxy\/rules\/{ruleId}": { + "get": { + "summary": "Get rule", + "operationId": "proxyGetRule", "tags": [ - "tablesDB" + "proxy" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Get a proxy rule by its unique ID.", "responses": { "200": { - "description": "Transaction", + "description": "Rule", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/proxyRule" } } } @@ -51799,80 +51669,50 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 774, + "method": "getRule", + "group": null, + "weight": 1192, "cookies": false, "type": "", - "demo": "tablesdb\/update-transaction.md", + "demo": "proxy\/get-rule.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "rules.read", "platforms": [ - "console", - "server", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "ruleId", + "description": "Rule ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "x-example": false - } - } - } - } - } - } + ] }, "delete": { - "summary": "Delete transaction", - "operationId": "tablesDBDeleteTransaction", + "summary": "Delete rule", + "operationId": "proxyDeleteRule", "tags": [ - "tablesDB" + "proxy" ], - "description": "Delete a transaction by its unique ID.", + "description": "Delete a proxy rule by its unique ID.", "responses": { "204": { "description": "No content" @@ -51880,156 +51720,59 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 775, + "method": "deleteRule", + "group": null, + "weight": 1194, "cookies": false, "type": "", - "demo": "tablesdb\/delete-transaction.md", + "demo": "proxy\/delete-rule.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "rules.write", "platforms": [ - "console", - "server", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/tablesdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "tablesDBCreateOperations", - "tags": [ - "tablesDB" - ], - "description": "Create multiple operations in a single transaction.", - "responses": { - "201": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 777, - "cookies": false, - "type": "", - "demo": "tablesdb\/create-operations.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", - "auth": { "Project": [] } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "ruleId", + "description": "Rule ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } - } - } - } - } - } - } + ] } }, - "\/tablesdb\/usage": { - "get": { - "summary": "Get TablesDB usage stats", - "operationId": "tablesDBListUsage", + "\/proxy\/rules\/{ruleId}\/verification": { + "patch": { + "summary": "Update rule verification status", + "operationId": "proxyUpdateRuleVerification", "tags": [ - "tablesDB" + "proxy" ], - "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.", "responses": { "200": { - "description": "UsageDatabases", + "description": "Rule", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageDatabases" + "$ref": "#\/components\/schemas\/proxyRule" } } } @@ -52037,297 +51780,59 @@ }, "deprecated": false, "x-appwrite": { - "method": "listUsage", + "method": "updateRuleVerification", "group": null, - "weight": 711, + "weight": 1195, "cookies": false, "type": "", - "demo": "tablesdb\/list-usage.md", + "demo": "proxy\/update-rule-verification.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "rules.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md", - "methods": [ - { - "name": "listUsage", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "range" - ], - "required": [], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/usageDatabases" - } - ], - "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", - "demo": "tablesdb\/list-usage.md", - "public": true - } - ], - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "range", - "description": "Date range.", - "required": false, - "schema": { - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" - }, - "in": "query" - } - ] - } - }, - "\/tablesdb\/{databaseId}": { - "get": { - "summary": "Get database", - "operationId": "tablesDBGet", - "tags": [ - "tablesDB" - ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", - "responses": { - "200": { - "description": "Database", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/database" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "get", - "group": "tablesdb", - "weight": 706, - "cookies": false, - "type": "", - "demo": "tablesdb\/get.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "put": { - "summary": "Update database", - "operationId": "tablesDBUpdate", - "tags": [ - "tablesDB" - ], - "description": "Update a database by its unique ID.", - "responses": { - "200": { - "description": "Database", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/database" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "update", - "group": "tablesdb", - "weight": 707, - "cookies": false, - "type": "", - "demo": "tablesdb\/update.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "x-example": false - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete database", - "operationId": "tablesDBDelete", - "tags": [ - "tablesDB" - ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "delete", - "group": "tablesdb", - "weight": 708, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", - "auth": { "Project": [] } - }, - "security": [ - { - "Project": [], - "Key": [] - } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "ruleId", + "description": "Rule ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/tablesdb\/{databaseId}\/tables": { + "\/sites": { "get": { - "summary": "List tables", - "operationId": "tablesDBListTables", + "summary": "List sites", + "operationId": "sitesList", "tags": [ - "tablesDB" + "sites" ], - "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "description": "Get a list of all the project's sites. You can use the query params to filter your results.", "responses": { "200": { - "description": "Tables List", + "description": "Sites List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/tableList" + "$ref": "#\/components\/schemas\/siteList" } } } @@ -52335,26 +51840,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTables", - "group": "tables", - "weight": 716, + "method": "list", + "group": "sites", + "weight": 470, "cookies": false, "type": "", - "demo": "tablesdb\/list-tables.md", + "demo": "sites\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [] } @@ -52366,19 +51867,9 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name, enabled, rowSecurity", + "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: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", "required": false, "schema": { "type": "array", @@ -52414,19 +51905,19 @@ ] }, "post": { - "summary": "Create table", - "operationId": "tablesDBCreateTable", + "summary": "Create site", + "operationId": "sitesCreate", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new site.", "responses": { "201": { - "description": "Table", + "description": "Site", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/site" } } } @@ -52434,26 +51925,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTable", - "group": "tables", - "weight": 712, + "method": "create", + "group": "sites", + "weight": 903, "cookies": false, "type": "", - "demo": "tablesdb\/create-table.md", + "demo": "sites\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [] } @@ -52464,73 +51951,246 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "tableId": { + "siteId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, "name": { "type": "string", - "description": "Table name. Max length: 128 chars.", + "description": "Site name. Max length: 128 chars.", "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true + "framework": { + "type": "string", + "description": "Sites framework.", + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] }, - "rowSecurity": { + "enabled": { "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", "x-example": false }, - "enabled": { + "logging": { "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", "x-example": false }, - "columns": { - "type": "array", - "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", - "x-example": null, - "items": { - "type": "object" - } + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "x-example": 1, + "format": "int32" }, - "indexes": { - "type": "array", - "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", - "x-example": null, - "items": { - "type": "object" - } + "installCommand": { + "type": "string", + "description": "Install Command.", + "x-example": "" + }, + "buildCommand": { + "type": "string", + "description": "Build Command.", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { + "type": "string", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "x-example": "static", + "enum": [ + "static", + "ssr" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "x-example": "" + }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "x-example": "" + }, + "providerSilentMode": { + "type": "boolean", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", + "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" } }, "required": [ - "tableId", - "name" + "siteId", + "name", + "framework", + "buildRuntime" ] } } @@ -52538,21 +52198,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "\/sites\/frameworks": { "get": { - "summary": "Get table", - "operationId": "tablesDBGetTable", + "summary": "List frameworks", + "operationId": "sitesListFrameworks", "tags": [ - "tablesDB" + "sites" ], - "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "description": "Get a list of all frameworks that are currently available on the server instance.", "responses": { "200": { - "description": "Table", + "description": "Frameworks List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/frameworkList" } } } @@ -52560,26 +52220,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "getTable", - "group": "tables", - "weight": 713, + "method": "listFrameworks", + "group": "frameworks", + "weight": 473, "cookies": false, "type": "", - "demo": "tablesdb\/get-table.md", + "demo": "sites\/list-frameworks.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "public", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [] } @@ -52589,178 +52245,47 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } ] - }, - "put": { - "summary": "Update table", - "operationId": "tablesDBUpdateTable", + } + }, + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a table by its unique ID.", + "description": "List allowed site specifications for this instance.", "responses": { "200": { - "description": "Table", + "description": "Specifications List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateTable", - "group": "tables", - "weight": 714, - "cookies": false, - "type": "", - "demo": "tablesdb\/update-table.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "rowSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", - "x-example": false - }, - "purge": { - "type": "boolean", - "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", - "x-example": false - } + "$ref": "#\/components\/schemas\/specificationList" } } } } - } - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", - "tags": [ - "tablesDB" - ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", - "responses": { - "204": { - "description": "No content" - } }, "deprecated": false, "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 715, + "method": "listSpecifications", + "group": "frameworks", + "weight": 496, "cookies": false, "type": "", - "demo": "tablesdb\/delete-table.md", + "demo": "sites\/list-specifications.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [] } @@ -52770,46 +52295,24 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "\/sites\/templates": { "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", + "summary": "List templates", + "operationId": "sitesListTemplates", "tags": [ - "tablesDB" + "sites" ], - "description": "List columns in the table.", + "description": "List available site templates. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.", "responses": { "200": { - "description": "Columns List", + "description": "Site Templates List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnList" + "$ref": "#\/components\/schemas\/templateSiteList" } } } @@ -52817,99 +52320,131 @@ }, "deprecated": false, "x-appwrite": { - "method": "listColumns", - "group": "columns", - "weight": 721, + "method": "listTemplates", + "group": "templates", + "weight": 492, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "sites\/list-templates.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "public", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "frameworks", + "description": "List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.", + "required": false, "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", + "type": "array", + "items": { + "type": "string", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "default": [] + }, + "in": "query" + }, + { + "name": "useCases", + "description": "List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.", "required": false, "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "portfolio", + "starter", + "events", + "ecommerce", + "documentation", + "blog", + "ai", + "forms", + "dashboard" + ], + "x-enum-name": null, + "x-enum-keys": [] }, "default": [] }, "in": "query" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "name": "limit", + "description": "Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.", "required": false, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "integer", + "format": "int32", + "x-example": 1, + "default": 25 + }, + "in": "query" + }, + { + "name": "offset", + "description": "Offset the list of returned templates. Maximum offset is 5000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 }, "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { - "post": { - "summary": "Create boolean column", - "operationId": "tablesDBCreateBooleanColumn", + "\/sites\/templates\/{templateId}": { + "get": { + "summary": "Get site template", + "operationId": "sitesGetTemplate", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a boolean column.\n", + "description": "Get a site template using ID. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.", "responses": { - "202": { - "description": "ColumnBoolean", + "200": { + "description": "Template Site", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnBoolean" + "$ref": "#\/components\/schemas\/templateSite" } } } @@ -52917,111 +52452,59 @@ }, "deprecated": false, "x-appwrite": { - "method": "createBooleanColumn", - "group": "columns", - "weight": 722, + "method": "getTemplate", + "group": "templates", + "weight": 493, "cookies": false, "type": "", - "demo": "tablesdb\/create-boolean-column.md", + "demo": "sites\/get-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "public", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "templateId", + "description": "Template ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { - "patch": { - "summary": "Update boolean column", - "operationId": "tablesDBUpdateBooleanColumn", + "\/sites\/usage": { + "get": { + "summary": "Get sites usage", + "operationId": "sitesListUsage", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "description": "Get usage metrics and statistics for all sites in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", "responses": { "200": { - "description": "ColumnBoolean", + "description": "UsageSites", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnBoolean" + "$ref": "#\/components\/schemas\/usageSites" } } } @@ -53029,116 +52512,71 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateBooleanColumn", - "group": "columns", - "weight": 723, + "method": "listUsage", + "group": null, + "weight": 494, "cookies": false, "type": "", - "demo": "tablesdb\/update-boolean-column.md", + "demo": "sites\/list-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { - "post": { - "summary": "Create datetime column", - "operationId": "tablesDBCreateDatetimeColumn", + "\/sites\/{siteId}": { + "get": { + "summary": "Get site", + "operationId": "sitesGet", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a date time column according to the ISO 8601 standard.", + "description": "Get a site by its unique ID.", "responses": { - "202": { - "description": "ColumnDatetime", + "200": { + "description": "Site", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnDatetime" + "$ref": "#\/components\/schemas\/site" } } } @@ -53146,26 +52584,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDatetimeColumn", - "group": "columns", - "weight": 724, + "method": "get", + "group": "sites", + "weight": 469, "cookies": false, "type": "", - "demo": "tablesdb\/create-datetime-column.md", + "demo": "sites\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [] } @@ -53178,80 +52612,31 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { - "patch": { - "summary": "Update dateTime column", - "operationId": "tablesDBUpdateDatetimeColumn", + ] + }, + "put": { + "summary": "Update site", + "operationId": "sitesUpdate", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "description": "Update site by its unique ID.", "responses": { "200": { - "description": "ColumnDatetime", + "description": "Site", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnDatetime" + "$ref": "#\/components\/schemas\/site" } } } @@ -53259,26 +52644,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDatetimeColumn", - "group": "columns", - "weight": 725, + "method": "update", + "group": "sites", + "weight": 904, "cookies": false, "type": "", - "demo": "tablesdb\/update-datetime-column.md", + "demo": "sites\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [] } @@ -53291,31 +52672,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } @@ -53326,77 +52688,269 @@ "schema": { "type": "object", "properties": { - "required": { + "name": { + "type": "string", + "description": "Site name. Max length: 128 chars.", + "x-example": "" + }, + "framework": { + "type": "string", + "description": "Sites framework.", + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "enabled": { "type": "boolean", - "description": "Is column required?", + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", "x-example": false }, - "default": { + "logging": { + "type": "boolean", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "x-example": false + }, + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "x-example": 1, + "format": "int32" + }, + "installCommand": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true + "description": "Install Command.", + "x-example": "" }, - "newKey": { + "buildCommand": { "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { - "post": { - "summary": "Create email column", - "operationId": "tablesDBCreateEmailColumn", - "tags": [ - "tablesDB" - ], - "description": "Create an email column.\n", - "responses": { - "202": { - "description": "ColumnEmail", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnEmail" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createEmailColumn", - "group": "columns", - "weight": 726, - "cookies": false, + "description": "Build Command.", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { + "type": "string", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "x-example": "static", + "enum": [ + "static", + "ssr" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "x-example": "" + }, + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "x-example": "" + }, + "providerSilentMode": { + "type": "boolean", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", + "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "name", + "framework" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete site", + "operationId": "sitesDelete", + "tags": [ + "sites" + ], + "description": "Delete a site by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "sites", + "weight": 472, + "cookies": false, "type": "", - "demo": "tablesdb\/create-email-column.md", + "demo": "sites\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [] } @@ -53409,22 +52963,74 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, + } + ] + } + }, + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", + "tags": [ + "sites" + ], + "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "responses": { + "200": { + "description": "Site", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/site" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSiteDeployment", + "group": "sites", + "weight": 479, + "cookies": false, + "type": "", + "demo": "sites\/update-site-deployment.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "tableId", - "description": "Table ID.", + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -53435,32 +53041,14 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { + "deploymentId": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false + "description": "Deployment ID.", + "x-example": "" } }, "required": [ - "key", - "required" + "deploymentId" ] } } @@ -53468,21 +53056,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { - "patch": { - "summary": "Update email column", - "operationId": "tablesDBUpdateEmailColumn", + "\/sites\/{siteId}\/deployments": { + "get": { + "summary": "List deployments", + "operationId": "sitesListDeployments", "tags": [ - "tablesDB" + "sites" ], - "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", "responses": { "200": { - "description": "ColumnEmail", + "description": "Deployments List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEmail" + "$ref": "#\/components\/schemas\/deploymentList" } } } @@ -53490,26 +53078,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailColumn", - "group": "columns", - "weight": 727, + "method": "listDeployments", + "group": "deployments", + "weight": 478, "cookies": false, "type": "", - "demo": "tablesdb\/update-email-column.md", + "demo": "sites\/list-deployments.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [] } @@ -53522,63 +53106,149 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" + "in": "query" }, { - "name": "key", - "description": "Column Key.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create deployment", + "operationId": "sitesCreateDeployment", + "tags": [ + "sites" + ], + "description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.", + "responses": { + "202": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDeployment", + "group": "deployments", + "weight": 474, + "cookies": false, + "type": "upload", + "demo": "sites\/create-deployment.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "console", + "server" + ], + "packaging": true, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" }, "in": "path" } ], "requestBody": { "content": { - "application\/json": { + "multipart\/form-data": { "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "installCommand": { + "type": "string", + "description": "Install Commands.", + "x-example": "", + "x-nullable": true }, - "default": { + "buildCommand": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", - "format": "email", + "description": "Build Commands.", + "x-example": "", "x-nullable": true }, - "newKey": { + "outputDirectory": { "type": "string", - "description": "New Column Key.", - "x-example": null, + "description": "Output Directory.", + "x-example": "", "x-nullable": true + }, + "code": { + "type": "string", + "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", + "x-example": null, + "format": "binary" + }, + "activate": { + "type": "boolean", + "description": "Automatically activate the deployment when it is finished building.", + "x-example": false } }, "required": [ - "required", - "default" + "code" ] } } @@ -53586,21 +53256,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "\/sites\/{siteId}\/deployments\/duplicate": { "post": { - "summary": "Create enum column", - "operationId": "tablesDBCreateEnumColumn", + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.", "responses": { "202": { - "description": "ColumnEnum", + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEnum" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -53608,26 +53278,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createEnumColumn", - "group": "columns", - "weight": 728, + "method": "createDuplicateDeployment", + "group": "deployments", + "weight": 482, "cookies": false, "type": "", - "demo": "tablesdb\/create-enum-column.md", + "demo": "sites\/create-duplicate-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [] } @@ -53640,22 +53306,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -53666,40 +53322,14 @@ "schema": { "type": "object", "properties": { - "key": { + "deploymentId": { "type": "string", - "description": "Column Key.", - "x-example": null - }, - "elements": { - "type": "array", - "description": "Array of enum values.", - "x-example": null, - "items": { - "type": "string" - } - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false + "description": "Deployment ID.", + "x-example": "" } }, "required": [ - "key", - "elements", - "required" + "deploymentId" ] } } @@ -53707,21 +53337,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { - "patch": { - "summary": "Update enum column", - "operationId": "tablesDBUpdateEnumColumn", + "\/sites\/{siteId}\/deployments\/template": { + "post": { + "summary": "Create template deployment", + "operationId": "sitesCreateTemplateDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", "responses": { - "200": { - "description": "ColumnEnum", + "202": { + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEnum" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -53729,26 +53359,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEnumColumn", - "group": "columns", - "weight": 729, + "method": "createTemplateDeployment", + "group": "deployments", + "weight": 475, "cookies": false, "type": "", - "demo": "tablesdb\/update-enum-column.md", + "demo": "sites\/create-template-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [] } @@ -53761,31 +53387,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } @@ -53796,36 +53403,50 @@ "schema": { "type": "object", "properties": { - "elements": { - "type": "array", - "description": "Updated list of enum values.", - "x-example": null, - "items": { - "type": "string" - } + "repository": { + "type": "string", + "description": "Repository name of the template.", + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "owner": { + "type": "string", + "description": "The name of the owner of the template.", + "x-example": "" }, - "default": { + "rootDirectory": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true + "description": "Path to site code in the template repo.", + "x-example": "" }, - "newKey": { + "type": { "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "description": "Type for the reference provided. Can be commit, branch, or tag", + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [] + }, + "reference": { + "type": "string", + "description": "Reference value, can be a commit hash, branch name, or release tag", + "x-example": "" + }, + "activate": { + "type": "boolean", + "description": "Automatically activate the deployment when it is finished building.", + "x-example": false } }, "required": [ - "elements", - "required", - "default" + "repository", + "owner", + "rootDirectory", + "type", + "reference" ] } } @@ -53833,21 +53454,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "\/sites\/{siteId}\/deployments\/vcs": { "post": { - "summary": "Create float column", - "operationId": "tablesDBCreateFloatColumn", + "summary": "Create VCS deployment", + "operationId": "sitesCreateVcsDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", "responses": { "202": { - "description": "ColumnFloat", + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnFloat" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -53855,26 +53476,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFloatColumn", - "group": "columns", - "weight": 730, + "method": "createVcsDeployment", + "group": "deployments", + "weight": 476, "cookies": false, "type": "", - "demo": "tablesdb\/create-float-column.md", + "demo": "sites\/create-vcs-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [] } @@ -53887,22 +53504,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -53913,46 +53520,32 @@ "schema": { "type": "object", "properties": { - "key": { + "type": { "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "min": { - "type": "number", - "description": "Minimum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "x-example": null, - "format": "float", - "x-nullable": true + "description": "Type of reference passed. Allowed values are: branch, commit", + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [] }, - "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "x-example": null, - "format": "float", - "x-nullable": true + "reference": { + "type": "string", + "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", + "x-example": "" }, - "array": { + "activate": { "type": "boolean", - "description": "Is column an array?", + "description": "Automatically activate the deployment when it is finished building.", "x-example": false } }, "required": [ - "key", - "required" + "type", + "reference" ] } } @@ -53960,21 +53553,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { - "patch": { - "summary": "Update float column", - "operationId": "tablesDBUpdateFloatColumn", + "\/sites\/{siteId}\/deployments\/{deploymentId}": { + "get": { + "summary": "Get deployment", + "operationId": "sitesGetDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a site deployment by its unique ID.", "responses": { "200": { - "description": "ColumnFloat", + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnFloat" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -53982,26 +53575,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFloatColumn", - "group": "columns", - "weight": 731, + "method": "getDeployment", + "group": "deployments", + "weight": 477, "cookies": false, "type": "", - "demo": "tablesdb\/update-float-column.md", + "demo": "sites\/get-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [] } @@ -54014,126 +53603,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "min": { - "type": "number", - "description": "Minimum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { - "post": { - "summary": "Create integer column", - "operationId": "tablesDBCreateIntegerColumn", + ] + }, + "delete": { + "summary": "Delete deployment", + "operationId": "sitesDeleteDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "description": "Delete a site deployment by its unique ID.", "responses": { - "202": { - "description": "ColumnInteger", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnInteger" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createIntegerColumn", - "group": "columns", - "weight": 732, + "method": "deleteDeployment", + "group": "deployments", + "weight": 480, "cookies": false, "type": "", - "demo": "tablesdb\/create-integer-column.md", + "demo": "sites\/delete-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [] } @@ -54146,121 +53666,60 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "min": { - "type": "integer", - "description": "Minimum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { - "patch": { - "summary": "Update integer column", - "operationId": "tablesDBUpdateIntegerColumn", + "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { + "get": { + "summary": "Get deployment download", + "operationId": "sitesGetDeploymentDownload", "tags": [ - "tablesDB" + "sites" ], - "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "responses": { "200": { - "description": "ColumnInteger", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnInteger" - } - } - } + "description": "File" } }, "deprecated": false, "x-appwrite": { - "method": "updateIntegerColumn", - "group": "columns", - "weight": 733, + "method": "getDeploymentDownload", + "group": "deployments", + "weight": 481, "cookies": false, - "type": "", - "demo": "tablesdb\/update-integer-column.md", + "type": "location", + "demo": "sites\/get-deployment-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [] } @@ -54268,104 +53727,66 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, "schema": { - "type": "string" + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "min": { - "type": "integer", - "description": "Minimum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { - "post": { - "summary": "Create IP address column", - "operationId": "tablesDBCreateIpColumn", + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", "tags": [ - "tablesDB" + "sites" ], - "description": "Create IP address column.\n", + "description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", "responses": { - "202": { - "description": "ColumnIP", + "200": { + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIp" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -54373,26 +53794,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIpColumn", - "group": "columns", - "weight": 734, + "method": "updateDeploymentStatus", + "group": "deployments", + "weight": 483, "cookies": false, "type": "", - "demo": "tablesdb\/create-ip-column.md", + "demo": "sites\/update-deployment-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [] } @@ -54405,79 +53822,43 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { - "patch": { - "summary": "Update IP address column", - "operationId": "tablesDBUpdateIpColumn", + "\/sites\/{siteId}\/logs": { + "get": { + "summary": "List logs", + "operationId": "sitesListLogs", "tags": [ - "tablesDB" + "sites" ], - "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a list of all site logs. You can use the query params to filter your results.", "responses": { "200": { - "description": "ColumnIP", + "description": "Executions List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIp" + "$ref": "#\/components\/schemas\/executionList" } } } @@ -54485,26 +53866,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateIpColumn", - "group": "columns", - "weight": 735, + "method": "listLogs", + "group": "logs", + "weight": 485, "cookies": false, "type": "", - "demo": "tablesdb\/update-ip-column.md", + "demo": "sites\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [] } @@ -54517,84 +53894,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, "schema": { - "type": "string" + "type": "boolean", + "x-example": false, + "default": true }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { - "post": { - "summary": "Create line column", - "operationId": "tablesDBCreateLineColumn", + "\/sites\/{siteId}\/logs\/{logId}": { + "get": { + "summary": "Get log", + "operationId": "sitesGetLog", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a geometric line column.", + "description": "Get a site request log by its unique ID.", "responses": { - "202": { - "description": "ColumnLine", + "200": { + "description": "Execution", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLine" + "$ref": "#\/components\/schemas\/execution" } } } @@ -54602,26 +53952,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLineColumn", - "group": "columns", - "weight": 736, + "method": "getLog", + "group": "logs", + "weight": 484, "cookies": false, "type": "", - "demo": "tablesdb\/create-line-column.md", + "demo": "sites\/get-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [] } @@ -54634,108 +53980,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "logId", + "description": "Log ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", - "x-example": "[[1, 2], [3, 4], [5, 6]]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { - "patch": { - "summary": "Update line column", - "operationId": "tablesDBUpdateLineColumn", + ] + }, + "delete": { + "summary": "Delete log", + "operationId": "sitesDeleteLog", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a line column. Changing the `default` value will not update already existing rows.", + "description": "Delete a site log by its unique ID.", "responses": { - "200": { - "description": "ColumnLine", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnLine" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateLineColumn", - "group": "columns", - "weight": 737, + "method": "deleteLog", + "group": "logs", + "weight": 486, "cookies": false, "type": "", - "demo": "tablesdb\/update-line-column.md", + "demo": "sites\/delete-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [] } @@ -54748,90 +54043,43 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "logId", + "description": "Log ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", - "x-example": "[[1, 2], [3, 4], [5, 6]]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { - "post": { - "summary": "Create longtext column", - "operationId": "tablesDBCreateLongtextColumn", + "\/sites\/{siteId}\/usage": { + "get": { + "summary": "Get site usage", + "operationId": "sitesGetUsage", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a longtext column.\n", + "description": "Get usage metrics and statistics for a for a specific site. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", "responses": { - "202": { - "description": "ColumnLongtext", + "200": { + "description": "UsageSite", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLongtext" + "$ref": "#\/components\/schemas\/usageSite" } } } @@ -54839,116 +54087,81 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLongtextColumn", - "group": "columns", - "weight": 754, + "method": "getUsage", + "group": null, + "weight": 495, "cookies": false, "type": "", - "demo": "tablesdb\/create-longtext-column.md", + "demo": "sites\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, - "in": "path" + "in": "query" } + ] + } + }, + "\/sites\/{siteId}\/variables": { + "get": { + "summary": "List variables", + "operationId": "sitesListVariables", + "tags": [ + "sites" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { - "patch": { - "summary": "Update longtext column", - "operationId": "tablesDBUpdateLongtextColumn", - "tags": [ - "tablesDB" - ], - "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a list of all variables of a specific site.", "responses": { "200": { - "description": "ColumnLongtext", + "description": "Variables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLongtext" + "$ref": "#\/components\/schemas\/variableList" } } } @@ -54956,26 +54169,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextColumn", - "group": "columns", - "weight": 755, + "method": "listVariables", + "group": "variables", + "weight": 489, "cookies": false, "type": "", - "demo": "tablesdb\/update-longtext-column.md", + "demo": "sites\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", "auth": { "Project": [] } @@ -54988,84 +54197,31 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { + ] + }, "post": { - "summary": "Create mediumtext column", - "operationId": "tablesDBCreateMediumtextColumn", + "summary": "Create variable", + "operationId": "sitesCreateVariable", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a mediumtext column.\n", + "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", "responses": { - "202": { - "description": "ColumnMediumtext", + "201": { + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnMediumtext" + "$ref": "#\/components\/schemas\/variable" } } } @@ -55073,26 +54229,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createMediumtextColumn", - "group": "columns", - "weight": 752, + "method": "createVariable", + "group": "variables", + "weight": 905, "cookies": false, "type": "", - "demo": "tablesdb\/create-mediumtext-column.md", + "demo": "sites\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", "auth": { "Project": [] } @@ -55105,22 +54257,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -55133,34 +54275,23 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "description": "Variable key. Max length: 255 chars.", + "x-example": "" }, - "default": { + "value": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false + "description": "Variable value. Max length: 8192 chars.", + "x-example": "" }, - "encrypt": { + "secret": { "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", "x-example": false } }, "required": [ "key", - "required" + "value" ] } } @@ -55168,21 +54299,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { - "patch": { - "summary": "Update mediumtext column", - "operationId": "tablesDBUpdateMediumtextColumn", + "\/sites\/{siteId}\/variables\/{variableId}": { + "get": { + "summary": "Get variable", + "operationId": "sitesGetVariable", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a variable by its unique ID.", "responses": { "200": { - "description": "ColumnMediumtext", + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnMediumtext" + "$ref": "#\/components\/schemas\/variable" } } } @@ -55190,26 +54321,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMediumtextColumn", - "group": "columns", - "weight": 753, + "method": "getVariable", + "group": "variables", + "weight": 488, "cookies": false, "type": "", - "demo": "tablesdb\/update-mediumtext-column.md", + "demo": "sites\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", "auth": { "Project": [] } @@ -55222,84 +54349,41 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { - "post": { - "summary": "Create point column", - "operationId": "tablesDBCreatePointColumn", + ] + }, + "put": { + "summary": "Update variable", + "operationId": "sitesUpdateVariable", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a geometric point column.", + "description": "Update variable by its unique ID.", "responses": { - "202": { - "description": "ColumnPoint", + "200": { + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPoint" + "$ref": "#\/components\/schemas\/variable" } } } @@ -55307,26 +54391,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPointColumn", - "group": "columns", - "weight": 738, + "method": "updateVariable", + "group": "variables", + "weight": 490, "cookies": false, "type": "", - "demo": "tablesdb\/create-point-column.md", + "demo": "sites\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [] } @@ -55339,22 +54419,22 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -55367,80 +54447,60 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Variable key. Max length: 255 chars.", + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "", + "x-nullable": true }, - "default": { - "type": "array", - "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", - "x-example": "[1, 2]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "x-example": false, "x-nullable": true } }, "required": [ - "key", - "required" + "key" ] } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { - "patch": { - "summary": "Update point column", - "operationId": "tablesDBUpdatePointColumn", + }, + "delete": { + "summary": "Delete variable", + "operationId": "sitesDeleteVariable", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a point column. Changing the `default` value will not update already existing rows.", + "description": "Delete a variable by its unique ID.", "responses": { - "200": { - "description": "ColumnPoint", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnPoint" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updatePointColumn", - "group": "columns", - "weight": 739, + "method": "deleteVariable", + "group": "variables", + "weight": 491, "cookies": false, "type": "", - "demo": "tablesdb\/update-point-column.md", + "demo": "sites\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [] } @@ -55453,90 +54513,43 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", - "x-example": "[1, 2]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { - "post": { - "summary": "Create polygon column", - "operationId": "tablesDBCreatePolygonColumn", + "\/storage\/buckets": { + "get": { + "summary": "List buckets", + "operationId": "storageListBuckets", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a geometric polygon column.", + "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnPolygon", + "200": { + "description": "Buckets List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPolygon" + "$ref": "#\/components\/schemas\/bucketList" } } } @@ -55544,26 +54557,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPolygonColumn", - "group": "columns", - "weight": 740, + "method": "listBuckets", + "group": "buckets", + "weight": 539, "cookies": false, "type": "", - "demo": "tablesdb\/create-polygon-column.md", + "demo": "storage\/list-buckets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [] } @@ -55576,81 +54586,56 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" + "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", + "x-example": false, + "default": true + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { - "patch": { - "summary": "Update polygon column", - "operationId": "tablesDBUpdatePolygonColumn", + ] + }, + "post": { + "summary": "Create bucket", + "operationId": "storageCreateBucket", "tags": [ - "tablesDB" + "storage" ], - "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", + "description": "Create a new storage bucket.", "responses": { - "200": { - "description": "ColumnPolygon", + "201": { + "description": "Bucket", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPolygon" + "$ref": "#\/components\/schemas\/bucket" } } } @@ -55658,26 +54643,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePolygonColumn", - "group": "columns", - "weight": 741, + "method": "createBucket", + "group": "buckets", + "weight": 537, "cookies": false, "type": "", - "demo": "tablesdb\/update-polygon-column.md", + "demo": "storage\/create-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", "auth": { "Project": [] } @@ -55688,70 +54670,86 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "bucketId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "default": { + "name": { + "type": "string", + "description": "Bucket name", + "x-example": "" + }, + "permissions": { "type": "array", - "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "string" }, "x-nullable": true }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", "x-example": null, - "x-nullable": true + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "x-example": false } }, "required": [ - "required" + "bucketId", + "name" ] } } @@ -55759,21 +54757,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { - "post": { - "summary": "Create relationship column", - "operationId": "tablesDBCreateRelationshipColumn", + "\/storage\/buckets\/{bucketId}": { + "get": { + "summary": "Get bucket", + "operationId": "storageGetBucket", "tags": [ - "tablesDB" + "storage" ], - "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", "responses": { - "202": { - "description": "ColumnRelationship", + "200": { + "description": "Bucket", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnRelationship" + "$ref": "#\/components\/schemas\/bucket" } } } @@ -55781,26 +54779,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRelationshipColumn", - "group": "columns", - "weight": 742, + "method": "getBucket", + "group": "buckets", + "weight": 538, "cookies": false, "type": "", - "demo": "tablesdb\/create-relationship-column.md", + "demo": "storage\/get-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [] } @@ -55813,136 +54808,55 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "relatedTableId": { - "type": "string", - "description": "Related Table ID.", - "x-example": "" - }, - "type": { - "type": "string", - "description": "Relation type", - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] - }, - "twoWay": { - "type": "boolean", - "description": "Is Two Way?", - "x-example": false - }, - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null, - "x-nullable": true - }, - "twoWayKey": { - "type": "string", - "description": "Two Way Column Key.", - "x-example": null, - "x-nullable": true - }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] - } - }, - "required": [ - "relatedTableId", - "type" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { - "post": { - "summary": "Create string column", - "operationId": "tablesDBCreateStringColumn", + ] + }, + "put": { + "summary": "Update bucket", + "operationId": "storageUpdateBucket", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a string column.\n", + "description": "Update a storage bucket by its unique ID.", "responses": { - "202": { - "description": "ColumnString", + "200": { + "description": "Bucket", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnString" + "$ref": "#\/components\/schemas\/bucket" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createStringColumn", - "group": "columns", - "weight": 744, + "method": "updateBucket", + "group": "buckets", + "weight": 540, "cookies": false, "type": "", - "demo": "tablesdb\/create-string-column.md", + "demo": "storage\/update-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", - "deprecated": { - "since": "1.9.0", - "replaceWith": "tablesDB.createTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [] } @@ -55955,22 +54869,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -55981,96 +54885,111 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Bucket name", + "x-example": "" }, - "size": { + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "x-example": false + }, + "maximumFileSize": { "type": "integer", - "description": "Column size for text columns, in number of characters.", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", "x-example": 1, "format": "int32" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "x-example": null, + "items": { + "type": "string" + } }, - "default": { + "compression": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] }, - "array": { + "encryption": { "type": "boolean", - "description": "Is column an array?", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", "x-example": false }, - "encrypt": { + "antivirus": { "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", "x-example": false } }, "required": [ - "key", - "size", - "required" + "name" ] } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { - "patch": { - "summary": "Update string column", - "operationId": "tablesDBUpdateStringColumn", + }, + "delete": { + "summary": "Delete bucket", + "operationId": "storageDeleteBucket", "tags": [ - "tablesDB" + "storage" ], - "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "description": "Delete a storage bucket by its unique ID.", "responses": { - "200": { - "description": "ColumnString", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnString" - } - } - } + "204": { + "description": "No content" } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateStringColumn", - "group": "columns", - "weight": 745, + "method": "deleteBucket", + "group": "buckets", + "weight": 541, "cookies": false, "type": "", - "demo": "tablesdb\/update-string-column.md", + "demo": "storage\/delete-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [] } @@ -56083,91 +55002,33 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files": { + "get": { + "summary": "List files", + "operationId": "storageListFiles", + "tags": [ + "storage" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string column.", - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { - "post": { - "summary": "Create text column", - "operationId": "tablesDBCreateTextColumn", - "tags": [ - "tablesDB" - ], - "description": "Create a text column.\n", + "description": "Get a list of all the user files. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnText", + "200": { + "description": "Files List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnText" + "$ref": "#\/components\/schemas\/fileList" } } } @@ -56175,26 +55036,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTextColumn", - "group": "columns", - "weight": 750, + "method": "listFiles", + "group": "files", + "weight": 544, "cookies": false, "type": "", - "demo": "tablesdb\/create-text-column.md", + "demo": "storage\/list-files.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [] } @@ -56202,89 +55062,72 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { - "patch": { - "summary": "Update text column", - "operationId": "tablesDBUpdateTextColumn", + ] + }, + "post": { + "summary": "Create file", + "operationId": "storageCreateFile", "tags": [ - "tablesDB" + "storage" ], - "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", "responses": { - "200": { - "description": "ColumnText", + "201": { + "description": "File", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnText" + "$ref": "#\/components\/schemas\/file" } } } @@ -56292,26 +55135,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTextColumn", - "group": "columns", - "weight": 751, + "method": "createFile", + "group": "files", + "weight": 1186, "cookies": false, - "type": "", - "demo": "tablesdb\/update-text-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "type": "upload", + "demo": "storage\/create-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", + "scope": "files.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [] } @@ -56319,67 +55161,53 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } ], "requestBody": { "content": { - "application\/json": { + "multipart\/form-data": { "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { + "fileId": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true + "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "", + "x-upload-id": true }, - "newKey": { + "file": { "type": "string", - "description": "New Column Key.", + "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", "x-example": null, + "format": "binary" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, "x-nullable": true } }, "required": [ - "required", - "default" + "fileId", + "file" ] } } @@ -56387,21 +55215,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { - "post": { - "summary": "Create URL column", - "operationId": "tablesDBCreateUrlColumn", + "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "get": { + "summary": "Get file", + "operationId": "storageGetFile", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a URL column.\n", + "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", "responses": { - "202": { - "description": "ColumnURL", + "200": { + "description": "File", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnUrl" + "$ref": "#\/components\/schemas\/file" } } } @@ -56409,26 +55237,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "createUrlColumn", - "group": "columns", - "weight": 746, + "method": "getFile", + "group": "files", + "weight": 543, "cookies": false, "type": "", - "demo": "tablesdb\/create-url-column.md", + "demo": "storage\/get-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [] } @@ -56436,85 +55263,47 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { - "patch": { - "summary": "Update URL column", - "operationId": "tablesDBUpdateUrlColumn", + ] + }, + "put": { + "summary": "Update file", + "operationId": "storageUpdateFile", "tags": [ - "tablesDB" + "storage" ], - "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", "responses": { "200": { - "description": "ColumnURL", + "description": "File", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnUrl" + "$ref": "#\/components\/schemas\/file" } } } @@ -56522,26 +55311,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateUrlColumn", - "group": "columns", - "weight": 747, + "method": "updateFile", + "group": "files", + "weight": 545, "cookies": false, "type": "", - "demo": "tablesdb\/update-url-column.md", + "demo": "storage\/update-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [] } @@ -56549,36 +55337,28 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } @@ -56589,77 +55369,59 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { + "name": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true + "description": "File name.", + "x-example": "" }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { - "post": { - "summary": "Create varchar column", - "operationId": "tablesDBCreateVarcharColumn", + }, + "delete": { + "summary": "Delete file", + "operationId": "storageDeleteFile", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a varchar column.\n", + "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "202": { - "description": "ColumnVarchar", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnVarchar" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createVarcharColumn", - "group": "columns", - "weight": 748, + "method": "deleteFile", + "group": "files", + "weight": 546, "cookies": false, "type": "", - "demo": "tablesdb\/create-varchar-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "demo": "storage\/delete-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "files.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [] } @@ -56667,123 +55429,68 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "get": { + "summary": "Get file for download", + "operationId": "storageGetFileDownload", + "tags": [ + "storage" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { - "patch": { - "summary": "Update varchar column", - "operationId": "tablesDBUpdateVarcharColumn", - "tags": [ - "tablesDB" - ], - "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "responses": { "200": { - "description": "ColumnVarchar", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnVarchar" - } - } - } + "description": "File" } }, "deprecated": false, "x-appwrite": { - "method": "updateVarcharColumn", - "group": "columns", - "weight": 749, + "method": "getFileDownload", + "group": "files", + "weight": 548, "cookies": false, - "type": "", - "demo": "tablesdb\/update-varchar-column.md", + "type": "location", + "demo": "storage\/get-file-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [] } @@ -56791,205 +55498,79 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "token", + "description": "File token for accessing this file.", + "required": false, "schema": { - "type": "string" + "type": "string", + "x-example": "", + "default": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar column.", - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { "get": { - "summary": "Get column", - "operationId": "tablesDBGetColumn", + "summary": "Get file preview", + "operationId": "storageGetFilePreview", "tags": [ - "tablesDB" + "storage" ], - "description": "Get column by ID.", + "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { "200": { - "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", - "content": { - "application\/json": { - "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/columnBoolean" - }, - { - "$ref": "#\/components\/schemas\/columnInteger" - }, - { - "$ref": "#\/components\/schemas\/columnFloat" - }, - { - "$ref": "#\/components\/schemas\/columnEmail" - }, - { - "$ref": "#\/components\/schemas\/columnEnum" - }, - { - "$ref": "#\/components\/schemas\/columnUrl" - }, - { - "$ref": "#\/components\/schemas\/columnIp" - }, - { - "$ref": "#\/components\/schemas\/columnDatetime" - }, - { - "$ref": "#\/components\/schemas\/columnRelationship" - }, - { - "$ref": "#\/components\/schemas\/columnString" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/components\/schemas\/columnBoolean", - "integer": "#\/components\/schemas\/columnInteger", - "double": "#\/components\/schemas\/columnFloat", - "string": "#\/components\/schemas\/columnString", - "datetime": "#\/components\/schemas\/columnDatetime", - "relationship": "#\/components\/schemas\/columnRelationship" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/components\/schemas\/columnBoolean": { - "type": "boolean" - }, - "#\/components\/schemas\/columnInteger": { - "type": "integer" - }, - "#\/components\/schemas\/columnFloat": { - "type": "double" - }, - "#\/components\/schemas\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/components\/schemas\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/components\/schemas\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/components\/schemas\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/components\/schemas\/columnDatetime": { - "type": "datetime" - }, - "#\/components\/schemas\/columnRelationship": { - "type": "relationship" - }, - "#\/components\/schemas\/columnString": { - "type": "string" - } - } - } - } - } - } + "description": "Image" } }, "deprecated": false, "x-appwrite": { - "method": "getColumn", - "group": "columns", - "weight": 719, + "method": "getFilePreview", + "group": "files", + "weight": 547, "cookies": false, - "type": "", - "demo": "tablesdb\/get-column.md", + "type": "location", + "demo": "storage\/get-file-preview.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [] } @@ -56997,75 +55578,229 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "width", + "description": "Resize preview image width, Pass an integer between 0 to 4000.", + "required": false, "schema": { - "type": "string" + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 }, - "in": "path" + "in": "query" + }, + { + "name": "height", + "description": "Resize preview image height, Pass an integer between 0 to 4000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "gravity", + "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", + "required": false, + "schema": { + "type": "string", + "x-example": "center", + "enum": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], + "x-enum-name": "ImageGravity", + "x-enum-keys": [], + "default": "center" + }, + "in": "query" + }, + { + "name": "quality", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1 + }, + "in": "query" + }, + { + "name": "borderWidth", + "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "borderColor", + "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", + "required": false, + "schema": { + "type": "string", + "default": "" + }, + "in": "query" + }, + { + "name": "borderRadius", + "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "opacity", + "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", + "required": false, + "schema": { + "type": "number", + "format": "float", + "x-example": 0, + "default": 1 + }, + "in": "query" + }, + { + "name": "rotation", + "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": -360, + "default": 0 + }, + "in": "query" + }, + { + "name": "background", + "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", + "required": false, + "schema": { + "type": "string", + "default": "" + }, + "in": "query" + }, + { + "name": "output", + "description": "Output format type (jpeg, jpg, png, gif and webp).", + "required": false, + "schema": { + "type": "string", + "x-example": "jpg", + "enum": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ], + "x-enum-name": "ImageFormat", + "x-enum-keys": [], + "default": "" + }, + "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] - }, - "delete": { - "summary": "Delete column", - "operationId": "tablesDBDeleteColumn", + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { + "get": { + "summary": "Get file for view", + "operationId": "storageGetFileView", "tags": [ - "tablesDB" + "storage" ], - "description": "Deletes a column.", + "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "File" } }, "deprecated": false, "x-appwrite": { - "method": "deleteColumn", - "group": "columns", - "weight": 720, + "method": "getFileView", + "group": "files", + "weight": 549, "cookies": false, - "type": "", - "demo": "tablesdb\/delete-column.md", + "type": "location", + "demo": "storage\/get-file-view.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [] } @@ -57073,57 +55808,60 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "token", + "description": "File token for accessing this file.", + "required": false, "schema": { - "type": "string" + "type": "string", + "x-example": "", + "default": "" }, - "in": "path" + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { - "patch": { - "summary": "Update relationship column", - "operationId": "tablesDBUpdateRelationshipColumn", + "\/storage\/usage": { + "get": { + "summary": "Get storage usage stats", + "operationId": "storageGetUsage", "tags": [ - "tablesDB" + "storage" ], - "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", "responses": { "200": { - "description": "ColumnRelationship", + "description": "StorageUsage", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnRelationship" + "$ref": "#\/components\/schemas\/usageStorage" } } } @@ -57131,114 +55869,155 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRelationshipColumn", - "group": "columns", - "weight": 743, + "method": "getUsage", + "group": null, + "weight": 551, "cookies": false, "type": "", - "demo": "tablesdb\/update-relationship-column.md", + "demo": "storage\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, - "in": "path" - }, + "in": "query" + } + ] + } + }, + "\/storage\/{bucketId}\/usage": { + "get": { + "summary": "Get bucket usage stats", + "operationId": "storageGetBucketUsage", + "tags": [ + "storage" + ], + "description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", + "responses": { + "200": { + "description": "UsageBuckets", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageBuckets" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getBucketUsage", + "group": null, + "weight": 552, + "cookies": false, + "type": "", + "demo": "storage\/get-bucket-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "files.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "tableId", - "description": "Table ID.", + "Project": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Bucket ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "schema": { - "type": "string" + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - } - } - } + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": { + "\/tablesdb": { "get": { - "summary": "List indexes", - "operationId": "tablesDBListIndexes", + "summary": "List databases", + "operationId": "tablesDBList", "tags": [ "tablesDB" ], - "description": "List indexes on the table.", + "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", "responses": { "200": { - "description": "Column Indexes List", + "description": "Databases List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIndexList" + "$ref": "#\/components\/schemas\/databaseList" } } } @@ -57246,26 +56025,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 759, + "method": "list", + "group": "tablesdb", + "weight": 761, "cookies": false, "type": "", - "demo": "tablesdb\/list-indexes.md", + "demo": "tablesdb\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [] } @@ -57277,29 +56053,9 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "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 columns: key, type, status, attributes, error", + "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 columns: name", "required": false, "schema": { "type": "array", @@ -57310,6 +56066,17 @@ }, "in": "query" }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -57324,19 +56091,19 @@ ] }, "post": { - "summary": "Create index", - "operationId": "tablesDBCreateIndex", + "summary": "Create database", + "operationId": "tablesDBCreate", "tags": [ "tablesDB" ], - "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.", + "description": "Create a new Database.\n", "responses": { - "202": { - "description": "Index", + "201": { + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIndex" + "$ref": "#\/components\/schemas\/database" } } } @@ -57344,26 +56111,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 756, + "method": "create", + "group": "tablesdb", + "weight": 757, "cookies": false, "type": "", - "demo": "tablesdb\/create-index.md", + "demo": "tablesdb\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [] } @@ -57374,87 +56138,31 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "key": { + "databaseId": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "type": { + "name": { "type": "string", - "description": "Index type.", - "x-example": "key", - "enum": [ - "key", - "fulltext", - "unique", - "spatial" - ], - "x-enum-name": "TablesDBIndexType", - "x-enum-keys": [] - }, - "columns": { - "type": "array", - "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } + "description": "Database name. Max length: 128 chars.", + "x-example": "" }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "x-example": null, - "items": { - "type": "integer" - } + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false } }, "required": [ - "key", - "type", - "columns" + "databaseId", + "name" ] } } @@ -57462,21 +56170,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "\/tablesdb\/transactions": { "get": { - "summary": "Get index", - "operationId": "tablesDBGetIndex", + "summary": "List transactions", + "operationId": "tablesDBListTransactions", "tags": [ "tablesDB" ], - "description": "Get index by ID.", + "description": "List transactions across all databases.", "responses": { "200": { - "description": "Index", + "description": "Transaction List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIndex" + "$ref": "#\/components\/schemas\/transactionList" } } } @@ -57484,26 +56192,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 757, + "method": "listTransactions", + "group": "transactions", + "weight": 828, "cookies": false, "type": "", - "demo": "tablesdb\/get-index.md", + "demo": "tablesdb\/list-transactions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [] } @@ -57511,75 +56221,69 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", + "required": false, "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" } ] }, - "delete": { - "summary": "Delete index", - "operationId": "tablesDBDeleteIndex", + "post": { + "summary": "Create transaction", + "operationId": "tablesDBCreateTransaction", "tags": [ "tablesDB" ], - "description": "Delete an index.", + "description": "Create a new transaction.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 758, + "method": "createTransaction", + "group": "transactions", + "weight": 824, "cookies": false, "type": "", - "demo": "tablesdb\/delete-index.md", + "demo": "tablesdb\/create-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [] } @@ -57587,57 +56291,44 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "x-example": 60, + "format": "int32" + } + } + } + } } - ] + } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/logs": { + "\/tablesdb\/transactions\/{transactionId}": { "get": { - "summary": "List table logs", - "operationId": "tablesDBListTableLogs", + "summary": "Get transaction", + "operationId": "tablesDBGetTransaction", "tags": [ "tablesDB" ], - "description": "Get the table activity logs list by its unique ID.", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "Logs List", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/logList" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -57645,86 +56336,66 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTableLogs", - "group": "tables", - "weight": 717, + "method": "getTransaction", + "group": "transactions", + "weight": 825, "cookies": false, "type": "", - "demo": "tablesdb\/list-table-logs.md", + "demo": "tablesdb\/get-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" - ], + "documents.read", + "rows.read" + ], "platforms": [ - "console" + "console", + "server", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": { - "get": { - "summary": "List rows", - "operationId": "tablesDBListRows", + }, + "patch": { + "summary": "Update transaction", + "operationId": "tablesDBUpdateTransaction", "tags": [ "tablesDB" ], - "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { "200": { - "description": "Rows List", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/rowList" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -57732,28 +56403,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "listRows", - "group": "rows", - "weight": 768, + "method": "updateTransaction", + "group": "transactions", + "weight": 826, "cookies": false, "type": "", - "demo": "tablesdb\/list-rows.md", + "demo": "tablesdb\/update-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "documents.write", + "rows.write" ], "platforms": [ "console", - "client", "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [] } @@ -57767,87 +56438,114 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "x-example": false + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete transaction", + "operationId": "tablesDBDeleteTransaction", + "tags": [ + "tablesDB" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 827, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "documents.write", + "rows.write" + ], + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ { "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "description": "Transaction ID.", + "required": true, "schema": { "type": "string", "x-example": "" }, - "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", - "x-example": false, - "default": true - }, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" + "in": "path" } ] - }, + } + }, + "\/tablesdb\/transactions\/{transactionId}\/operations": { "post": { - "summary": "Create row", - "operationId": "tablesDBCreateRow", + "summary": "Create operations", + "operationId": "tablesDBCreateOperations", "tags": [ "tablesDB" ], - "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create multiple operations in a single transaction.", "responses": { "201": { - "description": "Row", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -57855,89 +56553,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRow", - "group": "rows", - "weight": 760, + "method": "createOperations", + "group": "transactions", + "weight": 829, "cookies": false, "type": "", - "demo": "tablesdb\/create-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "client", "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md", - "methods": [ - { - "name": "createRow", - "namespace": "tablesDB", - "desc": "Create row", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rowId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rowId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/row" - } - ], - "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/create-row.md", - "public": true - }, - { - "name": "createRows", - "namespace": "tablesDB", - "desc": "Create rows", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rows", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rows" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/rowList" - } - ], - "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/create-rows.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [] } @@ -57951,22 +56588,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -57977,59 +56604,36 @@ "schema": { "type": "object", "properties": { - "rowId": { - "type": "string", - "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "data": { - "type": "object", - "description": "Row data as JSON object.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "rows": { + "operations": { "type": "array", - "description": "Array of rows data as JSON objects.", - "x-example": null, + "description": "Array of staged operations.", + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", "items": { "type": "object" } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true } } } } } } - }, - "put": { - "summary": "Upsert rows", - "operationId": "tablesDBUpsertRows", + } + }, + "\/tablesdb\/usage": { + "get": { + "summary": "Get TablesDB usage stats", + "operationId": "tablesDBListUsage", "tags": [ "tablesDB" ], - "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { - "201": { - "description": "Rows List", + "200": { + "description": "UsageDatabases", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/rowList" + "$ref": "#\/components\/schemas\/usageDatabases" } } } @@ -58037,53 +56641,45 @@ }, "deprecated": false, "x-appwrite": { - "method": "upsertRows", - "group": "rows", - "weight": 765, + "method": "listUsage", + "group": null, + "weight": 763, "cookies": false, "type": "", - "demo": "tablesdb\/upsert-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/list-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.read", + "collections.read" ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md", "methods": [ { - "name": "upsertRows", + "name": "listUsage", "namespace": "tablesDB", "desc": "", "auth": { "Project": [] }, "parameters": [ - "databaseId", - "tableId", - "rows", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rows" + "range" ], + "required": [], "responses": [ { - "code": 201, - "model": "#\/components\/schemas\/rowList" + "code": 200, + "model": "#\/components\/schemas\/usageDatabases" } ], - "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", - "demo": "tablesdb\/upsert-rows.md", + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "tablesdb\/list-usage.md", "public": true } ], @@ -58093,75 +56689,50 @@ }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "rows": { - "type": "array", - "description": "Array of row data as JSON objects. May contain partial rows.", - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - }, - "required": [ - "rows" - ] - } - } + "in": "query" } - } - }, - "patch": { - "summary": "Update rows", - "operationId": "tablesDBUpdateRows", + ] + } + }, + "\/tablesdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "tablesDBGet", "tags": [ "tablesDB" ], - "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", "responses": { "200": { - "description": "Rows List", + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/rowList" + "$ref": "#\/components\/schemas\/database" } } } @@ -58169,26 +56740,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRows", - "group": "rows", - "weight": 763, + "method": "get", + "group": "tablesdb", + "weight": 758, "cookies": false, "type": "", - "demo": "tablesdb\/update-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": [ - "rows.write", - "documents.write" - ], + "demo": "tablesdb\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [] } @@ -58209,63 +56777,23 @@ "x-example": "" }, "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only column and value pairs to be updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } } - } + ] }, - "delete": { - "summary": "Delete rows", - "operationId": "tablesDBDeleteRows", + "put": { + "summary": "Update database", + "operationId": "tablesDBUpdate", "tags": [ "tablesDB" ], - "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "description": "Update a database by its unique ID.", "responses": { "200": { - "description": "Rows List", + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/rowList" + "$ref": "#\/components\/schemas\/database" } } } @@ -58273,26 +56801,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteRows", - "group": "rows", - "weight": 767, + "method": "update", + "group": "tablesdb", + "weight": 759, "cookies": false, "type": "", - "demo": "tablesdb\/delete-rows.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": [ - "rows.write", - "documents.write" - ], + "demo": "tablesdb\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [] } @@ -58313,16 +56838,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -58331,42 +56846,92 @@ "schema": { "type": "object", "properties": { - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { + "name": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false } } } } } } + }, + "delete": { + "summary": "Delete database", + "operationId": "tablesDBDelete", + "tags": [ + "tablesDB" + ], + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "tablesdb", + "weight": 760, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "\/tablesdb\/{databaseId}\/tables": { "get": { - "summary": "Get row", - "operationId": "tablesDBGetRow", + "summary": "List tables", + "operationId": "tablesDBListTables", "tags": [ "tablesDB" ], - "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", "responses": { "200": { - "description": "Row", + "description": "Tables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/tableList" } } } @@ -58374,28 +56939,26 @@ }, "deprecated": false, "x-appwrite": { - "method": "getRow", - "group": "rows", - "weight": 761, + "method": "listTables", + "group": "tables", + "weight": 768, "cookies": false, "type": "", - "demo": "tablesdb\/get-row.md", + "demo": "tablesdb\/list-tables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "tables.read", + "collections.read" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [] } @@ -58403,8 +56966,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -58418,29 +56980,9 @@ }, "in": "path" }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "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 columns: name, enabled, rowSecurity", "required": false, "schema": { "type": "array", @@ -58452,31 +56994,43 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "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", + "x-example": false, + "default": true }, "in": "query" } ] }, - "put": { - "summary": "Upsert a row", - "operationId": "tablesDBUpsertRow", + "post": { + "summary": "Create table", + "operationId": "tablesDBCreateTable", "tags": [ "tablesDB" ], - "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { "201": { - "description": "Row", + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/table" } } } @@ -58484,60 +57038,26 @@ }, "deprecated": false, "x-appwrite": { - "method": "upsertRow", - "group": "rows", + "method": "createTable", + "group": "tables", "weight": 764, "cookies": false, "type": "", - "demo": "tablesdb\/upsert-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md", - "methods": [ - { - "name": "upsertRow", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rowId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rowId" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/row" - } - ], - "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/upsert-row.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [] } @@ -58545,8 +57065,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -58559,26 +57078,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -58587,46 +57086,77 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": "[\"read(\"any\")\"]", "items": { "type": "string" }, "x-nullable": true }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + }, + "columns": { + "type": "array", + "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", + "x-example": null, + "items": { + "type": "object" + } + }, + "indexes": { + "type": "array", + "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "x-example": null, + "items": { + "type": "object" + } } - } + }, + "required": [ + "tableId", + "name" + ] } } } } - }, - "patch": { - "summary": "Update row", - "operationId": "tablesDBUpdateRow", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesDBGetTable", "tags": [ "tablesDB" ], - "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", "responses": { "200": { - "description": "Row", + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/table" } } } @@ -58634,28 +57164,26 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRow", - "group": "rows", - "weight": 762, + "method": "getTable", + "group": "tables", + "weight": 765, "cookies": false, "type": "", - "demo": "tablesdb\/update-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.read", + "collections.read" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [] } @@ -58663,8 +57191,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -58687,86 +57214,50 @@ "x-example": "" }, "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only columns and value pairs to be updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } } - } + ] }, - "delete": { - "summary": "Delete row", - "operationId": "tablesDBDeleteRow", + "put": { + "summary": "Update table", + "operationId": "tablesDBUpdateTable", "tags": [ "tablesDB" ], - "description": "Delete a row by its unique ID.", + "description": "Update a table by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Table", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/table" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteRow", - "group": "rows", + "method": "updateTable", + "group": "tables", "weight": 766, "cookies": false, "type": "", - "demo": "tablesdb\/delete-row.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [] } @@ -58774,8 +57265,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -58791,23 +57281,13 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -58816,34 +57296,124 @@ "schema": { "type": "object", "properties": { - "transactionId": { + "name": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } + "description": "Table name. Max length: 128 chars.", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "x-example": false + } } } } } } + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", + "tags": [ + "tablesDB" + ], + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTable", + "group": "tables", + "weight": 767, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { "get": { - "summary": "List row logs", - "operationId": "tablesDBListRowLogs", + "summary": "List columns", + "operationId": "tablesDBListColumns", "tags": [ "tablesDB" ], - "description": "Get the row activity logs list by its unique ID.", + "description": "List columns in the table.", "responses": { "200": { - "description": "Logs List", + "description": "Columns List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/logList" + "$ref": "#\/components\/schemas\/columnList" } } } @@ -58851,32 +57421,36 @@ }, "deprecated": false, "x-appwrite": { - "method": "listRowLogs", - "group": "logs", - "weight": 769, + "method": "listColumns", + "group": "columns", + "weight": 773, "cookies": false, "type": "", - "demo": "tablesdb\/list-row-logs.md", + "demo": "tablesdb\/list-columns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "tables.read", + "collections.read", + "columns.read", + "attributes.read" ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -58900,19 +57474,9 @@ }, "in": "path" }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "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 columns: key, type, size, required, array, status, error", "required": false, "schema": { "type": "array", @@ -58922,25 +57486,36 @@ "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", + "x-example": false, + "default": true + }, + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { - "patch": { - "summary": "Decrement row column", - "operationId": "tablesDBDecrementRowColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesDBCreateBooleanColumn", "tags": [ "tablesDB" ], - "description": "Decrement a specific column of a row by a given value.", + "description": "Create a boolean column.\n", "responses": { - "200": { - "description": "Row", + "202": { + "description": "ColumnBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/columnBoolean" } } } @@ -58948,28 +57523,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "decrementRowColumn", - "group": "rows", - "weight": 771, + "method": "createBooleanColumn", + "group": "columns", + "weight": 774, "cookies": false, "type": "", - "demo": "tablesdb\/decrement-row-column.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "client", - "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [] } @@ -58977,7 +57552,6 @@ "security": [ { "Project": [], - "JWT": [], "Key": [] } ], @@ -58994,32 +57568,13 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "column", - "description": "Column key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -59028,47 +57583,53 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the column by. The value must be a number.", - "x-example": null, - "format": "float" + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null }, - "min": { - "type": "number", - "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } } } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { "patch": { - "summary": "Increment row column", - "operationId": "tablesDBIncrementRowColumn", + "summary": "Update boolean column", + "operationId": "tablesDBUpdateBooleanColumn", "tags": [ "tablesDB" ], - "description": "Increment a specific column of a row by a given value.", + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Row", + "description": "ColumnBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/columnBoolean" } } } @@ -59076,28 +57637,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "incrementRowColumn", - "group": "rows", - "weight": 770, + "method": "updateBooleanColumn", + "group": "columns", + "weight": 775, "cookies": false, "type": "", - "demo": "tablesdb\/increment-row-column.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "client", - "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [] } @@ -59105,7 +57666,6 @@ "security": [ { "Project": [], - "JWT": [], "Key": [] } ], @@ -59122,7 +57682,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -59131,18 +57691,8 @@ "in": "path" }, { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "column", - "description": "Column key.", + "name": "key", + "description": "Column Key.", "required": true, "schema": { "type": "string" @@ -59156,47 +57706,49 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the column by. The value must be a number.", - "x-example": null, - "format": "float" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "max": { - "type": "number", - "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", - "x-example": null, - "format": "float", + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, "x-nullable": true }, - "transactionId": { + "newKey": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", + "description": "New Column Key.", + "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } } } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/usage": { - "get": { - "summary": "Get table usage stats", - "operationId": "tablesDBGetTableUsage", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesDBCreateDatetimeColumn", "tags": [ "tablesDB" ], - "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Create a date time column according to the ISO 8601 standard.", "responses": { - "200": { - "description": "UsageTable", + "202": { + "description": "ColumnDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageTable" + "$ref": "#\/components\/schemas\/columnDatetime" } } } @@ -59204,32 +57756,36 @@ }, "deprecated": false, "x-appwrite": { - "method": "getTableUsage", - "group": null, - "weight": 718, + "method": "createDatetimeColumn", + "group": "columns", + "weight": 776, "cookies": false, "type": "", - "demo": "tablesdb\/get-table-usage.md", + "demo": "tablesdb\/create-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -59243,28 +57799,6 @@ }, "in": "path" }, - { - "name": "range", - "description": "Date range.", - "required": false, - "schema": { - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" - }, - "in": "query" - }, { "name": "tableId", "description": "Table ID.", @@ -59275,24 +57809,61 @@ }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } } }, - "\/tablesdb\/{databaseId}\/usage": { - "get": { - "summary": "Get TablesDB usage stats", - "operationId": "tablesDBGetUsage", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesDBUpdateDatetimeColumn", "tags": [ "tablesDB" ], - "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "UsageDatabase", + "description": "ColumnDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageDatabase" + "$ref": "#\/components\/schemas\/columnDatetime" } } } @@ -59300,58 +57871,36 @@ }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 710, + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 777, "cookies": false, "type": "", - "demo": "tablesdb\/get-usage.md", + "demo": "tablesdb\/update-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-database-usage.md", - "methods": [ - { - "name": "getUsage", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "range" - ], - "required": [ - "databaseId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/usageDatabase" - } - ], - "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", - "demo": "tablesdb\/get-usage.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -59366,45 +57915,75 @@ "in": "path" }, { - "name": "range", - "description": "Date range.", - "required": false, + "name": "tableId", + "description": "Table ID.", + "required": true, "schema": { "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" + "x-example": "" }, - "in": "query" + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, - "\/teams": { - "get": { - "summary": "List teams", - "operationId": "teamsList", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesDBCreateEmailColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.", + "description": "Create an email column.\n", "responses": { - "200": { - "description": "Teams List", + "202": { + "description": "ColumnEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/teamList" + "$ref": "#\/components\/schemas\/columnEmail" } } } @@ -59412,25 +57991,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "teams", - "weight": 539, + "method": "createEmailColumn", + "group": "columns", + "weight": 778, "cookies": false, "type": "", - "demo": "teams\/list.md", + "demo": "tablesdb\/create-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [] } @@ -59438,62 +58020,85 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "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: name, total, billingPlan", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "databaseId", + "description": "Database ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "tableId", + "description": "Table ID.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" } - ] - }, - "post": { - "summary": "Create team", - "operationId": "teamsCreate", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesDBUpdateEmailColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.", + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "Team", + "200": { + "description": "ColumnEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/team" + "$ref": "#\/components\/schemas\/columnEmail" } } } @@ -59501,25 +58106,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "teams", - "weight": 537, + "method": "updateEmailColumn", + "group": "columns", + "weight": 779, "cookies": false, "type": "", - "demo": "teams\/create.md", + "demo": "tablesdb\/update-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [] } @@ -59527,8 +58135,38 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -59537,28 +58175,28 @@ "schema": { "type": "object", "properties": { - "teamId": { - "type": "string", - "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "name": { + "default": { "type": "string", - "description": "Team name. Max length: 128 chars.", - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true }, - "roles": { - "type": "array", - "description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "newKey": { + "type": "string", + "description": "New Column Key.", "x-example": null, - "items": { - "type": "string" - } + "x-nullable": true } }, "required": [ - "teamId", - "name" + "required", + "default" ] } } @@ -59566,21 +58204,21 @@ } } }, - "\/teams\/{teamId}": { - "get": { - "summary": "Get team", - "operationId": "teamsGet", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesDBCreateEnumColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Get a team by its ID. All team members have read access for this resource.", + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", "responses": { - "200": { - "description": "Team", + "202": { + "description": "ColumnEnum", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/team" + "$ref": "#\/components\/schemas\/columnEnum" } } } @@ -59588,25 +58226,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "teams", - "weight": 538, + "method": "createEnumColumn", + "group": "columns", + "weight": 780, "cookies": false, "type": "", - "demo": "teams\/get.md", + "demo": "tablesdb\/create-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [] } @@ -59614,37 +58255,93 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] - }, - "put": { - "summary": "Update name", - "operationId": "teamsUpdateName", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesDBUpdateEnumColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Update the team's name by its unique ID.", + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Team", + "description": "ColumnEnum", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/team" + "$ref": "#\/components\/schemas\/columnEnum" } } } @@ -59652,25 +58349,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateName", - "group": "teams", - "weight": 541, + "method": "updateEnumColumn", + "group": "columns", + "weight": 781, "cookies": false, "type": "", - "demo": "teams\/update-name.md", + "demo": "tablesdb\/update-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [] } @@ -59678,18 +58378,36 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } @@ -59700,53 +58418,87 @@ "schema": { "type": "object", "properties": { - "name": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { "type": "string", - "description": "New team name. Max length: 128 chars.", - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "name" + "elements", + "required", + "default" ] } } } } - }, - "delete": { - "summary": "Delete team", - "operationId": "teamsDelete", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesDBCreateFloatColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Delete a team using its ID. Only team members with the owner role can delete the team.", + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "teams", - "weight": 540, + "method": "createFloatColumn", + "group": "columns", + "weight": 782, "cookies": false, "type": "", - "demo": "teams\/delete.md", + "demo": "tablesdb\/create-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [] } @@ -59754,124 +58506,99 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] - } - }, - "\/teams\/{teamId}\/logs": { - "get": { - "summary": "List team logs", - "operationId": "teamsListLogs", - "tags": [ - "teams" ], - "description": "Get the team activity logs list by its unique ID.", - "responses": { - "200": { - "description": "Logs List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/logList" - } + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] } } } - }, - "deprecated": false, - "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 550, - "cookies": false, - "type": "", - "demo": "teams\/list-logs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "teamId", - "description": "Team ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", - "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", - "x-example": false, - "default": true - }, - "in": "query" - } - ] + } } }, - "\/teams\/{teamId}\/memberships": { - "get": { - "summary": "List team memberships", - "operationId": "teamsListMemberships", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesDBUpdateFloatColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Memberships List", + "description": "ColumnFloat", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membershipList" + "$ref": "#\/components\/schemas\/columnFloat" } } } @@ -59879,25 +58606,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "listMemberships", - "group": "memberships", - "weight": 546, + "method": "updateFloatColumn", + "group": "columns", + "weight": 783, "cookies": false, "type": "", - "demo": "teams\/list-memberships.md", + "demo": "tablesdb\/update-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [] } @@ -59905,72 +58635,104 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { "post": { - "summary": "Create team membership", - "operationId": "teamsCreateMembership", + "summary": "Create integer column", + "operationId": "tablesDBCreateIntegerColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n", + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", "responses": { - "201": { - "description": "Membership", + "202": { + "description": "ColumnInteger", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membership" + "$ref": "#\/components\/schemas\/columnInteger" } } } @@ -59978,25 +58740,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createMembership", - "group": "memberships", - "weight": 544, + "method": "createIntegerColumn", + "group": "columns", + "weight": 784, "cookies": false, "type": "", - "demo": "teams\/create-membership.md", - "rate-limit": 10, + "demo": "tablesdb\/create-integer-column.md", + "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [] } @@ -60004,18 +58769,27 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -60026,45 +58800,46 @@ "schema": { "type": "object", "properties": { - "email": { + "key": { "type": "string", - "description": "Email of the new team member.", - "x-example": "email@example.com", - "format": "email" + "description": "Column Key.", + "x-example": null }, - "userId": { - "type": "string", - "description": "ID of the user to be added to a team.", - "x-example": "" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "phone": { - "type": "string", - "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", - "format": "phone" + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true }, - "roles": { - "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "max": { + "type": "integer", + "description": "Maximum value", "x-example": null, - "items": { - "type": "string" - } + "format": "int64", + "x-nullable": true }, - "url": { - "type": "string", - "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "x-example": "https:\/\/example.com", - "format": "url" + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true }, - "name": { - "type": "string", - "description": "Name of the new team member. Max length: 128 chars.", - "x-example": "" + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ - "roles" + "key", + "required" ] } } @@ -60072,21 +58847,21 @@ } } }, - "\/teams\/{teamId}\/memberships\/{membershipId}": { - "get": { - "summary": "Get team membership", - "operationId": "teamsGetMembership", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesDBUpdateIntegerColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Membership", + "description": "ColumnInteger", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membership" + "$ref": "#\/components\/schemas\/columnInteger" } } } @@ -60094,25 +58869,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "getMembership", - "group": "memberships", - "weight": 545, + "method": "updateIntegerColumn", + "group": "columns", + "weight": 785, "cookies": false, "type": "", - "demo": "teams\/get-membership.md", + "demo": "tablesdb\/update-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [] } @@ -60120,47 +58898,104 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, - "patch": { - "summary": "Update team membership", - "operationId": "teamsUpdateMembership", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesDBCreateIpColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n", + "description": "Create IP address column.\n", "responses": { - "200": { - "description": "Membership", + "202": { + "description": "ColumnIP", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membership" + "$ref": "#\/components\/schemas\/columnIp" } } } @@ -60168,25 +59003,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembership", - "group": "memberships", - "weight": 547, + "method": "createIpColumn", + "group": "columns", + "weight": 786, "cookies": false, "type": "", - "demo": "teams\/update-membership.md", + "demo": "tablesdb\/create-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [] } @@ -60194,28 +59032,27 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -60226,56 +59063,82 @@ "schema": { "type": "object", "properties": { - "roles": { - "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", "x-example": null, - "items": { - "type": "string" - } + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ - "roles" + "key", + "required" ] } } } } - }, - "delete": { - "summary": "Delete team membership", - "operationId": "teamsDeleteMembership", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesDBUpdateIpColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.", + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteMembership", - "group": "memberships", - "weight": 1074, + "method": "updateIpColumn", + "group": "columns", + "weight": 787, "cookies": false, "type": "", - "demo": "teams\/delete-membership.md", + "demo": "tablesdb\/update-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [] } @@ -60283,49 +59146,89 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, - "\/teams\/{teamId}\/memberships\/{membershipId}\/status": { - "patch": { - "summary": "Update team membership status", - "operationId": "teamsUpdateMembershipStatus", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { + "post": { + "summary": "Create line column", + "operationId": "tablesDBCreateLineColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n", + "description": "Create a geometric line column.", "responses": { - "200": { - "description": "Membership", + "202": { + "description": "ColumnLine", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membership" + "$ref": "#\/components\/schemas\/columnLine" } } } @@ -60333,24 +59236,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipStatus", - "group": "memberships", - "weight": 549, + "method": "createLineColumn", + "group": "columns", + "weight": 788, "cookies": false, "type": "", - "demo": "teams\/update-membership-status.md", + "demo": "tablesdb\/create-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [] } @@ -60358,27 +59265,27 @@ "security": [ { "Project": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -60389,20 +59296,33 @@ "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID.", - "x-example": "" + "description": "Column Key.", + "x-example": null }, - "secret": { - "type": "string", - "description": "Secret key.", - "x-example": "" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", + "x-example": "[[1, 2], [3, 4], [5, 6]]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true } }, "required": [ - "userId", - "secret" + "key", + "required" ] } } @@ -60410,21 +59330,21 @@ } } }, - "\/teams\/{teamId}\/prefs": { - "get": { - "summary": "Get team preferences", - "operationId": "teamsGetPrefs", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { + "patch": { + "summary": "Update line column", + "operationId": "tablesDBUpdateLineColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).", + "description": "Update a line column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Preferences", + "description": "ColumnLine", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/preferences" + "$ref": "#\/components\/schemas\/columnLine" } } } @@ -60432,24 +59352,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPrefs", - "group": "teams", - "weight": 542, + "method": "updateLineColumn", + "group": "columns", + "weight": 789, "cookies": false, "type": "", - "demo": "teams\/get-prefs.md", + "demo": "tablesdb\/update-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [] } @@ -60457,36 +59381,95 @@ "security": [ { "Project": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, - "put": { - "summary": "Update team preferences", - "operationId": "teamsUpdatePrefs", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", + "x-example": "[[1, 2], [3, 4], [5, 6]]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + "post": { + "summary": "Create longtext column", + "operationId": "tablesDBCreateLongtextColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.", + "description": "Create a longtext column.\n", "responses": { - "200": { - "description": "Preferences", + "202": { + "description": "ColumnLongtext", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/preferences" + "$ref": "#\/components\/schemas\/columnLongtext" } } } @@ -60494,24 +59477,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePrefs", - "group": "teams", - "weight": 543, + "method": "createLongtextColumn", + "group": "columns", + "weight": 806, "cookies": false, "type": "", - "demo": "teams\/update-prefs.md", + "demo": "tablesdb\/create-longtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", "auth": { "Project": [] } @@ -60519,17 +59506,27 @@ "security": [ { "Project": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -60540,14 +59537,36 @@ "schema": { "type": "object", "properties": { - "prefs": { - "type": "object", - "description": "Prefs key-value JSON object.", - "x-example": "{}" + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false } }, "required": [ - "prefs" + "key", + "required" ] } } @@ -60555,21 +59574,21 @@ } } }, - "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "List tokens", - "operationId": "tokensList", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { + "patch": { + "summary": "Update longtext column", + "operationId": "tablesDBUpdateLongtextColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", + "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Resource Tokens List", + "description": "ColumnLongtext", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/resourceTokenList" + "$ref": "#\/components\/schemas\/columnLongtext" } } } @@ -60577,22 +59596,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "files", - "weight": 553, + "method": "updateLongtextColumn", + "group": "columns", + "weight": 807, "cookies": false, "type": "", - "demo": "tokens\/list.md", + "demo": "tablesdb\/update-longtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", "auth": { "Project": [] } @@ -60605,65 +59630,84 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File unique ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire", - "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, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { "post": { - "summary": "Create file token", - "operationId": "tokensCreateFileToken", + "summary": "Create mediumtext column", + "operationId": "tablesDBCreateMediumtextColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.", + "description": "Create a mediumtext column.\n", "responses": { - "201": { - "description": "ResourceToken", + "202": { + "description": "ColumnMediumtext", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/resourceToken" + "$ref": "#\/components\/schemas\/columnMediumtext" } } } @@ -60671,22 +59715,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFileToken", - "group": "files", - "weight": 551, + "method": "createMediumtextColumn", + "group": "columns", + "weight": 804, "cookies": false, "type": "", - "demo": "tokens\/create-file-token.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/create-mediumtext-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", "auth": { "Project": [] } @@ -60699,22 +59749,22 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File unique ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -60725,35 +59775,58 @@ "schema": { "type": "object", "properties": { - "expire": { + "key": { "type": "string", - "description": "Token expiry date", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } } } } }, - "\/tokens\/{tokenId}": { - "get": { - "summary": "Get token", - "operationId": "tokensGet", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { + "patch": { + "summary": "Update mediumtext column", + "operationId": "tablesDBUpdateMediumtextColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "Get a token by its unique ID.", + "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ResourceToken", + "description": "ColumnMediumtext", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/resourceToken" + "$ref": "#\/components\/schemas\/columnMediumtext" } } } @@ -60761,22 +59834,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "tokens", - "weight": 552, + "method": "updateMediumtextColumn", + "group": "columns", + "weight": 805, "cookies": false, "type": "", - "demo": "tokens\/get.md", + "demo": "tablesdb\/update-mediumtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", "auth": { "Project": [] } @@ -60789,72 +59868,31 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - } - ] - }, - "patch": { - "summary": "Update token", - "operationId": "tokensUpdate", - "tags": [ - "tokens" - ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", - "responses": { - "200": { - "description": "ResourceToken", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/resourceToken" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "update", - "group": "tokens", - "weight": 554, - "cookies": false, - "type": "", - "demo": "tokens\/update.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ + }, { - "name": "tokenId", - "description": "Token unique ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } @@ -60865,49 +59903,78 @@ "schema": { "type": "object", "properties": { - "expire": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { "type": "string", - "description": "File token expiry date", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } } } - }, - "delete": { - "summary": "Delete token", - "operationId": "tokensDelete", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { + "post": { + "summary": "Create point column", + "operationId": "tablesDBCreatePointColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "Delete a token by its unique ID.", + "description": "Create a geometric point column.", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnPoint", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnPoint" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "tokens", - "weight": 555, + "method": "createPointColumn", + "group": "columns", + "weight": 790, "cookies": false, "type": "", - "demo": "tokens\/delete.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/create-point-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [] } @@ -60920,33 +59987,81 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", + "x-example": "[1, 2]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } } }, - "\/users": { - "get": { - "summary": "List users", - "operationId": "usersList", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "patch": { + "summary": "Update point column", + "operationId": "tablesDBUpdatePointColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Get a list of all the project's users. You can use the query params to filter your results.", + "description": "Update a point column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Users List", + "description": "ColumnPoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/userList" + "$ref": "#\/components\/schemas\/columnPoint" } } } @@ -60954,23 +60069,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "users", - "weight": 76, + "method": "updatePointColumn", + "group": "columns", + "weight": 791, "cookies": false, "type": "", - "demo": "users\/list.md", + "demo": "tablesdb\/update-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [] } @@ -60983,56 +60103,90 @@ ], "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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator", - "required": false, + "name": "databaseId", + "description": "Database ID.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", + "x-example": "[1, 2]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { "post": { - "summary": "Create user", - "operationId": "usersCreate", + "summary": "Create polygon column", + "operationId": "tablesDBCreatePolygonColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user.", + "description": "Create a geometric polygon column.", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnPolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnPolygon" } } } @@ -61040,23 +60194,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "users", - "weight": 67, + "method": "createPolygonColumn", + "group": "columns", + "weight": 792, "cookies": false, "type": "", - "demo": "users\/create.md", + "demo": "tablesdb\/create-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", "auth": { "Project": [] } @@ -61067,44 +60226,61 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Column Key.", + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email", - "x-nullable": true + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "phone": { - "type": "string", - "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", - "format": "phone", + "default": { + "type": "array", + "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, "x-nullable": true - }, - "password": { - "type": "string", - "description": "Plain text user password. Must be at least 8 chars.", - "x-example": null - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" } }, "required": [ - "userId" + "key", + "required" ] } } @@ -61112,21 +60288,21 @@ } } }, - "\/users\/argon2": { - "post": { - "summary": "Create user with Argon2 password", - "operationId": "usersCreateArgon2User", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "patch": { + "summary": "Update polygon column", + "operationId": "tablesDBUpdatePolygonColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnPolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnPolygon" } } } @@ -61134,23 +60310,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createArgon2User", - "group": "users", - "weight": 70, + "method": "updatePolygonColumn", + "group": "columns", + "weight": 793, "cookies": false, "type": "", - "demo": "users\/create-argon-2-user.md", + "demo": "tablesdb\/update-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", "auth": { "Project": [] } @@ -61161,39 +60342,70 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "password": { - "type": "string", - "description": "User password hashed using Argon2.", - "x-example": "password", - "format": "password" + "default": { + "type": "array", + "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true }, - "name": { + "newKey": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "required" ] } } @@ -61201,21 +60413,21 @@ } } }, - "\/users\/bcrypt": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { "post": { - "summary": "Create user with bcrypt password", - "operationId": "usersCreateBcryptUser", + "summary": "Create relationship column", + "operationId": "tablesDBCreateRelationshipColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnRelationship" } } } @@ -61223,23 +60435,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createBcryptUser", - "group": "users", - "weight": 68, + "method": "createRelationshipColumn", + "group": "columns", + "weight": 794, "cookies": false, "type": "", - "demo": "users\/create-bcrypt-user.md", + "demo": "tablesdb\/create-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", "auth": { "Project": [] } @@ -61250,39 +60467,85 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { + "relatedTableId": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Related Table ID.", + "x-example": "" }, - "email": { + "type": { "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "description": "Relation type", + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [] }, - "password": { + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "x-example": false + }, + "key": { "type": "string", - "description": "User password hashed using Bcrypt.", - "x-example": "password", - "format": "password" + "description": "Column Key.", + "x-example": null, + "x-nullable": true }, - "name": { + "twoWayKey": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "Two Way Column Key.", + "x-example": null, + "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "userId", - "email", - "password" + "relatedTableId", + "type" ] } } @@ -61290,45 +60553,54 @@ } } }, - "\/users\/identities": { - "get": { - "summary": "List identities", - "operationId": "usersListIdentities", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesDBCreateStringColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Get identities for all users.", + "description": "Create a string column.\n", "responses": { - "200": { - "description": "Identities List", + "202": { + "description": "ColumnString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/identityList" + "$ref": "#\/components\/schemas\/columnString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "listIdentities", - "group": "identities", - "weight": 84, + "method": "createStringColumn", + "group": "columns", + "weight": 796, "cookies": false, "type": "", - "demo": "users\/list-identities.md", + "demo": "tablesdb\/create-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", + "deprecated": { + "since": "1.9.0", + "replaceWith": "tablesDB.createTextColumn" + }, "auth": { "Project": [] } @@ -61341,75 +60613,124 @@ ], "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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "databaseId", + "description": "Database ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Column size for text columns, in number of characters.", + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } } }, - "\/users\/identities\/{identityId}": { - "delete": { - "summary": "Delete identity", - "operationId": "usersDeleteIdentity", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesDBUpdateStringColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Delete an identity by its unique ID.", + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteIdentity", - "group": "identities", - "weight": 108, + "method": "updateStringColumn", + "group": "columns", + "weight": 797, "cookies": false, "type": "", - "demo": "users\/delete-identity.md", + "demo": "tablesdb\/update-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateTextColumn" + }, "auth": { "Project": [] } @@ -61422,65 +60743,33 @@ ], "parameters": [ { - "name": "identityId", - "description": "Identity ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - } - ] - } - }, - "\/users\/md5": { - "post": { - "summary": "Create user with MD5 password", - "operationId": "usersCreateMD5User", - "tags": [ - "users" - ], - "description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", - "responses": { - "201": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createMD5User", - "group": "users", - "weight": 69, - "cookies": false, - "type": "", - "demo": "users\/create-md-5-user.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md", - "auth": { - "Project": [] - } - }, - "security": [ + }, { - "Project": [], - "Key": [] + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -61489,33 +60778,34 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "email": { + "default": { "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true }, - "password": { - "type": "string", - "description": "User password hashed using MD5.", - "x-example": "password", - "format": "password" + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "x-example": 1, + "format": "int32", + "x-nullable": true }, - "name": { + "newKey": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "required", + "default" ] } } @@ -61523,21 +60813,21 @@ } } }, - "\/users\/phpass": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { "post": { - "summary": "Create user with PHPass password", - "operationId": "usersCreatePHPassUser", + "summary": "Create text column", + "operationId": "tablesDBCreateTextColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a text column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnText", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnText" } } } @@ -61545,23 +60835,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPHPassUser", - "group": "users", - "weight": 72, + "method": "createTextColumn", + "group": "columns", + "weight": 802, "cookies": false, "type": "", - "demo": "users\/create-ph-pass-user.md", + "demo": "tablesdb\/create-text-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", "auth": { "Project": [] } @@ -61572,39 +60867,64 @@ "Key": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "description": "Column Key.", + "x-example": null }, - "password": { - "type": "string", - "description": "User password hashed using PHPass.", - "x-example": "password", - "format": "password" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "name": { + "default": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false } }, "required": [ - "userId", - "email", - "password" + "key", + "required" ] } } @@ -61612,21 +60932,21 @@ } } }, - "\/users\/scrypt": { - "post": { - "summary": "Create user with Scrypt password", - "operationId": "usersCreateScryptUser", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { + "patch": { + "summary": "Update text column", + "operationId": "tablesDBUpdateTextColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnText", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnText" } } } @@ -61634,23 +60954,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createScryptUser", - "group": "users", - "weight": 73, + "method": "updateTextColumn", + "group": "columns", + "weight": 803, "cookies": false, "type": "", - "demo": "users\/create-scrypt-user.md", + "demo": "tablesdb\/update-text-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", "auth": { "Project": [] } @@ -61661,73 +60986,64 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "password": { + "default": { "type": "string", - "description": "User password hashed using Scrypt.", - "x-example": "password", - "format": "password" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true }, - "passwordSalt": { + "newKey": { "type": "string", - "description": "Optional salt used to hash password.", - "x-example": "" - }, - "passwordCpu": { - "type": "integer", - "description": "Optional CPU cost used to hash password.", - "x-example": null, - "format": "int32" - }, - "passwordMemory": { - "type": "integer", - "description": "Optional memory cost used to hash password.", - "x-example": null, - "format": "int32" - }, - "passwordParallel": { - "type": "integer", - "description": "Optional parallelization cost used to hash password.", - "x-example": null, - "format": "int32" - }, - "passwordLength": { - "type": "integer", - "description": "Optional hash length used to hash password.", + "description": "New Column Key.", "x-example": null, - "format": "int32" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "x-nullable": true } }, "required": [ - "userId", - "email", - "password", - "passwordSalt", - "passwordCpu", - "passwordMemory", - "passwordParallel", - "passwordLength" + "required", + "default" ] } } @@ -61735,21 +61051,21 @@ } } }, - "\/users\/scrypt-modified": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { "post": { - "summary": "Create user with Scrypt modified password", - "operationId": "usersCreateScryptModifiedUser", + "summary": "Create URL column", + "operationId": "tablesDBCreateUrlColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a URL column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnUrl" } } } @@ -61757,23 +61073,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createScryptModifiedUser", - "group": "users", - "weight": 74, + "method": "createUrlColumn", + "group": "columns", + "weight": 798, "cookies": false, "type": "", - "demo": "users\/create-scrypt-modified-user.md", + "demo": "tablesdb\/create-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", "auth": { "Project": [] } @@ -61784,57 +61105,60 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" - }, - "password": { - "type": "string", - "description": "User password hashed using Scrypt Modified.", - "x-example": "password", - "format": "password" - }, - "passwordSalt": { + "key": { "type": "string", - "description": "Salt used to hash password.", - "x-example": "" + "description": "Column Key.", + "x-example": null }, - "passwordSaltSeparator": { - "type": "string", - "description": "Salt separator used to hash password.", - "x-example": "" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "passwordSignerKey": { + "default": { "type": "string", - "description": "Signer key used to hash password.", - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ - "userId", - "email", - "password", - "passwordSalt", - "passwordSaltSeparator", - "passwordSignerKey" + "key", + "required" ] } } @@ -61842,21 +61166,21 @@ } } }, - "\/users\/sha": { - "post": { - "summary": "Create user with SHA password", - "operationId": "usersCreateSHAUser", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesDBUpdateUrlColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnUrl" } } } @@ -61864,23 +61188,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSHAUser", - "group": "users", - "weight": 71, + "method": "updateUrlColumn", + "group": "columns", + "weight": 799, "cookies": false, "type": "", - "demo": "users\/create-sha-user.md", + "demo": "tablesdb\/update-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", "auth": { "Project": [] } @@ -61891,59 +61220,65 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" - }, - "password": { - "type": "string", - "description": "User password hashed using SHA.", - "x-example": "password", - "format": "password" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "passwordVersion": { + "default": { "type": "string", - "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", - "x-example": "sha1", - "enum": [ - "sha1", - "sha224", - "sha256", - "sha384", - "sha512\/224", - "sha512\/256", - "sha512", - "sha3-224", - "sha3-256", - "sha3-384", - "sha3-512" - ], - "x-enum-name": "PasswordHash", - "x-enum-keys": [] + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, - "name": { + "newKey": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "required", + "default" ] } } @@ -61951,21 +61286,21 @@ } } }, - "\/users\/usage": { - "get": { - "summary": "Get users usage stats", - "operationId": "usersGetUsage", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { + "post": { + "summary": "Create varchar column", + "operationId": "tablesDBCreateVarcharColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", + "description": "Create a varchar column.\n", "responses": { - "200": { - "description": "UsageUsers", + "202": { + "description": "ColumnVarchar", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageUsers" + "$ref": "#\/components\/schemas\/columnVarchar" } } } @@ -61973,96 +61308,154 @@ }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 110, + "method": "createVarcharColumn", + "group": "columns", + "weight": 800, "cookies": false, "type": "", - "demo": "users\/get-usage.md", + "demo": "tablesdb\/create-varchar-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "range", - "description": "Date range.", - "required": false, + "name": "databaseId", + "description": "Database ID.", + "required": true, "schema": { "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" + "x-example": "" }, - "in": "query" + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - ] - } - }, - "\/users\/{userId}": { - "get": { - "summary": "Get user", - "operationId": "usersGet", - "tags": [ - "users" ], - "description": "Get a user by its unique ID.", - "responses": { - "200": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "get", - "group": "users", - "weight": 77, + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { + "patch": { + "summary": "Update varchar column", + "operationId": "tablesDBUpdateVarcharColumn", + "tags": [ + "tablesDB" + ], + "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", + "responses": { + "200": { + "description": "ColumnVarchar", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnVarchar" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateVarcharColumn", + "group": "columns", + "weight": 801, "cookies": false, "type": "", - "demo": "users\/get.md", + "demo": "tablesdb\/update-varchar-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", "auth": { "Project": [] } @@ -62075,48 +61468,202 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, - "delete": { - "summary": "Delete user", - "operationId": "usersDelete", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the varchar column.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesDBGetColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.", + "description": "Get column by ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/components\/schemas\/columnBoolean", + "integer": "#\/components\/schemas\/columnInteger", + "double": "#\/components\/schemas\/columnFloat", + "string": "#\/components\/schemas\/columnString", + "datetime": "#\/components\/schemas\/columnDatetime", + "relationship": "#\/components\/schemas\/columnRelationship" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/components\/schemas\/columnBoolean": { + "type": "boolean" + }, + "#\/components\/schemas\/columnInteger": { + "type": "integer" + }, + "#\/components\/schemas\/columnFloat": { + "type": "double" + }, + "#\/components\/schemas\/columnEmail": { + "type": "string", + "format": "email" + }, + "#\/components\/schemas\/columnEnum": { + "type": "string", + "format": "enum" + }, + "#\/components\/schemas\/columnUrl": { + "type": "string", + "format": "url" + }, + "#\/components\/schemas\/columnIp": { + "type": "string", + "format": "ip" + }, + "#\/components\/schemas\/columnDatetime": { + "type": "datetime" + }, + "#\/components\/schemas\/columnRelationship": { + "type": "relationship" + }, + "#\/components\/schemas\/columnString": { + "type": "string" + } + } + } + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "users", - "weight": 106, + "method": "getColumn", + "group": "columns", + "weight": 771, "cookies": false, "type": "", - "demo": "users\/delete.md", + "demo": "tablesdb\/get-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read", + "columns.read", + "attributes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md", "auth": { "Project": [] } @@ -62129,57 +61676,72 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } ] - } - }, - "\/users\/{userId}\/email": { - "patch": { - "summary": "Update email", - "operationId": "usersUpdateEmail", + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDBDeleteColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user email by its unique ID.", + "description": "Deletes a column.", "responses": { - "200": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateEmail", - "group": "users", - "weight": 91, + "method": "deleteColumn", + "group": "columns", + "weight": 772, "cookies": false, "type": "", - "demo": "users\/update-email.md", + "demo": "tablesdb\/delete-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md", "auth": { "Project": [] } @@ -62192,53 +61754,52 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" - } - }, - "required": [ - "email" - ] - } - } - } - } + ] } }, - "\/users\/{userId}\/impersonator": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { "patch": { - "summary": "Update user impersonator capability", - "operationId": "usersUpdateImpersonator", + "summary": "Update relationship column", + "operationId": "tablesDBUpdateRelationshipColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.\n", + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { "200": { - "description": "User", + "description": "ColumnRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnRelationship" } } } @@ -62246,23 +61807,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateImpersonator", - "group": "users", - "weight": 87, + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 795, "cookies": false, "type": "", - "demo": "users\/update-impersonator.md", + "demo": "tablesdb\/update-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-impersonator.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md", "auth": { "Project": [] } @@ -62275,12 +61841,31 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } @@ -62291,36 +61876,47 @@ "schema": { "type": "object", "properties": { - "impersonator": { - "type": "boolean", - "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", - "x-example": false + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [], + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } - }, - "required": [ - "impersonator" - ] + } } } } } } }, - "\/users\/{userId}\/jwts": { - "post": { - "summary": "Create user JWT", - "operationId": "usersCreateJWT", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesDBListIndexes", "tags": [ - "users" + "tablesDB" ], - "description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.", + "description": "List indexes on the table.", "responses": { - "201": { - "description": "JWT", + "200": { + "description": "Column Indexes List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/jwt" + "$ref": "#\/components\/schemas\/columnIndexList" } } } @@ -62328,23 +61924,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "createJWT", - "group": "sessions", - "weight": 109, + "method": "listIndexes", + "group": "indexes", + "weight": 811, "cookies": false, "type": "", - "demo": "users\/create-jwt.md", + "demo": "tablesdb\/list-indexes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read", + "indexes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md", "auth": { "Project": [] } @@ -62357,55 +61957,65 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "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 columns: key, type, status, attributes, error", + "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", + "x-example": false, + "default": true + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "sessionId": { - "type": "string", - "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", - "x-example": "" - }, - "duration": { - "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", - "x-example": 0, - "format": "int32" - } - } - } - } - } - } - } - }, - "\/users\/{userId}\/labels": { - "put": { - "summary": "Update user labels", - "operationId": "usersUpdateLabels", + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesDBCreateIndex", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.", + "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.", "responses": { - "200": { - "description": "User", + "202": { + "description": "Index", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnIndex" } } } @@ -62413,23 +62023,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLabels", - "group": "users", - "weight": 86, + "method": "createIndex", + "group": "indexes", + "weight": 808, "cookies": false, "type": "", - "demo": "users\/update-labels.md", + "demo": "tablesdb\/create-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "indexes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md", "auth": { "Project": [] } @@ -62442,12 +62056,22 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -62458,17 +62082,59 @@ "schema": { "type": "object", "properties": { - "labels": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "key", + "enum": [ + "key", + "fulltext", + "unique", + "spatial" + ], + "x-enum-name": "TablesDBIndexType", + "x-enum-keys": [] + }, + "columns": { "type": "array", - "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", "x-example": null, "items": { "type": "string" } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } } }, "required": [ - "labels" + "key", + "type", + "columns" ] } } @@ -62476,21 +62142,21 @@ } } }, - "\/users\/{userId}\/logs": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { "get": { - "summary": "List user logs", - "operationId": "usersListLogs", + "summary": "Get index", + "operationId": "tablesDBGetIndex", "tags": [ - "users" + "tablesDB" ], - "description": "Get the user activity logs list by its unique ID.", + "description": "Get index by ID.", "responses": { "200": { - "description": "Logs List", + "description": "Index", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/logList" + "$ref": "#\/components\/schemas\/columnIndex" } } } @@ -62498,23 +62164,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 82, + "method": "getIndex", + "group": "indexes", + "weight": 809, "cookies": false, "type": "", - "demo": "users\/list-logs.md", + "demo": "tablesdb\/get-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.read", + "collections.read", + "indexes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md", "auth": { "Project": [] } @@ -62527,12 +62197,182 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "tablesDBDeleteIndex", + "tags": [ + "tablesDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 810, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "indexes.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/logs": { + "get": { + "summary": "List table logs", + "operationId": "tablesDBListTableLogs", + "tags": [ + "tablesDB" + ], + "description": "Get the table activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/logList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTableLogs", + "group": "tables", + "weight": 769, + "cookies": false, + "type": "", + "demo": "tablesdb\/list-table-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.read", + "collections.read" + ], + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-logs.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" }, @@ -62548,36 +62388,25 @@ "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", - "x-example": false, - "default": true - }, - "in": "query" } ] } }, - "\/users\/{userId}\/memberships": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": { "get": { - "summary": "List user memberships", - "operationId": "usersListMemberships", + "summary": "List rows", + "operationId": "tablesDBListRows", "tags": [ - "users" + "tablesDB" ], - "description": "Get the user membership list by its unique ID.", + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", "responses": { "200": { - "description": "Memberships List", + "description": "Rows List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membershipList" + "$ref": "#\/components\/schemas\/rowList" } } } @@ -62585,23 +62414,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "listMemberships", - "group": "memberships", - "weight": 81, + "method": "listRows", + "group": "rows", + "weight": 899, "cookies": false, "type": "", - "demo": "users\/list-memberships.md", + "demo": "tablesdb\/list-rows.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md", "auth": { "Project": [] } @@ -62609,23 +62443,34 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", "required": false, "schema": { "type": "array", @@ -62637,13 +62482,12 @@ "in": "query" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", "required": false, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, "in": "query" }, @@ -62657,106 +62501,122 @@ "default": true }, "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" } ] - } - }, - "\/users\/{userId}\/mfa": { - "patch": { - "summary": "Update MFA", - "operationId": "usersUpdateMfa", + }, + "post": { + "summary": "Create row", + "operationId": "tablesDBCreateRow", "tags": [ - "users" + "tablesDB" ], - "description": "Enable or disable MFA on a user account.", + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { - "200": { - "description": "User", + "201": { + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/row" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateMfa", - "group": "users", - "weight": 96, + "method": "createRow", + "group": "rows", + "weight": 812, "cookies": false, "type": "", - "demo": "users\/update-mfa.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/create-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFA" - }, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md", "methods": [ { - "name": "updateMfa", - "namespace": "users", - "desc": "", + "name": "createRow", + "namespace": "tablesDB", + "desc": "Create row", "auth": { "Project": [] }, "parameters": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rowId", + "data", + "permissions", + "transactionId" ], "required": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rowId", + "data" ], "responses": [ { - "code": 200, - "model": "#\/components\/schemas\/user" + "code": 201, + "model": "#\/components\/schemas\/row" } ], - "description": "Enable or disable MFA on a user account.", - "demo": "users\/update-mfa.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFA" - } + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/create-row.md", + "public": true }, { - "name": "updateMFA", - "namespace": "users", - "desc": "", + "name": "createRows", + "namespace": "tablesDB", + "desc": "Create rows", "auth": { "Project": [] }, "parameters": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rows", + "transactionId" ], "required": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rows" ], "responses": [ { - "code": 200, - "model": "#\/components\/schemas\/user" + "code": 201, + "model": "#\/components\/schemas\/rowList" } ], - "description": "Enable or disable MFA on a user account.", - "demo": "users\/update-mfa.md", + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/create-rows.md", "public": true } ], @@ -62767,17 +62627,28 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -62788,108 +62659,113 @@ "schema": { "type": "object", "properties": { - "mfa": { - "type": "boolean", - "description": "Enable or disable MFA.", - "x-example": false + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "rows": { + "type": "array", + "description": "Array of rows data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "mfa" - ] + } } } } } - } - }, - "\/users\/{userId}\/mfa\/authenticators\/{type}": { - "delete": { - "summary": "Delete authenticator", - "operationId": "usersDeleteMfaAuthenticator", + }, + "put": { + "summary": "Upsert rows", + "operationId": "tablesDBUpsertRows", "tags": [ - "users" + "tablesDB" ], - "description": "Delete an authenticator app.", + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "deleteMfaAuthenticator", - "group": "mfa", - "weight": 101, + "method": "upsertRows", + "group": "rows", + "weight": 817, "cookies": false, "type": "", - "demo": "users\/delete-mfa-authenticator.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/upsert-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.deleteMFAAuthenticator" - }, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md", "methods": [ { - "name": "deleteMfaAuthenticator", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId", - "type" - ], - "required": [ - "userId", - "type" - ], - "responses": [ - { - "code": 204 - } - ], - "description": "Delete an authenticator app.", - "demo": "users\/delete-mfa-authenticator.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.deleteMFAAuthenticator" - } - }, - { - "name": "deleteMFAAuthenticator", - "namespace": "users", + "name": "upsertRows", + "namespace": "tablesDB", "desc": "", "auth": { "Project": [] }, "parameters": [ - "userId", - "type" + "databaseId", + "tableId", + "rows", + "transactionId" ], "required": [ - "userId", - "type" + "databaseId", + "tableId", + "rows" ], "responses": [ { - "code": 204 + "code": 201, + "model": "#\/components\/schemas\/rowList" } ], - "description": "Delete an authenticator app.", - "demo": "users\/delete-mfa-authenticator.md", + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", + "demo": "tablesdb\/upsert-rows.md", "public": true } ], @@ -62905,128 +62781,96 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "type", - "description": "Type of authenticator.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "totp", - "enum": [ - "totp" - ], - "x-enum-name": "AuthenticatorType", - "x-enum-keys": [] + "x-example": "" }, "in": "path" } - ] - } - }, - "\/users\/{userId}\/mfa\/factors": { - "get": { - "summary": "List factors", - "operationId": "usersListMfaFactors", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "rows" + ] + } + } + } + } + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesDBUpdateRows", "tags": [ - "users" + "tablesDB" ], - "description": "List the factors available on the account to be used as a MFA challange.", + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", "responses": { "200": { - "description": "MFAFactors", + "description": "Rows List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/mfaFactors" + "$ref": "#\/components\/schemas\/rowList" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listMfaFactors", - "group": "mfa", - "weight": 97, + "method": "updateRows", + "group": "rows", + "weight": 815, "cookies": false, "type": "", - "demo": "users\/list-mfa-factors.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/update-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.listMFAFactors" - }, - "methods": [ - { - "name": "listMfaFactors", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaFactors" - } - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "demo": "users\/list-mfa-factors.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.listMFAFactors" - } - }, - { - "name": "listMFAFactors", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaFactors" - } - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "demo": "users\/list-mfa-factors.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", "auth": { "Project": [] } @@ -63039,113 +62883,98 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] - } - }, - "\/users\/{userId}\/mfa\/recovery-codes": { - "get": { - "summary": "Get MFA recovery codes", - "operationId": "usersGetMfaRecoveryCodes", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDBDeleteRows", "tags": [ - "users" + "tablesDB" ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", "responses": { "200": { - "description": "MFA Recovery Codes", + "description": "Rows List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/mfaRecoveryCodes" + "$ref": "#\/components\/schemas\/rowList" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getMfaRecoveryCodes", - "group": "mfa", - "weight": 98, + "method": "deleteRows", + "group": "rows", + "weight": 819, "cookies": false, "type": "", - "demo": "users\/get-mfa-recovery-codes.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/delete-rows.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.getMFARecoveryCodes" - }, - "methods": [ - { - "name": "getMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/get-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.getMFARecoveryCodes" - } - }, - { - "name": "getMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/get-mfa-recovery-codes.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", "auth": { "Project": [] } @@ -63158,111 +62987,97 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] - }, - "put": { - "summary": "Update MFA recovery codes (regenerate)", - "operationId": "usersUpdateMfaRecoveryCodes", - "tags": [ - "users" ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "responses": { - "200": { - "description": "MFA Recovery Codes", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/mfaRecoveryCodes" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesDBGetRow", + "tags": [ + "tablesDB" + ], + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "responses": { + "200": { + "description": "Row", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/row" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateMfaRecoveryCodes", - "group": "mfa", - "weight": 100, + "method": "getRow", + "group": "rows", + "weight": 813, "cookies": false, "type": "", - "demo": "users\/update-mfa-recovery-codes.md", + "demo": "tablesdb\/get-row.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFARecoveryCodes" - }, - "methods": [ - { - "name": "updateMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/update-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFARecoveryCodes" - } - }, - { - "name": "updateMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/update-mfa-recovery-codes.md", - "public": false - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md", "auth": { "Project": [] } @@ -63270,113 +63085,138 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } ] }, - "patch": { - "summary": "Create MFA recovery codes", - "operationId": "usersCreateMfaRecoveryCodes", + "put": { + "summary": "Upsert a row", + "operationId": "tablesDBUpsertRow", "tags": [ - "users" + "tablesDB" ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { "201": { - "description": "MFA Recovery Codes", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/mfaRecoveryCodes" + "$ref": "#\/components\/schemas\/row" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createMfaRecoveryCodes", - "group": "mfa", - "weight": 99, + "method": "upsertRow", + "group": "rows", + "weight": 816, "cookies": false, "type": "", - "demo": "users\/create-mfa-recovery-codes.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/upsert-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.createMFARecoveryCodes" - }, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md", "methods": [ { - "name": "createMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", - "demo": "users\/create-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.createMFARecoveryCodes" - } - }, - { - "name": "createMFARecoveryCodes", - "namespace": "users", + "name": "upsertRow", + "namespace": "tablesDB", "desc": "", "auth": { "Project": [] }, "parameters": [ - "userId" + "databaseId", + "tableId", + "rowId", + "data", + "permissions", + "transactionId" ], "required": [ - "userId" + "databaseId", + "tableId", + "rowId" ], "responses": [ { "code": 201, - "model": "#\/components\/schemas\/mfaRecoveryCodes" + "model": "#\/components\/schemas\/row" } ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", - "demo": "users\/create-mfa-recovery-codes.md", + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/upsert-row.md", "public": true } ], @@ -63387,38 +63227,88 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] - } - }, - "\/users\/{userId}\/name": { + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + }, "patch": { - "summary": "Update name", - "operationId": "usersUpdateName", + "summary": "Update row", + "operationId": "tablesDBUpdateRow", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user name by its unique ID.", + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { "200": { - "description": "User", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/row" } } } @@ -63426,23 +63316,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateName", - "group": "users", - "weight": 89, + "method": "updateRow", + "group": "rows", + "weight": 814, "cookies": false, "type": "", - "demo": "users\/update-name.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/update-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md", "auth": { "Project": [] } @@ -63450,17 +63345,38 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -63471,60 +63387,68 @@ "schema": { "type": "object", "properties": { - "name": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "transactionId": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "name" - ] + } } } } } - } - }, - "\/users\/{userId}\/password": { - "patch": { - "summary": "Update password", - "operationId": "usersUpdatePassword", + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDBDeleteRow", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user password by its unique ID.", + "description": "Delete a row by its unique ID.", "responses": { - "200": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updatePassword", - "group": "users", - "weight": 90, + "method": "deleteRow", + "group": "rows", + "weight": 818, "cookies": false, "type": "", - "demo": "users\/update-password.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/delete-row.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md", "auth": { "Project": [] } @@ -63532,17 +63456,38 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -63553,36 +63498,34 @@ "schema": { "type": "object", "properties": { - "password": { + "transactionId": { "type": "string", - "description": "New user password. Must be at least 8 chars.", - "x-example": null + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "password" - ] + } } } } } } }, - "\/users\/{userId}\/phone": { - "patch": { - "summary": "Update phone", - "operationId": "usersUpdatePhone", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { + "get": { + "summary": "List row logs", + "operationId": "tablesDBListRowLogs", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user phone by its unique ID.", + "description": "Get the row activity logs list by its unique ID.", "responses": { "200": { - "description": "User", + "description": "Logs List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/logList" } } } @@ -63590,82 +63533,96 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePhone", - "group": "users", - "weight": 92, + "method": "listRowLogs", + "group": "logs", + "weight": 821, "cookies": false, "type": "", - "demo": "users\/update-phone.md", + "demo": "tablesdb\/list-row-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row-logs.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "number": { - "type": "string", - "description": "User phone number.", - "x-example": "+12065550100", - "format": "phone" - } - }, - "required": [ - "number" - ] - } - } - } - } + ] } }, - "\/users\/{userId}\/prefs": { - "get": { - "summary": "Get user preferences", - "operationId": "usersGetPrefs", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDBDecrementRowColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Get the user preferences by its unique ID.", + "description": "Decrement a specific column of a row by a given value.", "responses": { "200": { - "description": "Preferences", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/preferences" + "$ref": "#\/components\/schemas\/row" } } } @@ -63673,23 +63630,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPrefs", - "group": "users", - "weight": 78, + "method": "decrementRowColumn", + "group": "rows", + "weight": 823, "cookies": false, "type": "", - "demo": "users\/get-prefs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/decrement-row-column.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ + "client", + "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md", "auth": { "Project": [] } @@ -63697,36 +63659,98 @@ "security": [ { "Project": [], + "JWT": [], "Key": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null, + "format": "float" + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { "patch": { - "summary": "Update user preferences", - "operationId": "usersUpdatePrefs", + "summary": "Increment row column", + "operationId": "tablesDBIncrementRowColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.", + "description": "Increment a specific column of a row by a given value.", "responses": { "200": { - "description": "Preferences", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/preferences" + "$ref": "#\/components\/schemas\/row" } } } @@ -63734,23 +63758,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePrefs", - "group": "users", - "weight": 94, + "method": "incrementRowColumn", + "group": "rows", + "weight": 822, "cookies": false, "type": "", - "demo": "users\/update-prefs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/increment-row-column.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ + "client", + "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md", "auth": { "Project": [] } @@ -63758,17 +63787,47 @@ "security": [ { "Project": [], + "JWT": [], "Key": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } @@ -63779,36 +63838,47 @@ "schema": { "type": "object", "properties": { - "prefs": { - "type": "object", - "description": "Prefs key-value JSON object.", - "x-example": "{}" + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null, + "format": "float" + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "prefs" - ] + } } } } } } }, - "\/users\/{userId}\/sessions": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/usage": { "get": { - "summary": "List user sessions", - "operationId": "usersListSessions", + "summary": "Get table usage stats", + "operationId": "tablesDBGetTableUsage", "tags": [ - "users" + "tablesDB" ], - "description": "Get the user sessions list by its unique ID.", + "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { "200": { - "description": "Sessions List", + "description": "UsageTable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/sessionList" + "$ref": "#\/components\/schemas\/usageTable" } } } @@ -63816,71 +63886,95 @@ }, "deprecated": false, "x-appwrite": { - "method": "listSessions", - "group": "sessions", - "weight": 80, + "method": "getTableUsage", + "group": null, + "weight": 770, "cookies": false, "type": "", - "demo": "users\/list-sessions.md", + "demo": "tablesdb\/get-table-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.read", + "collections.read" + ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "name": "range", + "description": "Date range.", "required": false, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, "in": "query" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ] - }, - "post": { - "summary": "Create session", - "operationId": "usersCreateSession", + } + }, + "\/tablesdb\/{databaseId}\/usage": { + "get": { + "summary": "Get TablesDB usage stats", + "operationId": "tablesDBGetUsage", "tags": [ - "users" + "tablesDB" ], - "description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.", + "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { - "201": { - "description": "Session", + "200": { + "description": "UsageDatabase", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/session" + "$ref": "#\/components\/schemas\/usageDatabase" } } } @@ -63888,77 +63982,137 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSession", - "group": "sessions", - "weight": 102, + "method": "getUsage", + "group": null, + "weight": 762, "cookies": false, "type": "", - "demo": "users\/create-session.md", + "demo": "tablesdb\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read" + ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-database-usage.md", + "methods": [ + { + "name": "getUsage", + "namespace": "tablesDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "range" + ], + "required": [ + "databaseId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/usageDatabase" + } + ], + "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "tablesdb\/get-usage.md", + "public": true + } + ], "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" + }, + "in": "query" } ] - }, - "delete": { - "summary": "Delete user sessions", - "operationId": "usersDeleteSessions", + } + }, + "\/teams": { + "get": { + "summary": "List teams", + "operationId": "teamsList", "tags": [ - "users" + "teams" ], - "description": "Delete all user's sessions by using the user's unique ID.", + "description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Teams List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/teamList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteSessions", - "group": "sessions", - "weight": 105, + "method": "list", + "group": "teams", + "weight": 520, "cookies": false, "type": "", - "demo": "users\/delete-sessions.md", + "demo": "teams\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md", "auth": { "Project": [] } @@ -63966,104 +64120,62 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" - } - ] - } - }, - "\/users\/{userId}\/sessions\/{sessionId}": { - "delete": { - "summary": "Delete user session", - "operationId": "usersDeleteSession", - "tags": [ - "users" - ], - "description": "Delete a user sessions by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteSession", - "group": "sessions", - "weight": 104, - "cookies": false, - "type": "", - "demo": "users\/delete-session.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ + "in": "query" + }, { - "name": "userId", - "description": "User ID.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" + "in": "query" }, { - "name": "sessionId", - "description": "Session ID.", - "required": true, + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "boolean", + "x-example": false, + "default": true }, - "in": "path" + "in": "query" } ] - } - }, - "\/users\/{userId}\/status": { - "patch": { - "summary": "Update user status", - "operationId": "usersUpdateStatus", + }, + "post": { + "summary": "Create team", + "operationId": "teamsCreate", "tags": [ - "users" + "teams" ], - "description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.", + "description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.", "responses": { - "200": { - "description": "User", + "201": { + "description": "Team", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/team" } } } @@ -64071,23 +64183,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateStatus", - "group": "users", - "weight": 85, + "method": "create", + "group": "teams", + "weight": 518, "cookies": false, "type": "", - "demo": "users\/update-status.md", + "demo": "teams\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md", "auth": { "Project": [] } @@ -64095,19 +64209,8 @@ "security": [ { "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "userId", - "description": "User ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Key": [], + "JWT": [] } ], "requestBody": { @@ -64116,14 +64219,28 @@ "schema": { "type": "object", "properties": { - "status": { - "type": "boolean", - "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", - "x-example": false + "teamId": { + "type": "string", + "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Team name. Max length: 128 chars.", + "x-example": "" + }, + "roles": { + "type": "array", + "description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "status" + "teamId", + "name" ] } } @@ -64131,21 +64248,21 @@ } } }, - "\/users\/{userId}\/targets": { + "\/teams\/{teamId}": { "get": { - "summary": "List user targets", - "operationId": "usersListTargets", + "summary": "Get team", + "operationId": "teamsGet", "tags": [ - "users" + "teams" ], - "description": "List the messaging targets that are associated with a user.", + "description": "Get a team by its ID. All team members have read access for this resource.", "responses": { "200": { - "description": "Target list", + "description": "Team", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/targetList" + "$ref": "#\/components\/schemas\/team" } } } @@ -64153,23 +64270,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTargets", - "group": "targets", - "weight": 83, + "method": "get", + "group": "teams", + "weight": 519, "cookies": false, "type": "", - "demo": "users\/list-targets.md", + "demo": "teams\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.read", + "scope": "teams.read", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md", "auth": { "Project": [] } @@ -64177,60 +64296,37 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType", - "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", - "x-example": false, - "default": true - }, - "in": "query" } ] }, - "post": { - "summary": "Create user target", - "operationId": "usersCreateTarget", + "put": { + "summary": "Update name", + "operationId": "teamsUpdateName", "tags": [ - "users" + "teams" ], - "description": "Create a messaging target.", + "description": "Update the team's name by its unique ID.", "responses": { - "201": { - "description": "Target", + "200": { + "description": "Team", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/target" + "$ref": "#\/components\/schemas\/team" } } } @@ -64238,23 +64334,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTarget", - "group": "targets", - "weight": 75, + "method": "updateName", + "group": "teams", + "weight": 522, "cookies": false, "type": "", - "demo": "users\/create-target.md", + "demo": "teams\/update-name.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.write", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md", "auth": { "Project": [] } @@ -64262,17 +64360,18 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -64283,89 +64382,53 @@ "schema": { "type": "object", "properties": { - "targetId": { - "type": "string", - "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "providerType": { - "type": "string", - "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email", - "enum": [ - "email", - "sms", - "push" - ], - "x-enum-name": "MessagingProviderType", - "x-enum-keys": [] - }, - "identifier": { - "type": "string", - "description": "The target identifier (token, email, phone etc.)", - "x-example": "" - }, - "providerId": { - "type": "string", - "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", - "x-example": "" - }, "name": { "type": "string", - "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "description": "New team name. Max length: 128 chars.", "x-example": "" } }, "required": [ - "targetId", - "providerType", - "identifier" + "name" ] } } } } - } - }, - "\/users\/{userId}\/targets\/{targetId}": { - "get": { - "summary": "Get user target", - "operationId": "usersGetTarget", + }, + "delete": { + "summary": "Delete team", + "operationId": "teamsDelete", "tags": [ - "users" + "teams" ], - "description": "Get a user's push notification target by ID.", + "description": "Delete a team using its ID. Only team members with the owner role can delete the team.", "responses": { - "200": { - "description": "Target", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/target" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getTarget", - "group": "targets", - "weight": 79, + "method": "delete", + "group": "teams", + "weight": 521, "cookies": false, "type": "", - "demo": "users\/get-target.md", + "demo": "teams\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.read", + "scope": "teams.write", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", "auth": { "Project": [] } @@ -64373,46 +64436,39 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "targetId", - "description": "Target ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] - }, - "patch": { - "summary": "Update user target", - "operationId": "usersUpdateTarget", + } + }, + "\/teams\/{teamId}\/logs": { + "get": { + "summary": "List team logs", + "operationId": "teamsListLogs", "tags": [ - "users" + "teams" ], - "description": "Update a messaging target.", + "description": "Get the team activity logs list by its unique ID.", "responses": { "200": { - "description": "Target", + "description": "Logs List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/target" + "$ref": "#\/components\/schemas\/logList" } } } @@ -64420,113 +64476,110 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTarget", - "group": "targets", - "weight": 95, + "method": "listLogs", + "group": "logs", + "weight": 531, "cookies": false, "type": "", - "demo": "users\/update-target.md", + "demo": "teams\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.read", "platforms": [ - "server", "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "targetId", - "description": "Target ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "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", + "x-example": false, + "default": true + }, + "in": "query" } + ] + } + }, + "\/teams\/{teamId}\/memberships": { + "get": { + "summary": "List team memberships", + "operationId": "teamsListMemberships", + "tags": [ + "teams" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "identifier": { - "type": "string", - "description": "The target identifier (token, email, phone etc.)", - "x-example": "" - }, - "providerId": { - "type": "string", - "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", - "x-example": "" - } + "description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "responses": { + "200": { + "description": "Memberships List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/membershipList" } } } } - } - }, - "delete": { - "summary": "Delete user target", - "operationId": "usersDeleteTarget", - "tags": [ - "users" - ], - "description": "Delete a messaging target.", - "responses": { - "204": { - "description": "No content" - } }, "deprecated": false, "x-appwrite": { - "method": "deleteTarget", - "group": "targets", - "weight": 107, + "method": "listMemberships", + "group": "memberships", + "weight": 527, "cookies": false, "type": "", - "demo": "users\/delete-target.md", + "demo": "teams\/list-memberships.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.read", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md", "auth": { "Project": [] } @@ -64534,48 +64587,72 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "targetId", - "description": "Target ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" - } - ] - } - }, - "\/users\/{userId}\/tokens": { + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, "post": { - "summary": "Create token", - "operationId": "usersCreateToken", + "summary": "Create team membership", + "operationId": "teamsCreateMembership", "tags": [ - "users" + "teams" ], - "description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n", + "description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n", "responses": { "201": { - "description": "Token", + "description": "Membership", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/token" + "$ref": "#\/components\/schemas\/membership" } } } @@ -64583,23 +64660,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "createToken", - "group": "sessions", - "weight": 103, + "method": "createMembership", + "group": "memberships", + "weight": 525, "cookies": false, "type": "", - "demo": "users\/create-token.md", - "rate-limit": 0, + "demo": "teams\/create-membership.md", + "rate-limit": 10, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md", "auth": { "Project": [] } @@ -64607,17 +64686,18 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -64628,40 +64708,67 @@ "schema": { "type": "object", "properties": { - "length": { - "type": "integer", - "description": "Token length in characters. The default length is 6 characters", - "x-example": 4, - "format": "int32" + "email": { + "type": "string", + "description": "Email of the new team member.", + "x-example": "email@example.com", + "format": "email" }, - "expire": { - "type": "integer", - "description": "Token expiration period in seconds. The default expiration is 15 minutes.", - "x-example": 60, - "format": "int32" + "userId": { + "type": "string", + "description": "ID of the user to be added to a team.", + "x-example": "" + }, + "phone": { + "type": "string", + "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "x-example": "+12065550100", + "format": "phone" + }, + "roles": { + "type": "array", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "url": { + "type": "string", + "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "name": { + "type": "string", + "description": "Name of the new team member. Max length: 128 chars.", + "x-example": "" } - } + }, + "required": [ + "roles" + ] } } } } } }, - "\/users\/{userId}\/verification": { - "patch": { - "summary": "Update email verification", - "operationId": "usersUpdateEmailVerification", + "\/teams\/{teamId}\/memberships\/{membershipId}": { + "get": { + "summary": "Get team membership", + "operationId": "teamsGetMembership", "tags": [ - "users" + "teams" ], - "description": "Update the user email verification status by its unique ID.", + "description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.", "responses": { "200": { - "description": "User", + "description": "Membership", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/membership" } } } @@ -64669,23 +64776,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailVerification", - "group": "users", - "weight": 93, + "method": "getMembership", + "group": "memberships", + "weight": 526, "cookies": false, "type": "", - "demo": "users\/update-email-verification.md", + "demo": "teams\/get-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md", "auth": { "Project": [] } @@ -64693,57 +64802,47 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "emailVerification": { - "type": "boolean", - "description": "User email verification status.", - "x-example": false - } - }, - "required": [ - "emailVerification" - ] - } - } - } - } - } - }, - "\/users\/{userId}\/verification\/phone": { + ] + }, "patch": { - "summary": "Update phone verification", - "operationId": "usersUpdatePhoneVerification", + "summary": "Update team membership", + "operationId": "teamsUpdateMembership", "tags": [ - "users" + "teams" ], - "description": "Update the user phone verification status by its unique ID.", + "description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n", "responses": { "200": { - "description": "User", + "description": "Membership", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/membership" } } } @@ -64751,23 +64850,25 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePhoneVerification", - "group": "users", - "weight": 88, + "method": "updateMembership", + "group": "memberships", + "weight": 528, "cookies": false, "type": "", - "demo": "users\/update-phone-verification.md", + "demo": "teams\/update-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md", "auth": { "Project": [] } @@ -64775,17 +64876,28 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -64796,50 +64908,106 @@ "schema": { "type": "object", "properties": { - "phoneVerification": { - "type": "boolean", - "description": "User phone verification status.", - "x-example": false + "roles": { + "type": "array", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "phoneVerification" + "roles" ] } } } } + }, + "delete": { + "summary": "Delete team membership", + "operationId": "teamsDeleteMembership", + "tags": [ + "teams" + ], + "description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteMembership", + "group": "memberships", + "weight": 1187, + "cookies": false, + "type": "", + "demo": "teams\/delete-membership.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "teams.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "teamId", + "description": "Team ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] } }, - "\/vcs\/github\/installations\/{installationId}\/detections": { - "post": { - "summary": "Create repository detection", - "operationId": "vcsCreateRepositoryDetection", + "\/teams\/{teamId}\/memberships\/{membershipId}\/status": { + "patch": { + "summary": "Update team membership status", + "operationId": "teamsUpdateMembershipStatus", "tags": [ - "vcs" + "teams" ], - "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", + "description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n", "responses": { "200": { - "description": "DetectionRuntime, or DetectionFramework", + "description": "Membership", "content": { "application\/json": { "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/detectionRuntime" - }, - { - "$ref": "#\/components\/schemas\/detectionFramework" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "runtime": "#\/components\/schemas\/detectionRuntime", - "framework": "#\/components\/schemas\/detectionFramework" - } - } + "$ref": "#\/components\/schemas\/membership" } } } @@ -64847,39 +65015,52 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRepositoryDetection", - "group": "repositories", - "weight": 583, + "method": "updateMembershipStatus", + "group": "memberships", + "weight": 530, "cookies": false, "type": "", - "demo": "vcs\/create-repository-detection.md", + "demo": "teams\/update-membership-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", + "scope": "public", "platforms": [ - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "JWT": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -64890,31 +65071,20 @@ "schema": { "type": "object", "properties": { - "providerRepositoryId": { - "type": "string", - "description": "Repository Id", - "x-example": "" - }, - "type": { + "userId": { "type": "string", - "description": "Detector type. Must be one of the following: runtime, framework", - "x-example": "runtime", - "enum": [ - "runtime", - "framework" - ], - "x-enum-name": "VCSDetectionType", - "x-enum-keys": [] + "description": "User ID.", + "x-example": "" }, - "providerRootDirectory": { + "secret": { "type": "string", - "description": "Path to Root Directory", - "x-example": "" + "description": "Secret key.", + "x-example": "" } }, "required": [ - "providerRepositoryId", - "type" + "userId", + "secret" ] } } @@ -64922,35 +65092,21 @@ } } }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories": { + "\/teams\/{teamId}\/prefs": { "get": { - "summary": "List repositories", - "operationId": "vcsListRepositories", + "summary": "Get team preferences", + "operationId": "teamsGetPrefs", "tags": [ - "vcs" + "teams" ], - "description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.", + "description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).", "responses": { "200": { - "description": "Runtime Provider Repositories List, or Framework Provider Repositories List", + "description": "Preferences", "content": { "application\/json": { "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/providerRepositoryRuntimeList" - }, - { - "$ref": "#\/components\/schemas\/providerRepositoryFrameworkList" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "runtime": "#\/components\/schemas\/providerRepositoryRuntimeList", - "framework": "#\/components\/schemas\/providerRepositoryFrameworkList" - } - } + "$ref": "#\/components\/schemas\/preferences" } } } @@ -64958,98 +65114,61 @@ }, "deprecated": false, "x-appwrite": { - "method": "listRepositories", - "group": "repositories", - "weight": 580, + "method": "getPrefs", + "group": "teams", + "weight": 523, "cookies": false, "type": "", - "demo": "vcs\/list-repositories.md", + "demo": "teams\/get-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "teams.read", "platforms": [ - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repositories.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "JWT": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "type", - "description": "Detector type. Must be one of the following: runtime, framework", - "required": true, - "schema": { - "type": "string", - "x-example": "runtime", - "enum": [ - "runtime", - "framework" - ], - "x-enum-name": "VCSDetectionType", - "x-enum-keys": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - }, - { - "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). Only supported methods are limit and offset", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" } ] }, - "post": { - "summary": "Create repository", - "operationId": "vcsCreateRepository", + "put": { + "summary": "Update team preferences", + "operationId": "teamsUpdatePrefs", "tags": [ - "vcs" + "teams" ], - "description": "Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.", + "description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.", "responses": { "200": { - "description": "ProviderRepository", + "description": "Preferences", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/providerRepository" + "$ref": "#\/components\/schemas\/preferences" } } } @@ -65057,39 +65176,42 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRepository", - "group": "repositories", - "weight": 578, + "method": "updatePrefs", + "group": "teams", + "weight": 524, "cookies": false, "type": "", - "demo": "vcs\/create-repository.md", + "demo": "teams\/update-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", + "scope": "teams.write", "platforms": [ - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "JWT": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -65100,20 +65222,14 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Repository name (slug)", - "x-example": "" - }, - "private": { - "type": "boolean", - "description": "Mark repository public or private", - "x-example": false + "prefs": { + "type": "object", + "description": "Prefs key-value JSON object.", + "x-example": "{}" } }, "required": [ - "name", - "private" + "prefs" ] } } @@ -65121,21 +65237,21 @@ } } }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}": { + "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { "get": { - "summary": "Get repository", - "operationId": "vcsGetRepository", + "summary": "List tokens", + "operationId": "tokensList", "tags": [ - "vcs" + "tokens" ], - "description": "Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.", + "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", "responses": { "200": { - "description": "ProviderRepository", + "description": "Resource Tokens List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/providerRepository" + "$ref": "#\/components\/schemas\/resourceTokenList" } } } @@ -65143,141 +65259,93 @@ }, "deprecated": false, "x-appwrite": { - "method": "getRepository", - "group": "repositories", - "weight": 579, + "method": "list", + "group": "files", + "weight": 534, "cookies": false, "type": "", - "demo": "vcs\/get-repository.md", + "demo": "tokens\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "tokens.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "providerRepositoryId", - "description": "Repository Id", + "name": "fileId", + "description": "File unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - } - ] - } - }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches": { - "get": { - "summary": "List repository branches", - "operationId": "vcsListRepositoryBranches", - "tags": [ - "vcs" - ], - "description": "Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n", - "responses": { - "200": { - "description": "Branches List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/branchList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listRepositoryBranches", - "group": "repositories", - "weight": 581, - "cookies": false, - "type": "", - "demo": "vcs\/list-repository-branches.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repository-branches.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ + }, { - "name": "installationId", - "description": "Installation Id", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "providerRepositoryId", - "description": "Repository Id", - "required": true, + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "boolean", + "x-example": false, + "default": true }, - "in": "path" + "in": "query" } ] - } - }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents": { - "get": { - "summary": "Get files and directories of a VCS repository", - "operationId": "vcsGetRepositoryContents", + }, + "post": { + "summary": "Create file token", + "operationId": "tokensCreateFileToken", "tags": [ - "vcs" + "tokens" ], - "description": "Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", + "description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.", "responses": { - "200": { - "description": "VCS Content List", + "201": { + "description": "ResourceToken", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/vcsContentList" + "$ref": "#\/components\/schemas\/resourceToken" } } } @@ -65285,135 +65353,50 @@ }, "deprecated": false, "x-appwrite": { - "method": "getRepositoryContents", - "group": "repositories", - "weight": 582, - "cookies": false, - "type": "", - "demo": "vcs\/get-repository-contents.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository-contents.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "installationId", - "description": "Installation Id", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "providerRepositoryId", - "description": "Repository Id", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "providerRootDirectory", - "description": "Path to get contents of nested directory", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - }, - { - "name": "providerReference", - "description": "Git reference (branch, tag, commit) to get contents from", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - } - ] - } - }, - "\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": { - "patch": { - "summary": "Update external deployment (authorize)", - "operationId": "vcsUpdateExternalDeployments", - "tags": [ - "vcs" - ], - "description": "Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateExternalDeployments", - "group": "repositories", - "weight": 1084, + "method": "createFileToken", + "group": "files", + "weight": 532, "cookies": false, "type": "", - "demo": "vcs\/update-external-deployments.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", + "demo": "tokens\/create-file-token.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/update-external-deployments.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "repositoryId", - "description": "VCS Repository Id", + "name": "fileId", + "description": "File unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -65424,36 +65407,35 @@ "schema": { "type": "object", "properties": { - "providerPullRequestId": { + "expire": { "type": "string", - "description": "GitHub Pull Request Id", - "x-example": "" + "description": "Token expiry date", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } - }, - "required": [ - "providerPullRequestId" - ] + } } } } } } }, - "\/vcs\/installations": { + "\/tokens\/{tokenId}": { "get": { - "summary": "List installations", - "operationId": "vcsListInstallations", + "summary": "Get token", + "operationId": "tokensGet", "tags": [ - "vcs" + "tokens" ], - "description": "List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.\n", + "description": "Get a token by its unique ID.", "responses": { "200": { - "description": "Installations List", + "description": "ResourceToken", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/installationList" + "$ref": "#\/components\/schemas\/resourceToken" } } } @@ -65461,85 +65443,59 @@ }, "deprecated": false, "x-appwrite": { - "method": "listInstallations", - "group": "installations", - "weight": 576, + "method": "get", + "group": "tokens", + "weight": 533, "cookies": false, "type": "", - "demo": "vcs\/list-installations.md", + "demo": "tokens\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "tokens.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "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: provider, organization", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tokenId", + "description": "Token ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true + "x-example": "" }, - "in": "query" + "in": "path" } ] - } - }, - "\/vcs\/installations\/{installationId}": { - "get": { - "summary": "Get installation", - "operationId": "vcsGetInstallation", + }, + "patch": { + "summary": "Update token", + "operationId": "tokensUpdate", "tags": [ - "vcs" + "tokens" ], - "description": "Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. ", + "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", "responses": { "200": { - "description": "Installation", + "description": "ResourceToken", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/installation" + "$ref": "#\/components\/schemas\/resourceToken" } } } @@ -65547,51 +65503,70 @@ }, "deprecated": false, "x-appwrite": { - "method": "getInstallation", - "group": "installations", - "weight": 575, + "method": "update", + "group": "tokens", + "weight": 535, "cookies": false, "type": "", - "demo": "vcs\/get-installation.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "demo": "tokens\/update.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", + "name": "tokenId", + "description": "Token unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "expire": { + "type": "string", + "description": "File token expiry date", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + } + } + } + } + } + } }, "delete": { - "summary": "Delete installation", - "operationId": "vcsDeleteInstallation", + "summary": "Delete token", + "operationId": "tokensDelete", "tags": [ - "vcs" + "tokens" ], - "description": "Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.", + "description": "Delete a token by its unique ID.", "responses": { "204": { "description": "No content" @@ -65599,60 +65574,61 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteInstallation", - "group": "installations", - "weight": 577, + "method": "delete", + "group": "tokens", + "weight": 536, "cookies": false, "type": "", - "demo": "vcs\/delete-installation.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", + "demo": "tokens\/delete.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", + "name": "tokenId", + "description": "Token ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/vectorsdb": { + "\/users": { "get": { - "summary": "List databases", - "operationId": "vectorsDBList", + "summary": "List users", + "operationId": "usersList", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "Get a list of all the project's users. You can use the query params to filter your results.", "responses": { "200": { - "description": "Databases List", + "description": "Users List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/databaseList" + "$ref": "#\/components\/schemas\/userList" } } } @@ -65661,22 +65637,22 @@ "deprecated": false, "x-appwrite": { "method": "list", - "group": "vectorsdb", - "weight": 816, + "group": "users", + "weight": 71, "cookies": false, "type": "", - "demo": "vectorsdb\/list.md", + "demo": "users\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md", "auth": { "Project": [] } @@ -65690,7 +65666,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name", + "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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator", "required": false, "schema": { "type": "array", @@ -65726,19 +65702,19 @@ ] }, "post": { - "summary": "Create database", - "operationId": "vectorsDBCreate", + "summary": "Create user", + "operationId": "usersCreate", "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Database.\n", + "description": "Create a new user.", "responses": { "201": { - "description": "Database", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/user" } } } @@ -65747,22 +65723,22 @@ "deprecated": false, "x-appwrite": { "method": "create", - "group": "vectorsdb", - "weight": 812, + "group": "users", + "weight": 62, "cookies": false, "type": "", - "demo": "vectorsdb\/create.md", + "demo": "users\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md", "auth": { "Project": [] } @@ -65779,25 +65755,38 @@ "schema": { "type": "object", "properties": { - "databaseId": { + "userId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "phone": { + "type": "string", + "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "x-example": "+12065550100", + "format": "phone", + "x-nullable": true + }, + "password": { + "type": "string", + "description": "Plain text user password. Must be at least 8 chars.", + "x-example": null }, "name": { "type": "string", - "description": "Database name. Max length: 128 chars.", + "description": "User name. Max length: 128 chars.", "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "x-example": false } }, "required": [ - "databaseId", - "name" + "userId" ] } } @@ -65805,21 +65794,21 @@ } } }, - "\/vectorsdb\/embeddings\/text": { + "\/users\/argon2": { "post": { - "summary": "Create Text Embeddings", - "operationId": "vectorsDBCreateTextEmbeddings", + "summary": "Create user with Argon2 password", + "operationId": "usersCreateArgon2User", "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Embedding list", + "201": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/embeddingList" + "$ref": "#\/components\/schemas\/user" } } } @@ -65827,50 +65816,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTextEmbeddings", - "group": "documents", - "weight": 838, + "method": "createArgon2User", + "group": "users", + "weight": 65, "cookies": false, "type": "", - "demo": "vectorsdb\/create-text-embeddings.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/create-argon-2-user.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", - "methods": [ - { - "name": "createTextEmbeddings", - "namespace": "vectorsDB", - "desc": "Create Text Embedding", - "auth": { - "Project": [] - }, - "parameters": [ - "texts", - "model" - ], - "required": [ - "texts" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/embeddingList" - } - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-text-embeddings.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md", "auth": { "Project": [] } @@ -65878,8 +65840,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "requestBody": { @@ -65888,27 +65849,33 @@ "schema": { "type": "object", "properties": { - "texts": { - "type": "array", - "description": "Array of text to generate embeddings.", - "x-example": null, - "items": { - "type": "string" - } + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "model": { + "email": { "type": "string", - "description": "The embedding model to use for generating vector embeddings.", - "x-example": "embeddinggemma", - "enum": [ - "embeddinggemma" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Argon2.", + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" } }, "required": [ - "texts" + "userId", + "email", + "password" ] } } @@ -65916,21 +65883,21 @@ } } }, - "\/vectorsdb\/transactions": { - "get": { - "summary": "List transactions", - "operationId": "vectorsDBListTransactions", + "\/users\/bcrypt": { + "post": { + "summary": "Create user with bcrypt password", + "operationId": "usersCreateBcryptUser", "tags": [ - "vectorsDB" + "users" ], - "description": "List transactions across all databases.", + "description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Transaction List", + "201": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transactionList" + "$ref": "#\/components\/schemas\/user" } } } @@ -65938,25 +65905,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 843, + "method": "createBcryptUser", + "group": "users", + "weight": 63, "cookies": false, "type": "", - "demo": "vectorsdb\/list-transactions.md", + "demo": "users\/create-bcrypt-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-transactions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md", "auth": { "Project": [] } @@ -65964,40 +65929,64 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], - "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).", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Bcrypt.", + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } + } } - ] - }, - "post": { - "summary": "Create transaction", - "operationId": "vectorsDBCreateTransaction", + } + } + }, + "\/users\/identities": { + "get": { + "summary": "List identities", + "operationId": "usersListIdentities", "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new transaction.", + "description": "Get identities for all users.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "Identities List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/identityList" } } } @@ -66005,25 +65994,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 839, + "method": "listIdentities", + "group": "identities", + "weight": 79, "cookies": false, "type": "", - "demo": "vectorsdb\/create-transaction.md", + "demo": "users\/list-identities.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.read", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md", "auth": { "Project": [] } @@ -66031,70 +66018,80 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "x-example": 60, - "format": "int32" - } - } - } - } + "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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } + ] } }, - "\/vectorsdb\/transactions\/{transactionId}": { - "get": { - "summary": "Get transaction", - "operationId": "vectorsDBGetTransaction", + "\/users\/identities\/{identityId}": { + "delete": { + "summary": "Delete identity", + "operationId": "usersDeleteIdentity", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a transaction by its unique ID.", + "description": "Delete an identity by its unique ID.", "responses": { - "200": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 840, + "method": "deleteIdentity", + "group": "identities", + "weight": 103, "cookies": false, "type": "", - "demo": "vectorsdb\/get-transaction.md", + "demo": "users\/delete-identity.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md", "auth": { "Project": [] } @@ -66102,37 +66099,38 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "identityId", + "description": "Identity ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "vectorsDBUpdateTransaction", + } + }, + "\/users\/md5": { + "post": { + "summary": "Create user with MD5 password", + "operationId": "usersCreateMD5User", "tags": [ - "vectorsDB" + "users" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Transaction", + "201": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/user" } } } @@ -66140,25 +66138,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 841, + "method": "createMD5User", + "group": "users", + "weight": 64, "cookies": false, "type": "", - "demo": "vectorsdb\/update-transaction.md", + "demo": "users\/create-md-5-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md", "auth": { "Project": [] } @@ -66166,20 +66162,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Key": [] } ], "requestBody": { @@ -66188,55 +66171,79 @@ "schema": { "type": "object", "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "x-example": false + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "x-example": false + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using MD5.", + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" } - } + }, + "required": [ + "userId", + "email", + "password" + ] } } } } - }, - "delete": { - "summary": "Delete transaction", - "operationId": "vectorsDBDeleteTransaction", + } + }, + "\/users\/phpass": { + "post": { + "summary": "Create user with PHPass password", + "operationId": "usersCreatePHPassUser", "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a transaction by its unique ID.", + "description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 842, + "method": "createPHPassUser", + "group": "users", + "weight": 67, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-transaction.md", + "demo": "users\/create-ph-pass-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md", "auth": { "Project": [] } @@ -66244,39 +66251,64 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/vectorsdb\/transactions\/{transactionId}\/operations": { + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using PHPass.", + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } + } + } + } + } + }, + "\/users\/scrypt": { "post": { - "summary": "Create operations", - "operationId": "vectorsDBCreateOperations", + "summary": "Create user with Scrypt password", + "operationId": "usersCreateScryptUser", "tags": [ - "vectorsDB" + "users" ], - "description": "Create multiple operations in a single transaction.", + "description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { "201": { - "description": "Transaction", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/user" } } } @@ -66284,25 +66316,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 844, + "method": "createScryptUser", + "group": "users", + "weight": 68, "cookies": false, "type": "", - "demo": "vectorsdb\/create-operations.md", + "demo": "users\/create-scrypt-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md", "auth": { "Project": [] } @@ -66310,20 +66340,130 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], - "parameters": [ + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Scrypt.", + "x-example": "password", + "format": "password" + }, + "passwordSalt": { + "type": "string", + "description": "Optional salt used to hash password.", + "x-example": "" + }, + "passwordCpu": { + "type": "integer", + "description": "Optional CPU cost used to hash password.", + "x-example": null, + "format": "int32" + }, + "passwordMemory": { + "type": "integer", + "description": "Optional memory cost used to hash password.", + "x-example": null, + "format": "int32" + }, + "passwordParallel": { + "type": "integer", + "description": "Optional parallelization cost used to hash password.", + "x-example": null, + "format": "int32" + }, + "passwordLength": { + "type": "integer", + "description": "Optional hash length used to hash password.", + "x-example": null, + "format": "int32" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password", + "passwordSalt", + "passwordCpu", + "passwordMemory", + "passwordParallel", + "passwordLength" + ] + } + } + } + } + } + }, + "\/users\/scrypt-modified": { + "post": { + "summary": "Create user with Scrypt modified password", + "operationId": "usersCreateScryptModifiedUser", + "tags": [ + "users" + ], + "description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "responses": { + "201": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createScryptModifiedUser", + "group": "users", + "weight": 69, + "cookies": false, + "type": "", + "demo": "users\/create-scrypt-modified-user.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Project": [], + "Key": [] } ], "requestBody": { @@ -66332,36 +66472,182 @@ "schema": { "type": "object", "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Scrypt Modified.", + "x-example": "password", + "format": "password" + }, + "passwordSalt": { + "type": "string", + "description": "Salt used to hash password.", + "x-example": "" + }, + "passwordSaltSeparator": { + "type": "string", + "description": "Salt separator used to hash password.", + "x-example": "" + }, + "passwordSignerKey": { + "type": "string", + "description": "Signer key used to hash password.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" } + }, + "required": [ + "userId", + "email", + "password", + "passwordSalt", + "passwordSaltSeparator", + "passwordSignerKey" + ] + } + } + } + } + } + }, + "\/users\/sha": { + "post": { + "summary": "Create user with SHA password", + "operationId": "usersCreateSHAUser", + "tags": [ + "users" + ], + "description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "responses": { + "201": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" } } } } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSHAUser", + "group": "users", + "weight": 66, + "cookies": false, + "type": "", + "demo": "users\/create-sha-user.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using SHA.", + "x-example": "password", + "format": "password" + }, + "passwordVersion": { + "type": "string", + "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", + "x-example": "sha1", + "enum": [ + "sha1", + "sha224", + "sha256", + "sha384", + "sha512\/224", + "sha512\/256", + "sha512", + "sha3-224", + "sha3-256", + "sha3-384", + "sha3-512" + ], + "x-enum-name": "PasswordHash", + "x-enum-keys": [] + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } + } + } } } }, - "\/vectorsdb\/usage": { + "\/users\/usage": { "get": { - "summary": "Get VectorsDB usage stats", - "operationId": "vectorsDBListUsage", + "summary": "Get users usage stats", + "operationId": "usersGetUsage", "tags": [ - "vectorsDB" + "users" ], - "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", "responses": { "200": { - "description": "UsageVectorsDBs", + "description": "UsageUsers", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageVectorsDBs" + "$ref": "#\/components\/schemas\/usageUsers" } } } @@ -66369,45 +66655,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listUsage", + "method": "getUsage", "group": null, - "weight": 818, + "weight": 105, "cookies": false, "type": "", - "demo": "vectorsdb\/list-usage.md", + "demo": "users\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-usage.md", - "methods": [ - { - "name": "listUsage", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "range" - ], - "required": [], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/usageVectorsDBs" - } - ], - "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", - "demo": "vectorsdb\/list-usage.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-usage.md", "auth": { "Project": [] } @@ -66443,21 +66706,21 @@ ] } }, - "\/vectorsdb\/{databaseId}": { + "\/users\/{userId}": { "get": { - "summary": "Get database", - "operationId": "vectorsDBGet", + "summary": "Get user", + "operationId": "usersGet", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "description": "Get a user by its unique ID.", "responses": { "200": { - "description": "Database", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/user" } } } @@ -66466,22 +66729,22 @@ "deprecated": false, "x-appwrite": { "method": "get", - "group": "vectorsdb", - "weight": 813, + "group": "users", + "weight": 72, "cookies": false, "type": "", - "demo": "vectorsdb\/get.md", + "demo": "users\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md", "auth": { "Project": [] } @@ -66494,55 +66757,48 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, - "put": { - "summary": "Update database", - "operationId": "vectorsDBUpdate", + "delete": { + "summary": "Delete user", + "operationId": "usersDelete", "tags": [ - "vectorsDB" + "users" ], - "description": "Update a database by its unique ID.", + "description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.", "responses": { - "200": { - "description": "Database", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/database" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "vectorsdb", - "weight": 814, + "method": "delete", + "group": "users", + "weight": 101, "cookies": false, "type": "", - "demo": "vectorsdb\/update.md", + "demo": "users\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md", "auth": { "Project": [] } @@ -66555,72 +66811,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } + ] + } + }, + "\/users\/{userId}\/email": { + "patch": { + "summary": "Update email", + "operationId": "usersUpdateEmail", + "tags": [ + "users" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "x-example": false - } - }, - "required": [ - "name" - ] + "description": "Update the user email by its unique ID.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } } } } - } - }, - "delete": { - "summary": "Delete database", - "operationId": "vectorsDBDelete", - "tags": [ - "vectorsDB" - ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", - "responses": { - "204": { - "description": "No content" - } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "vectorsdb", - "weight": 815, + "method": "updateEmail", + "group": "users", + "weight": 86, "cookies": false, "type": "", - "demo": "vectorsdb\/delete.md", + "demo": "users\/update-email.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md", "auth": { "Project": [] } @@ -66633,129 +66874,53 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] - } - }, - "\/vectorsdb\/{databaseId}\/collections": { - "get": { - "summary": "List collections", - "operationId": "vectorsDBListCollections", - "tags": [ - "vectorsDB" ], - "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", - "responses": { - "200": { - "description": "VectorsDB Collections List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/vectorsdbCollectionList" - } + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + } + }, + "required": [ + "email" + ] } } } - }, - "deprecated": false, - "x-appwrite": { - "method": "listCollections", - "group": "collections", - "weight": 823, - "cookies": false, - "type": "", - "demo": "vectorsdb\/list-collections.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-collections.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create collection", - "operationId": "vectorsDBCreateCollection", + } + } + }, + "\/users\/{userId}\/impersonator": { + "patch": { + "summary": "Update user impersonator capability", + "operationId": "usersUpdateImpersonator", "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.\n", "responses": { - "201": { - "description": "VectorsDB Collection", + "200": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/vectorsdbCollection" + "$ref": "#\/components\/schemas\/user" } } } @@ -66763,23 +66928,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createCollection", - "group": "collections", - "weight": 819, + "method": "updateImpersonator", + "group": "users", + "weight": 82, "cookies": false, "type": "", - "demo": "vectorsdb\/create-collection.md", + "demo": "users\/update-impersonator.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-impersonator.md", "auth": { "Project": [] } @@ -66792,12 +66957,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -66808,45 +66973,14 @@ "schema": { "type": "object", "properties": { - "collectionId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Collection name. Max length: 128 chars.", - "x-example": "" - }, - "dimension": { - "type": "integer", - "description": "Embedding dimension.", - "x-example": 1, - "format": "int32" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documentSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false - }, - "enabled": { + "impersonator": { "type": "boolean", - "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", "x-example": false } }, "required": [ - "collectionId", - "name", - "dimension" + "impersonator" ] } } @@ -66854,21 +66988,21 @@ } } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}": { - "get": { - "summary": "Get collection", - "operationId": "vectorsDBGetCollection", + "\/users\/{userId}\/jwts": { + "post": { + "summary": "Create user JWT", + "operationId": "usersCreateJWT", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.", "responses": { - "200": { - "description": "VectorsDB Collection", + "201": { + "description": "JWT", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/vectorsdbCollection" + "$ref": "#\/components\/schemas\/jwt" } } } @@ -66876,23 +67010,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "getCollection", - "group": "collections", - "weight": 820, + "method": "createJWT", + "group": "sessions", + "weight": 104, "cookies": false, "type": "", - "demo": "vectorsdb\/get-collection.md", + "demo": "users\/create-jwt.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md", "auth": { "Project": [] } @@ -66905,41 +67039,55 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "sessionId": { + "type": "string", + "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", + "x-example": "" + }, + "duration": { + "type": "integer", + "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", + "x-example": 0, + "format": "int32" + } + } + } + } + } + } + } + }, + "\/users\/{userId}\/labels": { "put": { - "summary": "Update collection", - "operationId": "vectorsDBUpdateCollection", + "summary": "Update user labels", + "operationId": "usersUpdateLabels", "tags": [ - "vectorsDB" + "users" ], - "description": "Update a collection by its unique ID.", + "description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.", "responses": { "200": { - "description": "VectorsDB Collection", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/vectorsdbCollection" + "$ref": "#\/components\/schemas\/user" } } } @@ -66947,23 +67095,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateCollection", - "group": "collections", - "weight": 821, + "method": "updateLabels", + "group": "users", + "weight": 81, "cookies": false, "type": "", - "demo": "vectorsdb\/update-collection.md", + "demo": "users\/update-labels.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md", "auth": { "Project": [] } @@ -66976,22 +67124,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -67002,75 +67140,63 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Collection name. Max length: 128 chars.", - "x-example": "" - }, - "dimension": { - "type": "integer", - "description": "Embedding dimensions.", - "x-example": 1, - "format": "int32" - }, - "permissions": { + "labels": { "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "x-example": null, "items": { "type": "string" } - }, - "documentSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", - "x-example": false } }, "required": [ - "name" + "labels" ] } } } } - }, - "delete": { - "summary": "Delete collection", - "operationId": "vectorsDBDeleteCollection", + } + }, + "\/users\/{userId}\/logs": { + "get": { + "summary": "List user logs", + "operationId": "usersListLogs", "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Get the user activity logs list by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Logs List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/logList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteCollection", - "group": "collections", - "weight": 822, + "method": "listLogs", + "group": "logs", + "weight": 77, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-collection.md", + "demo": "users\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md", "auth": { "Project": [] } @@ -67083,43 +67209,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "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", + "x-example": false, + "default": true + }, + "in": "query" } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "\/users\/{userId}\/memberships": { "get": { - "summary": "List documents", - "operationId": "vectorsDBListDocuments", + "summary": "List user memberships", + "operationId": "usersListMemberships", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Get the user membership list by its unique ID.", "responses": { "200": { - "description": "Documents List", + "description": "Memberships List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/membershipList" } } } @@ -67127,25 +67267,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "listDocuments", - "group": "documents", - "weight": 833, + "method": "listMemberships", + "group": "memberships", + "weight": 76, "cookies": false, "type": "", - "demo": "vectorsdb\/list-documents.md", + "demo": "users\/list-memberships.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.read", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md", "auth": { "Project": [] } @@ -67153,34 +67291,23 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "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: userId, teamId, invited, joined, confirm, roles", "required": false, "schema": { "type": "array", @@ -67192,12 +67319,13 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, "in": "query" }, @@ -67211,117 +67339,106 @@ "default": true }, "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" } ] - }, - "post": { - "summary": "Create document", - "operationId": "vectorsDBCreateDocument", + } + }, + "\/users\/{userId}\/mfa": { + "patch": { + "summary": "Update MFA", + "operationId": "usersUpdateMfa", "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Enable or disable MFA on a user account.", "responses": { - "201": { - "description": "Document", + "200": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/user" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createDocument", - "group": "documents", - "weight": 829, + "method": "updateMfa", + "group": "users", + "weight": 91, "cookies": false, "type": "", - "demo": "vectorsdb\/create-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-mfa.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFA" + }, "methods": [ { - "name": "createDocument", - "namespace": "vectorsDB", - "desc": "Create document", + "name": "updateMfa", + "namespace": "users", + "desc": "", "auth": { "Project": [] }, "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions" + "userId", + "mfa" ], "required": [ - "databaseId", - "collectionId", - "documentId", - "data" + "userId", + "mfa" ], "responses": [ { - "code": 201, - "model": "#\/components\/schemas\/document" + "code": 200, + "model": "#\/components\/schemas\/user" } ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-document.md", - "public": true + "description": "Enable or disable MFA on a user account.", + "demo": "users\/update-mfa.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFA" + } }, { - "name": "createDocuments", - "namespace": "vectorsDB", - "desc": "Create documents", + "name": "updateMFA", + "namespace": "users", + "desc": "", "auth": { "Project": [] }, "parameters": [ - "databaseId", - "collectionId", - "documents" + "userId", + "mfa" ], "required": [ - "databaseId", - "collectionId", - "documents" + "userId", + "mfa" ], "responses": [ { - "code": 201, - "model": "#\/components\/schemas\/documentList" + "code": 200, + "model": "#\/components\/schemas\/user" } ], - "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-documents.md", + "description": "Enable or disable MFA on a user account.", + "demo": "users\/update-mfa.md", "public": true } ], @@ -67332,28 +67449,17 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -67364,108 +67470,108 @@ "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" + "mfa": { + "type": "boolean", + "description": "Enable or disable MFA.", + "x-example": false } - } + }, + "required": [ + "mfa" + ] } } } } - }, - "put": { - "summary": "Upsert documents", - "operationId": "vectorsDBUpsertDocuments", + } + }, + "\/users\/{userId}\/mfa\/authenticators\/{type}": { + "delete": { + "summary": "Delete authenticator", + "operationId": "usersDeleteMfaAuthenticator", "tags": [ - "vectorsDB" + "users" ], - "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "description": "Delete an authenticator app.", "responses": { - "201": { - "description": "Documents List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/documentList" - } - } - } + "204": { + "description": "No content" } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "upsertDocuments", - "group": "documents", - "weight": 836, + "method": "deleteMfaAuthenticator", + "group": "mfa", + "weight": 96, "cookies": false, "type": "", - "demo": "vectorsdb\/upsert-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/delete-mfa-authenticator.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-documents.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.deleteMFAAuthenticator" + }, "methods": [ { - "name": "upsertDocuments", - "namespace": "vectorsDB", + "name": "deleteMfaAuthenticator", + "namespace": "users", "desc": "", "auth": { "Project": [] }, "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" + "userId", + "type" ], "required": [ - "databaseId", - "collectionId", - "documents" + "userId", + "type" ], "responses": [ { - "code": 201, - "model": "#\/components\/schemas\/documentList" + "code": 204 } ], - "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", - "demo": "vectorsdb\/upsert-documents.md", + "description": "Delete an authenticator app.", + "demo": "users\/delete-mfa-authenticator.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.deleteMFAAuthenticator" + } + }, + { + "name": "deleteMFAAuthenticator", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId", + "type" + ], + "required": [ + "userId", + "type" + ], + "responses": [ + { + "code": 204 + } + ], + "description": "Delete an authenticator app.", + "demo": "users\/delete-mfa-authenticator.md", "public": true } ], @@ -67481,92 +67587,128 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "type", + "description": "Type of authenticator.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "totp", + "enum": [ + "totp" + ], + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [] }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - }, - "required": [ - "documents" - ] - } - } - } - } - }, - "patch": { - "summary": "Update documents", - "operationId": "vectorsDBUpdateDocuments", + ] + } + }, + "\/users\/{userId}\/mfa\/factors": { + "get": { + "summary": "List factors", + "operationId": "usersListMfaFactors", "tags": [ - "vectorsDB" + "users" ], - "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "description": "List the factors available on the account to be used as a MFA challange.", "responses": { "200": { - "description": "Documents List", + "description": "MFAFactors", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/mfaFactors" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateDocuments", - "group": "documents", - "weight": 835, + "method": "listMfaFactors", + "group": "mfa", + "weight": 92, "cookies": false, "type": "", - "demo": "vectorsdb\/update-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/list-mfa-factors.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-documents.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.listMFAFactors" + }, + "methods": [ + { + "name": "listMfaFactors", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaFactors" + } + ], + "description": "List the factors available on the account to be used as a MFA challange.", + "demo": "users\/list-mfa-factors.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.listMFAFactors" + } + }, + { + "name": "listMFAFactors", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaFactors" + } + ], + "description": "List the factors available on the account to be used as a MFA challange.", + "demo": "users\/list-mfa-factors.md", + "public": true + } + ], "auth": { "Project": [] } @@ -67579,193 +67721,230 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "x-example": "{}" - }, - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete documents", - "operationId": "vectorsDBDeleteDocuments", + ] + } + }, + "\/users\/{userId}\/mfa\/recovery-codes": { + "get": { + "summary": "Get MFA recovery codes", + "operationId": "usersGetMfaRecoveryCodes", "tags": [ - "vectorsDB" + "users" ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", "responses": { "200": { - "description": "Documents List", + "description": "MFA Recovery Codes", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/mfaRecoveryCodes" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteDocuments", - "group": "documents", - "weight": 837, + "method": "getMfaRecoveryCodes", + "group": "mfa", + "weight": 93, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-documents.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/get-mfa-recovery-codes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-documents.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.getMFARecoveryCodes" }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } + "methods": [ + { + "name": "getMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaRecoveryCodes" } + ], + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/get-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.getMFARecoveryCodes" } + }, + { + "name": "getMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/get-mfa-recovery-codes.md", + "public": true } + ], + "auth": { + "Project": [] } - } - } - }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "vectorsDBGetDocument", + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update MFA recovery codes (regenerate)", + "operationId": "usersUpdateMfaRecoveryCodes", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", "responses": { "200": { - "description": "Document", + "description": "MFA Recovery Codes", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/mfaRecoveryCodes" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "getDocument", - "group": "documents", - "weight": 832, + "method": "updateMfaRecoveryCodes", + "group": "mfa", + "weight": 95, "cookies": false, "type": "", - "demo": "vectorsdb\/get-document.md", + "demo": "users\/update-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-document.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFARecoveryCodes" + }, + "methods": [ + { + "name": "updateMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/update-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFARecoveryCodes" + } + }, + { + "name": "updateMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/update-mfa-recovery-codes.md", + "public": false + } + ], "auth": { "Project": [] } @@ -67773,135 +67952,113 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" } ] }, - "put": { - "summary": "Upsert a document", - "operationId": "vectorsDBUpsertDocument", + "patch": { + "summary": "Create MFA recovery codes", + "operationId": "usersCreateMfaRecoveryCodes", "tags": [ - "vectorsDB" + "users" ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", "responses": { "201": { - "description": "Document", + "description": "MFA Recovery Codes", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/mfaRecoveryCodes" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "upsertDocument", - "group": "documents", - "weight": 831, + "method": "createMfaRecoveryCodes", + "group": "mfa", + "weight": 94, "cookies": false, "type": "", - "demo": "vectorsdb\/upsert-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/create-mfa-recovery-codes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-document.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.createMFARecoveryCodes" + }, "methods": [ { - "name": "upsertDocument", - "namespace": "vectorsDB", + "name": "createMfaRecoveryCodes", + "namespace": "users", "desc": "", "auth": { "Project": [] }, "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" + "userId" ], "required": [ - "databaseId", - "collectionId", - "documentId" + "userId" ], "responses": [ { "code": 201, - "model": "#\/components\/schemas\/document" + "model": "#\/components\/schemas\/mfaRecoveryCodes" } ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/upsert-document.md", + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "demo": "users\/create-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.createMFARecoveryCodes" + } + }, + { + "name": "createMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "demo": "users\/create-mfa-recovery-codes.md", "public": true } ], @@ -67912,38 +68069,80 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, + } + ] + } + }, + "\/users\/{userId}\/name": { + "patch": { + "summary": "Update name", + "operationId": "usersUpdateName", + "tags": [ + "users" + ], + "description": "Update the user name by its unique ID.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateName", + "group": "users", + "weight": 84, + "cookies": false, + "type": "", + "demo": "users\/update-name.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, + "Project": [], + "Key": [] + } + ], + "parameters": [ { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -67954,44 +68153,36 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { + "name": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" + "description": "User name. Max length: 128 chars.", + "x-example": "" } - } + }, + "required": [ + "name" + ] } } } } - }, + } + }, + "\/users\/{userId}\/password": { "patch": { - "summary": "Update document", - "operationId": "vectorsDBUpdateDocument", + "summary": "Update password", + "operationId": "usersUpdatePassword", "tags": [ - "vectorsDB" + "users" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Update the user password by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/user" } } } @@ -67999,25 +68190,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDocument", - "group": "documents", - "weight": 830, + "method": "updatePassword", + "group": "users", + "weight": 85, "cookies": false, "type": "", - "demo": "vectorsdb\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-password.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md", "auth": { "Project": [] } @@ -68025,38 +68214,17 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -68067,63 +68235,60 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { + "password": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" + "description": "New user password. Must be at least 8 chars.", + "x-example": null } - } - } + }, + "required": [ + "password" + ] + } } } } - }, - "delete": { - "summary": "Delete document", - "operationId": "vectorsDBDeleteDocument", + } + }, + "\/users\/{userId}\/phone": { + "patch": { + "summary": "Update phone", + "operationId": "usersUpdatePhone", "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a document by its unique ID.", + "description": "Update the user phone by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", - "weight": 834, + "method": "updatePhone", + "group": "users", + "weight": 87, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-phone.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md", "auth": { "Project": [] } @@ -68131,38 +68296,17 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -68173,33 +68317,37 @@ "schema": { "type": "object", "properties": { - "transactionId": { + "number": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" + "description": "User phone number.", + "x-example": "+12065550100", + "format": "phone" } - } + }, + "required": [ + "number" + ] } } } } } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "\/users\/{userId}\/prefs": { "get": { - "summary": "List indexes", - "operationId": "vectorsDBListIndexes", + "summary": "Get user preferences", + "operationId": "usersGetPrefs", "tags": [ - "vectorsDB" + "users" ], - "description": "List indexes in the collection.", + "description": "Get the user preferences by its unique ID.", "responses": { "200": { - "description": "Indexes List", + "description": "Preferences", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/indexList" + "$ref": "#\/components\/schemas\/preferences" } } } @@ -68207,23 +68355,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 828, + "method": "getPrefs", + "group": "users", + "weight": 73, "cookies": false, "type": "", - "demo": "vectorsdb\/list-indexes.md", + "demo": "users\/get-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md", "auth": { "Project": [] } @@ -68236,65 +68384,31 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", - "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", - "x-example": false, - "default": true - }, - "in": "query" } ] }, - "post": { - "summary": "Create index", - "operationId": "vectorsDBCreateIndex", + "patch": { + "summary": "Update user preferences", + "operationId": "usersUpdatePrefs", "tags": [ - "vectorsDB" + "users" ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.", "responses": { - "202": { - "description": "Index", + "200": { + "description": "Preferences", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/preferences" } } } @@ -68302,23 +68416,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 825, + "method": "updatePrefs", + "group": "users", + "weight": 89, "cookies": false, "type": "", - "demo": "vectorsdb\/create-index.md", + "demo": "users\/update-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md", "auth": { "Project": [] } @@ -68331,22 +68445,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -68357,61 +68461,14 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Index Key.", - "x-example": null - }, - "type": { - "type": "string", - "description": "Index type.", - "x-example": "hnsw_euclidean", - "enum": [ - "hnsw_euclidean", - "hnsw_dot", - "hnsw_cosine", - "object", - "key", - "unique" - ], - "x-enum-name": "VectorsDBIndexType", - "x-enum-keys": [] - }, - "attributes": { - "type": "array", - "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } - }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "x-example": null, - "items": { - "type": "integer" - } + "prefs": { + "type": "object", + "description": "Prefs key-value JSON object.", + "x-example": "{}" } }, "required": [ - "key", - "type", - "attributes" + "prefs" ] } } @@ -68419,21 +68476,21 @@ } } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "\/users\/{userId}\/sessions": { "get": { - "summary": "Get index", - "operationId": "vectorsDBGetIndex", + "summary": "List user sessions", + "operationId": "usersListSessions", "tags": [ - "vectorsDB" + "users" ], - "description": "Get index by ID.", + "description": "Get the user sessions list by its unique ID.", "responses": { "200": { - "description": "Index", + "description": "Sessions List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/sessionList" } } } @@ -68441,23 +68498,26 @@ }, "deprecated": false, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 826, + "method": "listSessions", + "group": "sessions", + "weight": 75, "cookies": false, "type": "", - "demo": "vectorsdb\/get-index.md", + "demo": "users\/list-sessions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": [ + "users.read", + "sessions.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md", "auth": { "Project": [] } @@ -68470,43 +68530,99 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "boolean", + "x-example": false, + "default": true }, - "in": "path" - }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create session", + "operationId": "usersCreateSession", + "tags": [ + "users" + ], + "description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.", + "responses": { + "201": { + "description": "Session", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/session" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSession", + "group": "sessions", + "weight": 97, + "cookies": false, + "type": "", + "demo": "users\/create-session.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "key", - "description": "Index Key.", + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" }, "in": "path" } ] }, "delete": { - "summary": "Delete index", - "operationId": "vectorsDBDeleteIndex", + "summary": "Delete user sessions", + "operationId": "usersDeleteSessions", "tags": [ - "vectorsDB" + "users" ], - "description": "Delete an index.", + "description": "Delete all user's sessions by using the user's unique ID.", "responses": { "204": { "description": "No content" @@ -68514,23 +68630,26 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 827, + "method": "deleteSessions", + "group": "sessions", + "weight": 100, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-index.md", + "demo": "users\/delete-sessions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": [ + "users.write", + "sessions.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md", "auth": { "Project": [] } @@ -68543,145 +68662,102 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/usage": { - "get": { - "summary": "Get collection usage stats", - "operationId": "vectorsDBGetCollectionUsage", + "\/users\/{userId}\/sessions\/{sessionId}": { + "delete": { + "summary": "Delete user session", + "operationId": "usersDeleteSession", "tags": [ - "vectorsDB" + "users" ], - "description": "Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Delete a user sessions by its unique ID.", "responses": { - "200": { - "description": "UsageCollection", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/usageCollection" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getCollectionUsage", - "group": null, - "weight": 824, + "method": "deleteSession", + "group": "sessions", + "weight": 99, "cookies": false, "type": "", - "demo": "vectorsdb\/get-collection-usage.md", + "demo": "users\/delete-session.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": [ + "users.write", + "sessions.write" + ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "range", - "description": "Date range.", - "required": false, - "schema": { - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" - }, - "in": "query" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "sessionId", + "description": "Session ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/vectorsdb\/{databaseId}\/usage": { - "get": { - "summary": "Get VectorsDB usage stats", - "operationId": "vectorsDBGetUsage", + "\/users\/{userId}\/status": { + "patch": { + "summary": "Update user status", + "operationId": "usersUpdateStatus", "tags": [ - "vectorsDB" + "users" ], - "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.", "responses": { "200": { - "description": "UsageVectorsDB", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageVectorsDB" + "$ref": "#\/components\/schemas\/user" } } } @@ -68689,108 +68765,81 @@ }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 817, + "method": "updateStatus", + "group": "users", + "weight": 80, "cookies": false, "type": "", - "demo": "vectorsdb\/get-usage.md", + "demo": "users\/update-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-database-usage.md", - "methods": [ - { - "name": "getUsage", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "range" - ], - "required": [ - "databaseId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/usageVectorsDB" - } - ], - "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", - "demo": "vectorsdb\/get-usage.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "range", - "description": "Date range.", - "required": false, - "schema": { - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d" - }, - "in": "query" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", + "x-example": false + } + }, + "required": [ + "status" + ] + } + } + } + } } }, - "\/webhooks": { + "\/users\/{userId}\/targets": { "get": { - "summary": "List webhooks", - "operationId": "webhooksList", + "summary": "List user targets", + "operationId": "usersListTargets", "tags": [ - "webhooks" + "users" ], - "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "description": "List the messaging targets that are associated with a user.", "responses": { "200": { - "description": "Webhooks List", + "description": "Target list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhookList" + "$ref": "#\/components\/schemas\/targetList" } } } @@ -68798,22 +68847,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": null, - "weight": 586, + "method": "listTargets", + "group": "targets", + "weight": 78, "cookies": false, "type": "", - "demo": "webhooks\/list.md", + "demo": "users\/list-targets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.read", + "scope": "targets.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md", "auth": { "Project": [] } @@ -68825,9 +68875,19 @@ } ], "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, url, authUsername, tls, events, enabled, logs, attempts", + "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: userId, providerId, identifier, providerType", "required": false, "schema": { "type": "array", @@ -68852,19 +68912,19 @@ ] }, "post": { - "summary": "Create webhook", - "operationId": "webhooksCreate", + "summary": "Create user target", + "operationId": "usersCreateTarget", "tags": [ - "webhooks" + "users" ], - "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "description": "Create a messaging target.", "responses": { "201": { - "description": "Webhook", + "description": "Target", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/target" } } } @@ -68872,22 +68932,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": null, - "weight": 585, + "method": "createTarget", + "group": "targets", + "weight": 70, "cookies": false, "type": "", - "demo": "webhooks\/create.md", + "demo": "users\/create-target.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "targets.write", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md", "auth": { "Project": [] } @@ -68898,67 +68959,61 @@ "Key": [] } ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "webhookId": { - "type": "string", - "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "url": { + "targetId": { "type": "string", - "description": "Webhook URL.", - "x-example": null + "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "name": { + "providerType": { "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "x-example": "" - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "x-example": false - }, - "tls": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "x-example": false + "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", + "x-example": "email", + "enum": [ + "email", + "sms", + "push" + ], + "x-enum-name": "MessagingProviderType", + "x-enum-keys": [] }, - "authUsername": { + "identifier": { "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "x-example": "" + "description": "The target identifier (token, email, phone etc.)", + "x-example": "" }, - "authPassword": { + "providerId": { "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "x-example": "" + "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", + "x-example": "" }, - "secret": { + "name": { "type": "string", - "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", - "x-example": "", - "x-nullable": true + "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "x-example": "" } }, "required": [ - "webhookId", - "url", - "name", - "events" + "targetId", + "providerType", + "identifier" ] } } @@ -68966,21 +69021,21 @@ } } }, - "\/webhooks\/{webhookId}": { + "\/users\/{userId}\/targets\/{targetId}": { "get": { - "summary": "Get webhook", - "operationId": "webhooksGet", + "summary": "Get user target", + "operationId": "usersGetTarget", "tags": [ - "webhooks" + "users" ], - "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "description": "Get a user's push notification target by ID.", "responses": { "200": { - "description": "Webhook", + "description": "Target", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/target" } } } @@ -68988,22 +69043,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": null, - "weight": 587, + "method": "getTarget", + "group": "targets", + "weight": 74, "cookies": false, "type": "", - "demo": "webhooks\/get.md", + "demo": "users\/get-target.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.read", + "scope": "targets.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md", "auth": { "Project": [] } @@ -69016,31 +69072,41 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } ] }, - "put": { - "summary": "Update webhook", - "operationId": "webhooksUpdate", + "patch": { + "summary": "Update user target", + "operationId": "usersUpdateTarget", "tags": [ - "webhooks" + "users" ], - "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "description": "Update a messaging target.", "responses": { "200": { - "description": "Webhook", + "description": "Target", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/target" } } } @@ -69048,22 +69114,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": null, - "weight": 589, + "method": "updateTarget", + "group": "targets", + "weight": 90, "cookies": false, "type": "", - "demo": "webhooks\/update.md", + "demo": "users\/update-target.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "targets.write", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md", "auth": { "Project": [] } @@ -69076,12 +69143,22 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -69092,62 +69169,34 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "x-example": "" - }, - "url": { + "identifier": { "type": "string", - "description": "Webhook URL.", - "x-example": null - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "x-example": false - }, - "tls": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "x-example": false + "description": "The target identifier (token, email, phone etc.)", + "x-example": "" }, - "authUsername": { + "providerId": { "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "x-example": "" + "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", + "x-example": "" }, - "authPassword": { + "name": { "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "x-example": "" + "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "x-example": "" } - }, - "required": [ - "name", - "url", - "events" - ] + } } } } } }, "delete": { - "summary": "Delete webhook", - "operationId": "webhooksDelete", + "summary": "Delete user target", + "operationId": "usersDeleteTarget", "tags": [ - "webhooks" + "users" ], - "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "description": "Delete a messaging target.", "responses": { "204": { "description": "No content" @@ -69155,22 +69204,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": null, - "weight": 588, + "method": "deleteTarget", + "group": "targets", + "weight": 102, "cookies": false, "type": "", - "demo": "webhooks\/delete.md", + "demo": "users\/delete-target.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "targets.write", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md", "auth": { "Project": [] } @@ -69183,33 +69233,43 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } ] } }, - "\/webhooks\/{webhookId}\/secret": { - "patch": { - "summary": "Update webhook secret key", - "operationId": "webhooksUpdateSecret", + "\/users\/{userId}\/tokens": { + "post": { + "summary": "Create token", + "operationId": "usersCreateToken", "tags": [ - "webhooks" + "users" ], - "description": "Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.", + "description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n", "responses": { - "200": { - "description": "Webhook", + "201": { + "description": "Token", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/token" } } } @@ -69217,22 +69277,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSecret", - "group": null, - "weight": 590, + "method": "createToken", + "group": "sessions", + "weight": 98, "cookies": false, "type": "", - "demo": "webhooks\/update-secret.md", + "demo": "users\/create-token.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md", "auth": { "Project": [] } @@ -69245,12 +69306,12 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -69261,11 +69322,17 @@ "schema": { "type": "object", "properties": { - "secret": { - "type": "string", - "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", - "x-example": "", - "x-nullable": true + "length": { + "type": "integer", + "description": "Token length in characters. The default length is 6 characters", + "x-example": 4, + "format": "int32" + }, + "expire": { + "type": "integer", + "description": "Token expiration period in seconds. The default expiration is 15 minutes.", + "x-example": 60, + "format": "int32" } } } @@ -69273,1777 +69340,9163 @@ } } } - } - }, - "tags": [ - { - "name": "account", - "description": "The Account service allows you to authenticate and manage a user account." - }, - { - "name": "avatars", - "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." - }, - { - "name": "databases", - "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" - }, - { - "name": "tablesdb", - "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" - }, - { - "name": "locale", - "description": "The Locale service allows you to customize your app based on your users' location." - }, - { - "name": "health", - "description": "The Health service allows you to both validate and monitor your Appwrite server's health." - }, - { - "name": "projects", - "description": "The Project service allows you to manage all the projects in your Appwrite server." - }, - { - "name": "project", - "description": "The Project service allows you to manage all the projects in your Appwrite server." - }, - { - "name": "storage", - "description": "The Storage service allows you to manage your project files." - }, - { - "name": "teams", - "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" - }, - { - "name": "users", - "description": "The Users service allows you to manage your project users." - }, - { - "name": "sites", - "description": "The Sites Service allows you view, create and manage your web applications." - }, - { - "name": "functions", - "description": "The Functions Service allows you view, create and manage your Cloud Functions." }, - { - "name": "proxy", - "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." + "\/users\/{userId}\/verification": { + "patch": { + "summary": "Update email verification", + "operationId": "usersUpdateEmailVerification", + "tags": [ + "users" + ], + "description": "Update the user email verification status by its unique ID.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateEmailVerification", + "group": "users", + "weight": 88, + "cookies": false, + "type": "", + "demo": "users\/update-email-verification.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "emailVerification": { + "type": "boolean", + "description": "User email verification status.", + "x-example": false + } + }, + "required": [ + "emailVerification" + ] + } + } + } + } + } }, - { - "name": "graphql", - "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." + "\/users\/{userId}\/verification\/phone": { + "patch": { + "summary": "Update phone verification", + "operationId": "usersUpdatePhoneVerification", + "tags": [ + "users" + ], + "description": "Update the user phone verification status by its unique ID.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePhoneVerification", + "group": "users", + "weight": 83, + "cookies": false, + "type": "", + "demo": "users\/update-phone-verification.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "phoneVerification": { + "type": "boolean", + "description": "User phone verification status.", + "x-example": false + } + }, + "required": [ + "phoneVerification" + ] + } + } + } + } + } }, - { - "name": "console", - "description": "The Console service allows you to interact with console relevant information." + "\/vcs\/github\/installations\/{installationId}\/detections": { + "post": { + "summary": "Create repository detection", + "operationId": "vcsCreateRepositoryDetection", + "tags": [ + "vcs" + ], + "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", + "responses": { + "200": { + "description": "DetectionRuntime, or DetectionFramework", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/detectionRuntime" + }, + { + "$ref": "#\/components\/schemas\/detectionFramework" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "runtime": "#\/components\/schemas\/detectionRuntime", + "framework": "#\/components\/schemas\/detectionFramework" + } + } + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createRepositoryDetection", + "group": "repositories", + "weight": 564, + "cookies": false, + "type": "", + "demo": "vcs\/create-repository-detection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "providerRepositoryId": { + "type": "string", + "description": "Repository Id", + "x-example": "" + }, + "type": { + "type": "string", + "description": "Detector type. Must be one of the following: runtime, framework", + "x-example": "runtime", + "enum": [ + "runtime", + "framework" + ], + "x-enum-name": "VCSDetectionType", + "x-enum-keys": [] + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to Root Directory", + "x-example": "" + } + }, + "required": [ + "providerRepositoryId", + "type" + ] + } + } + } + } + } }, - { - "name": "migrations", - "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." + "\/vcs\/github\/installations\/{installationId}\/providerRepositories": { + "get": { + "summary": "List repositories", + "operationId": "vcsListRepositories", + "tags": [ + "vcs" + ], + "description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.", + "responses": { + "200": { + "description": "Runtime Provider Repositories List, or Framework Provider Repositories List", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/providerRepositoryRuntimeList" + }, + { + "$ref": "#\/components\/schemas\/providerRepositoryFrameworkList" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "runtime": "#\/components\/schemas\/providerRepositoryRuntimeList", + "framework": "#\/components\/schemas\/providerRepositoryFrameworkList" + } + } + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listRepositories", + "group": "repositories", + "weight": 561, + "cookies": false, + "type": "", + "demo": "vcs\/list-repositories.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repositories.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "type", + "description": "Detector type. Must be one of the following: runtime, framework", + "required": true, + "schema": { + "type": "string", + "x-example": "runtime", + "enum": [ + "runtime", + "framework" + ], + "x-enum-name": "VCSDetectionType", + "x-enum-keys": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, + { + "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). Only supported methods are limit and offset", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create repository", + "operationId": "vcsCreateRepository", + "tags": [ + "vcs" + ], + "description": "Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.", + "responses": { + "200": { + "description": "ProviderRepository", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/providerRepository" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createRepository", + "group": "repositories", + "weight": 559, + "cookies": false, + "type": "", + "demo": "vcs\/create-repository.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name (slug)", + "x-example": "" + }, + "private": { + "type": "boolean", + "description": "Mark repository public or private", + "x-example": false + } + }, + "required": [ + "name", + "private" + ] + } + } + } + } + } }, - { - "name": "messaging", - "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." - } - ], - "components": { - "schemas": { - "any": { - "description": "Any", + "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}": { + "get": { + "summary": "Get repository", + "operationId": "vcsGetRepository", + "tags": [ + "vcs" + ], + "description": "Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.", + "responses": { + "200": { + "description": "ProviderRepository", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/providerRepository" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getRepository", + "group": "repositories", + "weight": 560, + "cookies": false, + "type": "", + "demo": "vcs\/get-repository.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "providerRepositoryId", + "description": "Repository Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches": { + "get": { + "summary": "List repository branches", + "operationId": "vcsListRepositoryBranches", + "tags": [ + "vcs" + ], + "description": "Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n", + "responses": { + "200": { + "description": "Branches List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/branchList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listRepositoryBranches", + "group": "repositories", + "weight": 562, + "cookies": false, + "type": "", + "demo": "vcs\/list-repository-branches.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repository-branches.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "providerRepositoryId", + "description": "Repository Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents": { + "get": { + "summary": "Get files and directories of a VCS repository", + "operationId": "vcsGetRepositoryContents", + "tags": [ + "vcs" + ], + "description": "Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", + "responses": { + "200": { + "description": "VCS Content List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vcsContentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getRepositoryContents", + "group": "repositories", + "weight": 563, + "cookies": false, + "type": "", + "demo": "vcs\/get-repository-contents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository-contents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "providerRepositoryId", + "description": "Repository Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "providerRootDirectory", + "description": "Path to get contents of nested directory", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, + { + "name": "providerReference", + "description": "Git reference (branch, tag, commit) to get contents from", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + } + ] + } + }, + "\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": { + "patch": { + "summary": "Update external deployment (authorize)", + "operationId": "vcsUpdateExternalDeployments", + "tags": [ + "vcs" + ], + "description": "Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateExternalDeployments", + "group": "repositories", + "weight": 1197, + "cookies": false, + "type": "", + "demo": "vcs\/update-external-deployments.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/update-external-deployments.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "repositoryId", + "description": "VCS Repository Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "providerPullRequestId": { + "type": "string", + "description": "GitHub Pull Request Id", + "x-example": "" + } + }, + "required": [ + "providerPullRequestId" + ] + } + } + } + } + } + }, + "\/vcs\/installations": { + "get": { + "summary": "List installations", + "operationId": "vcsListInstallations", + "tags": [ + "vcs" + ], + "description": "List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.\n", + "responses": { + "200": { + "description": "Installations List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/installationList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listInstallations", + "group": "installations", + "weight": 557, + "cookies": false, + "type": "", + "demo": "vcs\/list-installations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md", + "auth": { + "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: provider, organization", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + } + }, + "\/vcs\/installations\/{installationId}": { + "get": { + "summary": "Get installation", + "operationId": "vcsGetInstallation", + "tags": [ + "vcs" + ], + "description": "Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. ", + "responses": { + "200": { + "description": "Installation", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/installation" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getInstallation", + "group": "installations", + "weight": 556, + "cookies": false, + "type": "", + "demo": "vcs\/get-installation.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete installation", + "operationId": "vcsDeleteInstallation", + "tags": [ + "vcs" + ], + "description": "Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteInstallation", + "group": "installations", + "weight": 558, + "cookies": false, + "type": "", + "demo": "vcs\/delete-installation.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb": { + "get": { + "summary": "List databases", + "operationId": "vectorsDBList", + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Databases List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/databaseList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": "vectorsdb", + "weight": 868, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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 columns: name", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create database", + "operationId": "vectorsDBCreate", + "tags": [ + "vectorsDB" + ], + "description": "Create a new Database.\n", + "responses": { + "201": { + "description": "Database", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/database" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": "vectorsdb", + "weight": 864, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "databaseId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "databaseId", + "name" + ] + } + } + } + } + } + }, + "\/vectorsdb\/embeddings\/text": { + "post": { + "summary": "Create Text Embeddings", + "operationId": "vectorsDBCreateTextEmbeddings", + "tags": [ + "vectorsDB" + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "200": { + "description": "Embedding list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/embeddingList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTextEmbeddings", + "group": "documents", + "weight": 890, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-text-embeddings.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "methods": [ + { + "name": "createTextEmbeddings", + "namespace": "vectorsDB", + "desc": "Create Text Embedding", + "auth": { + "Project": [] + }, + "parameters": [ + "texts", + "model" + ], + "required": [ + "texts" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/embeddingList" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-text-embeddings.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "texts": { + "type": "array", + "description": "Array of text to generate embeddings.", + "x-example": null, + "items": { + "type": "string" + } + }, + "model": { + "type": "string", + "description": "The embedding model to use for generating vector embeddings.", + "x-example": "embeddinggemma", + "enum": [ + "embeddinggemma" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "texts" + ] + } + } + } + } + } + }, + "\/vectorsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "vectorsDBListTransactions", + "tags": [ + "vectorsDB" + ], + "description": "List transactions across all databases.", + "responses": { + "200": { + "description": "Transaction List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transactionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "weight": 895, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-transactions.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "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).", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create transaction", + "operationId": "vectorsDBCreateTransaction", + "tags": [ + "vectorsDB" + ], + "description": "Create a new transaction.", + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 891, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "x-example": 60, + "format": "int32" + } + } + } + } + } + } + } + }, + "\/vectorsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "vectorsDBGetTransaction", + "tags": [ + "vectorsDB" + ], + "description": "Get a transaction by its unique ID.", + "responses": { + "200": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransaction", + "group": "transactions", + "weight": 892, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "patch": { + "summary": "Update transaction", + "operationId": "vectorsDBUpdateTransaction", + "tags": [ + "vectorsDB" + ], + "description": "Update a transaction, to either commit or roll back its operations.", + "responses": { + "200": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "weight": 893, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "x-example": false + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete transaction", + "operationId": "vectorsDBDeleteTransaction", + "tags": [ + "vectorsDB" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 894, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "vectorsDBCreateOperations", + "tags": [ + "vectorsDB" + ], + "description": "Create multiple operations in a single transaction.", + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 896, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-operations.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "operations": { + "type": "array", + "description": "Array of staged operations.", + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + } + } + } + }, + "\/vectorsdb\/usage": { + "get": { + "summary": "Get VectorsDB usage stats", + "operationId": "vectorsDBListUsage", + "tags": [ + "vectorsDB" + ], + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageVectorsDBs", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageVectorsDBs" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listUsage", + "group": null, + "weight": 870, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-usage.md", + "methods": [ + { + "name": "listUsage", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "range" + ], + "required": [], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/usageVectorsDBs" + } + ], + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "vectorsdb\/list-usage.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" + }, + "in": "query" + } + ] + } + }, + "\/vectorsdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "vectorsDBGet", + "tags": [ + "vectorsDB" + ], + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "responses": { + "200": { + "description": "Database", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/database" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "vectorsdb", + "weight": 865, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update database", + "operationId": "vectorsDBUpdate", + "tags": [ + "vectorsDB" + ], + "description": "Update a database by its unique ID.", + "responses": { + "200": { + "description": "Database", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/database" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": "vectorsdb", + "weight": 866, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete database", + "operationId": "vectorsDBDelete", + "tags": [ + "vectorsDB" + ], + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "vectorsdb", + "weight": 867, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections": { + "get": { + "summary": "List collections", + "operationId": "vectorsDBListCollections", + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "VectorsDB Collections List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vectorsdbCollectionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollections", + "group": "collections", + "weight": 875, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-collections.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-collections.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create collection", + "operationId": "vectorsDBCreateCollection", + "tags": [ + "vectorsDB" + ], + "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "VectorsDB Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vectorsdbCollection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createCollection", + "group": "collections", + "weight": 871, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "collectionId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Collection name. Max length: 128 chars.", + "x-example": "" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimension.", + "x-example": 1, + "format": "int32" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "collectionId", + "name", + "dimension" + ] + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}": { + "get": { + "summary": "Get collection", + "operationId": "vectorsDBGetCollection", + "tags": [ + "vectorsDB" + ], + "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "responses": { + "200": { + "description": "VectorsDB Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vectorsdbCollection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollection", + "group": "collections", + "weight": 872, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update collection", + "operationId": "vectorsDBUpdateCollection", + "tags": [ + "vectorsDB" + ], + "description": "Update a collection by its unique ID.", + "responses": { + "200": { + "description": "VectorsDB Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vectorsdbCollection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateCollection", + "group": "collections", + "weight": 873, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Collection name. Max length: 128 chars.", + "x-example": "" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimensions.", + "x-example": 1, + "format": "int32" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete collection", + "operationId": "vectorsDBDeleteCollection", + "tags": [ + "vectorsDB" + ], + "description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteCollection", + "group": "collections", + "weight": 874, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "vectorsDBListDocuments", + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDocuments", + "group": "documents", + "weight": 885, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-documents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "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", + "x-example": false, + "default": true + }, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "vectorsDBCreateDocument", + "tags": [ + "vectorsDB" + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 881, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "vectorsDB", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-document.md", + "public": true + }, + { + "name": "createDocuments", + "namespace": "vectorsDB", + "desc": "Create documents", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-documents.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "documentId": { + "type": "string", + "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "put": { + "summary": "Upsert documents", + "operationId": "vectorsDBUpsertDocuments", + "tags": [ + "vectorsDB" + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 888, + "cookies": false, + "type": "", + "demo": "vectorsdb\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-documents.md", + "methods": [ + { + "name": "upsertDocuments", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "demo": "vectorsdb\/upsert-documents.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + }, + "required": [ + "documents" + ] + } + } + } + } + }, + "patch": { + "summary": "Update documents", + "operationId": "vectorsDBUpdateDocuments", + "tags": [ + "vectorsDB" + ], + "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 887, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete documents", + "operationId": "vectorsDBDeleteDocuments", + "tags": [ + "vectorsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 889, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "vectorsDBGetDocument", + "tags": [ + "vectorsDB" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 884, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + } + ] + }, + "put": { + "summary": "Upsert a document", + "operationId": "vectorsDBUpsertDocument", + "tags": [ + "vectorsDB" + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 883, + "cookies": false, + "type": "", + "demo": "vectorsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/upsert-document.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "patch": { + "summary": "Update document", + "operationId": "vectorsDBUpdateDocument", + "tags": [ + "vectorsDB" + ], + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 882, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete document", + "operationId": "vectorsDBDeleteDocument", + "tags": [ + "vectorsDB" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 886, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "vectorsDBListIndexes", + "tags": [ + "vectorsDB" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/indexList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 880, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-indexes.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "vectorsDBCreateIndex", + "tags": [ + "vectorsDB" + ], + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "responses": { + "202": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/index" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 877, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-index.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "hnsw_euclidean", + "enum": [ + "hnsw_euclidean", + "hnsw_dot", + "hnsw_cosine", + "object", + "key", + "unique" + ], + "x-enum-name": "VectorsDBIndexType", + "x-enum-keys": [] + }, + "attributes": { + "type": "array", + "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "attributes" + ] + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "vectorsDBGetIndex", + "tags": [ + "vectorsDB" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/index" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 878, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-index.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "vectorsDBDeleteIndex", + "tags": [ + "vectorsDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 879, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-index.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/usage": { + "get": { + "summary": "Get collection usage stats", + "operationId": "vectorsDBGetCollectionUsage", + "tags": [ + "vectorsDB" + ], + "description": "Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageCollection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageCollection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollectionUsage", + "group": null, + "weight": 876, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-collection-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection-usage.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" + }, + "in": "query" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/usage": { + "get": { + "summary": "Get VectorsDB usage stats", + "operationId": "vectorsDBGetUsage", + "tags": [ + "vectorsDB" + ], + "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageVectorsDB", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageVectorsDB" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getUsage", + "group": null, + "weight": 869, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-database-usage.md", + "methods": [ + { + "name": "getUsage", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "range" + ], + "required": [ + "databaseId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/usageVectorsDB" + } + ], + "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "vectorsdb\/get-usage.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" + }, + "in": "query" + } + ] + } + }, + "\/webhooks": { + "get": { + "summary": "List webhooks", + "operationId": "webhooksList", + "tags": [ + "webhooks" + ], + "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Webhooks List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhookList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 567, + "cookies": false, + "type": "", + "demo": "webhooks\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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: name, url, authUsername, tls, events, enabled, logs, attempts", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create webhook", + "operationId": "webhooksCreate", + "tags": [ + "webhooks" + ], + "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "responses": { + "201": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 566, + "cookies": false, + "type": "", + "demo": "webhooks\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "webhookId": { + "type": "string", + "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "x-example": null + }, + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "x-example": "" + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "x-example": false + }, + "tls": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "x-example": false + }, + "authUsername": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "x-example": "" + }, + "authPassword": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "x-example": "" + }, + "secret": { + "type": "string", + "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "webhookId", + "url", + "name", + "events" + ] + } + } + } + } + } + }, + "\/webhooks\/{webhookId}": { + "get": { + "summary": "Get webhook", + "operationId": "webhooksGet", + "tags": [ + "webhooks" + ], + "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 568, + "cookies": false, + "type": "", + "demo": "webhooks\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update webhook", + "operationId": "webhooksUpdate", + "tags": [ + "webhooks" + ], + "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 570, + "cookies": false, + "type": "", + "demo": "webhooks\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "x-example": "" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "x-example": null + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "x-example": false + }, + "tls": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "x-example": false + }, + "authUsername": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "x-example": "" + }, + "authPassword": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "url", + "events" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete webhook", + "operationId": "webhooksDelete", + "tags": [ + "webhooks" + ], + "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 569, + "cookies": false, + "type": "", + "demo": "webhooks\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/webhooks\/{webhookId}\/secret": { + "patch": { + "summary": "Update webhook secret key", + "operationId": "webhooksUpdateSecret", + "tags": [ + "webhooks" + ], + "description": "Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSecret", + "group": null, + "weight": 571, + "cookies": false, + "type": "", + "demo": "webhooks\/update-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "secret": { + "type": "string", + "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + } + } + }, + "tags": [ + { + "name": "account", + "description": "The Account service allows you to authenticate and manage a user account." + }, + { + "name": "avatars", + "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." + }, + { + "name": "databases", + "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" + }, + { + "name": "tablesdb", + "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" + }, + { + "name": "locale", + "description": "The Locale service allows you to customize your app based on your users' location." + }, + { + "name": "health", + "description": "The Health service allows you to both validate and monitor your Appwrite server's health." + }, + { + "name": "projects", + "description": "The Project service allows you to manage all the projects in your Appwrite server." + }, + { + "name": "project", + "description": "The Project service allows you to manage all the projects in your Appwrite server." + }, + { + "name": "storage", + "description": "The Storage service allows you to manage your project files." + }, + { + "name": "teams", + "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" + }, + { + "name": "users", + "description": "The Users service allows you to manage your project users." + }, + { + "name": "sites", + "description": "The Sites Service allows you view, create and manage your web applications." + }, + { + "name": "functions", + "description": "The Functions Service allows you view, create and manage your Cloud Functions." + }, + { + "name": "proxy", + "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." + }, + { + "name": "graphql", + "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." + }, + { + "name": "console", + "description": "The Console service allows you to interact with console relevant information." + }, + { + "name": "migrations", + "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." + }, + { + "name": "messaging", + "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." + } + ], + "components": { + "schemas": { + "any": { + "description": "Any", + "type": "object", + "additionalProperties": true, + "example": [] + }, + "error": { + "description": "Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Error message.", + "x-example": "Not found" + }, + "code": { + "type": "string", + "description": "Error code.", + "x-example": "404" + }, + "type": { + "type": "string", + "description": "Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes", + "x-example": "not_found" + }, + "version": { + "type": "string", + "description": "Server version number.", + "x-example": "1.0" + } + }, + "required": [ + "message", + "code", + "type", + "version" + ], + "example": { + "message": "Not found", + "code": "404", + "type": "not_found", + "version": "1.0" + } + }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "$ref": "#\/components\/schemas\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ], + "example": { + "total": 5, + "rows": "" + } + }, + "documentList": { + "description": "Documents List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of documents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "documents": { + "type": "array", + "description": "List of documents.", + "items": { + "$ref": "#\/components\/schemas\/document" + }, + "x-example": "" + } + }, + "required": [ + "total", + "documents" + ], + "example": { + "total": 5, + "documents": "" + } + }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "$ref": "#\/components\/schemas\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ], + "example": { + "total": 5, + "tables": "" + } + }, + "collectionList": { + "description": "Collections List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of collections that matched your query.", + "x-example": 5, + "format": "int32" + }, + "collections": { + "type": "array", + "description": "List of collections.", + "items": { + "$ref": "#\/components\/schemas\/collection" + }, + "x-example": "" + } + }, + "required": [ + "total", + "collections" + ], + "example": { + "total": 5, + "collections": "" + } + }, + "databaseList": { + "description": "Databases List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of databases that matched your query.", + "x-example": 5, + "format": "int32" + }, + "databases": { + "type": "array", + "description": "List of databases.", + "items": { + "$ref": "#\/components\/schemas\/database" + }, + "x-example": "" + } + }, + "required": [ + "total", + "databases" + ], + "example": { + "total": 5, + "databases": "" + } + }, + "indexList": { + "description": "Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "$ref": "#\/components\/schemas\/index" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ], + "example": { + "total": 5, + "indexes": "" + } + }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "$ref": "#\/components\/schemas\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ], + "example": { + "total": 5, + "indexes": "" + } + }, + "userList": { + "description": "Users List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of users that matched your query.", + "x-example": 5, + "format": "int32" + }, + "users": { + "type": "array", + "description": "List of users.", + "items": { + "$ref": "#\/components\/schemas\/user" + }, + "x-example": "" + } + }, + "required": [ + "total", + "users" + ], + "example": { + "total": 5, + "users": "" + } + }, + "sessionList": { + "description": "Sessions List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of sessions that matched your query.", + "x-example": 5, + "format": "int32" + }, + "sessions": { + "type": "array", + "description": "List of sessions.", + "items": { + "$ref": "#\/components\/schemas\/session" + }, + "x-example": "" + } + }, + "required": [ + "total", + "sessions" + ], + "example": { + "total": 5, + "sessions": "" + } + }, + "identityList": { + "description": "Identities List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of identities that matched your query.", + "x-example": 5, + "format": "int32" + }, + "identities": { + "type": "array", + "description": "List of identities.", + "items": { + "$ref": "#\/components\/schemas\/identity" + }, + "x-example": "" + } + }, + "required": [ + "total", + "identities" + ], + "example": { + "total": 5, + "identities": "" + } + }, + "logList": { + "description": "Logs List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of logs that matched your query.", + "x-example": 5, + "format": "int32" + }, + "logs": { + "type": "array", + "description": "List of logs.", + "items": { + "$ref": "#\/components\/schemas\/log" + }, + "x-example": "" + } + }, + "required": [ + "total", + "logs" + ], + "example": { + "total": 5, + "logs": "" + } + }, + "fileList": { + "description": "Files List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of files that matched your query.", + "x-example": 5, + "format": "int32" + }, + "files": { + "type": "array", + "description": "List of files.", + "items": { + "$ref": "#\/components\/schemas\/file" + }, + "x-example": "" + } + }, + "required": [ + "total", + "files" + ], + "example": { + "total": 5, + "files": "" + } + }, + "bucketList": { + "description": "Buckets List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of buckets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "buckets": { + "type": "array", + "description": "List of buckets.", + "items": { + "$ref": "#\/components\/schemas\/bucket" + }, + "x-example": "" + } + }, + "required": [ + "total", + "buckets" + ], + "example": { + "total": 5, + "buckets": "" + } + }, + "resourceTokenList": { + "description": "Resource Tokens List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tokens that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tokens": { + "type": "array", + "description": "List of tokens.", + "items": { + "$ref": "#\/components\/schemas\/resourceToken" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tokens" + ], + "example": { + "total": 5, + "tokens": "" + } + }, + "teamList": { + "description": "Teams List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of teams that matched your query.", + "x-example": 5, + "format": "int32" + }, + "teams": { + "type": "array", + "description": "List of teams.", + "items": { + "$ref": "#\/components\/schemas\/team" + }, + "x-example": "" + } + }, + "required": [ + "total", + "teams" + ], + "example": { + "total": 5, + "teams": "" + } + }, + "membershipList": { + "description": "Memberships List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of memberships that matched your query.", + "x-example": 5, + "format": "int32" + }, + "memberships": { + "type": "array", + "description": "List of memberships.", + "items": { + "$ref": "#\/components\/schemas\/membership" + }, + "x-example": "" + } + }, + "required": [ + "total", + "memberships" + ], + "example": { + "total": 5, + "memberships": "" + } + }, + "siteList": { + "description": "Sites List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of sites that matched your query.", + "x-example": 5, + "format": "int32" + }, + "sites": { + "type": "array", + "description": "List of sites.", + "items": { + "$ref": "#\/components\/schemas\/site" + }, + "x-example": "" + } + }, + "required": [ + "total", + "sites" + ], + "example": { + "total": 5, + "sites": "" + } + }, + "templateSiteList": { + "description": "Site Templates List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of templates that matched your query.", + "x-example": 5, + "format": "int32" + }, + "templates": { + "type": "array", + "description": "List of templates.", + "items": { + "$ref": "#\/components\/schemas\/templateSite" + }, + "x-example": "" + } + }, + "required": [ + "total", + "templates" + ], + "example": { + "total": 5, + "templates": "" + } + }, + "functionList": { + "description": "Functions List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of functions that matched your query.", + "x-example": 5, + "format": "int32" + }, + "functions": { + "type": "array", + "description": "List of functions.", + "items": { + "$ref": "#\/components\/schemas\/function" + }, + "x-example": "" + } + }, + "required": [ + "total", + "functions" + ], + "example": { + "total": 5, + "functions": "" + } + }, + "templateFunctionList": { + "description": "Function Templates List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of templates that matched your query.", + "x-example": 5, + "format": "int32" + }, + "templates": { + "type": "array", + "description": "List of templates.", + "items": { + "$ref": "#\/components\/schemas\/templateFunction" + }, + "x-example": "" + } + }, + "required": [ + "total", + "templates" + ], + "example": { + "total": 5, + "templates": "" + } + }, + "installationList": { + "description": "Installations List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of installations that matched your query.", + "x-example": 5, + "format": "int32" + }, + "installations": { + "type": "array", + "description": "List of installations.", + "items": { + "$ref": "#\/components\/schemas\/installation" + }, + "x-example": "" + } + }, + "required": [ + "total", + "installations" + ], + "example": { + "total": 5, + "installations": "" + } + }, + "providerRepositoryFrameworkList": { + "description": "Framework Provider Repositories List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of frameworkProviderRepositories that matched your query.", + "x-example": 5, + "format": "int32" + }, + "frameworkProviderRepositories": { + "type": "array", + "description": "List of frameworkProviderRepositories.", + "items": { + "$ref": "#\/components\/schemas\/providerRepositoryFramework" + }, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Provider repository list type.", + "x-example": "framework" + } + }, + "required": [ + "total", + "frameworkProviderRepositories", + "type" + ], + "example": { + "total": 5, + "frameworkProviderRepositories": "", + "type": "framework" + } + }, + "providerRepositoryRuntimeList": { + "description": "Runtime Provider Repositories List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of runtimeProviderRepositories that matched your query.", + "x-example": 5, + "format": "int32" + }, + "runtimeProviderRepositories": { + "type": "array", + "description": "List of runtimeProviderRepositories.", + "items": { + "$ref": "#\/components\/schemas\/providerRepositoryRuntime" + }, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Provider repository list type.", + "x-example": "runtime" + } + }, + "required": [ + "total", + "runtimeProviderRepositories", + "type" + ], + "example": { + "total": 5, + "runtimeProviderRepositories": "", + "type": "runtime" + } + }, + "branchList": { + "description": "Branches List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of branches that matched your query.", + "x-example": 5, + "format": "int32" + }, + "branches": { + "type": "array", + "description": "List of branches.", + "items": { + "$ref": "#\/components\/schemas\/branch" + }, + "x-example": "" + } + }, + "required": [ + "total", + "branches" + ], + "example": { + "total": 5, + "branches": "" + } + }, + "frameworkList": { + "description": "Frameworks List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of frameworks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "frameworks": { + "type": "array", + "description": "List of frameworks.", + "items": { + "$ref": "#\/components\/schemas\/framework" + }, + "x-example": "" + } + }, + "required": [ + "total", + "frameworks" + ], + "example": { + "total": 5, + "frameworks": "" + } + }, + "runtimeList": { + "description": "Runtimes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of runtimes that matched your query.", + "x-example": 5, + "format": "int32" + }, + "runtimes": { + "type": "array", + "description": "List of runtimes.", + "items": { + "$ref": "#\/components\/schemas\/runtime" + }, + "x-example": "" + } + }, + "required": [ + "total", + "runtimes" + ], + "example": { + "total": 5, + "runtimes": "" + } + }, + "deploymentList": { + "description": "Deployments List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of deployments that matched your query.", + "x-example": 5, + "format": "int32" + }, + "deployments": { + "type": "array", + "description": "List of deployments.", + "items": { + "$ref": "#\/components\/schemas\/deployment" + }, + "x-example": "" + } + }, + "required": [ + "total", + "deployments" + ], + "example": { + "total": 5, + "deployments": "" + } + }, + "executionList": { + "description": "Executions List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of executions that matched your query.", + "x-example": 5, + "format": "int32" + }, + "executions": { + "type": "array", + "description": "List of executions.", + "items": { + "$ref": "#\/components\/schemas\/execution" + }, + "x-example": "" + } + }, + "required": [ + "total", + "executions" + ], + "example": { + "total": 5, + "executions": "" + } + }, + "projectList": { + "description": "Projects List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of projects that matched your query.", + "x-example": 5, + "format": "int32" + }, + "projects": { + "type": "array", + "description": "List of projects.", + "items": { + "$ref": "#\/components\/schemas\/project" + }, + "x-example": "" + } + }, + "required": [ + "total", + "projects" + ], + "example": { + "total": 5, + "projects": "" + } + }, + "webhookList": { + "description": "Webhooks List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of webhooks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "webhooks": { + "type": "array", + "description": "List of webhooks.", + "items": { + "$ref": "#\/components\/schemas\/webhook" + }, + "x-example": "" + } + }, + "required": [ + "total", + "webhooks" + ], + "example": { + "total": 5, + "webhooks": "" + } + }, + "keyList": { + "description": "API Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of keys that matched your query.", + "x-example": 5, + "format": "int32" + }, + "keys": { + "type": "array", + "description": "List of keys.", + "items": { + "$ref": "#\/components\/schemas\/key" + }, + "x-example": "" + } + }, + "required": [ + "total", + "keys" + ], + "example": { + "total": 5, + "keys": "" + } + }, + "devKeyList": { + "description": "Dev Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of devKeys that matched your query.", + "x-example": 5, + "format": "int32" + }, + "devKeys": { + "type": "array", + "description": "List of devKeys.", + "items": { + "$ref": "#\/components\/schemas\/devKey" + }, + "x-example": "" + } + }, + "required": [ + "total", + "devKeys" + ], + "example": { + "total": 5, + "devKeys": "" + } + }, + "countryList": { + "description": "Countries List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of countries that matched your query.", + "x-example": 5, + "format": "int32" + }, + "countries": { + "type": "array", + "description": "List of countries.", + "items": { + "$ref": "#\/components\/schemas\/country" + }, + "x-example": "" + } + }, + "required": [ + "total", + "countries" + ], + "example": { + "total": 5, + "countries": "" + } + }, + "continentList": { + "description": "Continents List", "type": "object", - "additionalProperties": true, - "example": [] + "properties": { + "total": { + "type": "integer", + "description": "Total number of continents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "continents": { + "type": "array", + "description": "List of continents.", + "items": { + "$ref": "#\/components\/schemas\/continent" + }, + "x-example": "" + } + }, + "required": [ + "total", + "continents" + ], + "example": { + "total": 5, + "continents": "" + } }, - "error": { - "description": "Error", + "languageList": { + "description": "Languages List", "type": "object", "properties": { - "message": { - "type": "string", - "description": "Error message.", - "x-example": "Not found" + "total": { + "type": "integer", + "description": "Total number of languages that matched your query.", + "x-example": 5, + "format": "int32" }, - "code": { - "type": "string", - "description": "Error code.", - "x-example": "404" + "languages": { + "type": "array", + "description": "List of languages.", + "items": { + "$ref": "#\/components\/schemas\/language" + }, + "x-example": "" + } + }, + "required": [ + "total", + "languages" + ], + "example": { + "total": 5, + "languages": "" + } + }, + "currencyList": { + "description": "Currencies List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of currencies that matched your query.", + "x-example": 5, + "format": "int32" }, - "type": { - "type": "string", - "description": "Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes", - "x-example": "not_found" + "currencies": { + "type": "array", + "description": "List of currencies.", + "items": { + "$ref": "#\/components\/schemas\/currency" + }, + "x-example": "" + } + }, + "required": [ + "total", + "currencies" + ], + "example": { + "total": 5, + "currencies": "" + } + }, + "phoneList": { + "description": "Phones List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of phones that matched your query.", + "x-example": 5, + "format": "int32" }, - "version": { - "type": "string", - "description": "Server version number.", - "x-example": "1.0" + "phones": { + "type": "array", + "description": "List of phones.", + "items": { + "$ref": "#\/components\/schemas\/phone" + }, + "x-example": "" } }, "required": [ - "message", - "code", - "type", - "version" + "total", + "phones" ], "example": { - "message": "Not found", - "code": "404", - "type": "not_found", - "version": "1.0" + "total": 5, + "phones": "" } }, - "rowList": { - "description": "Rows List", + "variableList": { + "description": "Variables List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of rows that matched your query.", + "description": "Total number of variables that matched your query.", "x-example": 5, "format": "int32" }, - "rows": { + "variables": { "type": "array", - "description": "List of rows.", + "description": "List of variables.", "items": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/variable" }, "x-example": "" } }, "required": [ "total", - "rows" + "variables" ], "example": { "total": 5, - "rows": "" + "variables": "" } }, - "documentList": { - "description": "Documents List", + "mockNumberList": { + "description": "Mock Numbers List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents that matched your query.", + "description": "Total number of mockNumbers that matched your query.", "x-example": 5, "format": "int32" }, - "documents": { + "mockNumbers": { "type": "array", - "description": "List of documents.", + "description": "List of mockNumbers.", "items": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/mockNumber" }, "x-example": "" } }, "required": [ "total", - "documents" + "mockNumbers" ], "example": { "total": 5, - "documents": "" + "mockNumbers": "" } }, - "tableList": { - "description": "Tables List", + "policyList": { + "description": "Policies List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of tables that matched your query.", + "description": "Total number of policies in the given project.", + "x-example": 9, + "format": "int32" + }, + "policies": { + "type": "array", + "description": "List of policies.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/policyPasswordDictionary" + }, + { + "$ref": "#\/components\/schemas\/policyPasswordHistory" + }, + { + "$ref": "#\/components\/schemas\/policyPasswordPersonalData" + }, + { + "$ref": "#\/components\/schemas\/policySessionAlert" + }, + { + "$ref": "#\/components\/schemas\/policySessionDuration" + }, + { + "$ref": "#\/components\/schemas\/policySessionInvalidation" + }, + { + "$ref": "#\/components\/schemas\/policySessionLimit" + }, + { + "$ref": "#\/components\/schemas\/policyUserLimit" + }, + { + "$ref": "#\/components\/schemas\/policyMembershipPrivacy" + } + ], + "discriminator": { + "propertyName": "$id", + "mapping": { + "password-dictionary": "#\/components\/schemas\/policyPasswordDictionary", + "password-history": "#\/components\/schemas\/policyPasswordHistory", + "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", + "session-alert": "#\/components\/schemas\/policySessionAlert", + "session-duration": "#\/components\/schemas\/policySessionDuration", + "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", + "session-limit": "#\/components\/schemas\/policySessionLimit", + "user-limit": "#\/components\/schemas\/policyUserLimit", + "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy" + } + } + }, + "x-example": "" + } + }, + "required": [ + "total", + "policies" + ], + "example": { + "total": 9, + "policies": "" + } + }, + "emailTemplateList": { + "description": "Email Templates List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of templates that matched your query.", "x-example": 5, "format": "int32" }, - "tables": { + "templates": { "type": "array", - "description": "List of tables.", + "description": "List of templates.", "items": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/emailTemplate" }, "x-example": "" } }, "required": [ "total", - "tables" + "templates" ], "example": { "total": 5, - "tables": "" + "templates": "" } }, - "collectionList": { - "description": "Collections List", + "healthStatusList": { + "description": "Status List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections that matched your query.", + "description": "Total number of statuses that matched your query.", "x-example": 5, "format": "int32" }, - "collections": { + "statuses": { "type": "array", - "description": "List of collections.", + "description": "List of statuses.", "items": { - "$ref": "#\/components\/schemas\/collection" + "$ref": "#\/components\/schemas\/healthStatus" }, "x-example": "" } }, "required": [ "total", - "collections" + "statuses" ], "example": { "total": 5, - "collections": "" + "statuses": "" } }, - "databaseList": { - "description": "Databases List", + "proxyRuleList": { + "description": "Rule List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of databases that matched your query.", + "description": "Total number of rules that matched your query.", "x-example": 5, "format": "int32" }, - "databases": { + "rules": { "type": "array", - "description": "List of databases.", + "description": "List of rules.", "items": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/proxyRule" }, "x-example": "" } }, "required": [ "total", - "databases" + "rules" ], "example": { "total": 5, - "databases": "" + "rules": "" } }, - "indexList": { - "description": "Indexes List", + "scheduleList": { + "description": "Schedules List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of indexes that matched your query.", + "description": "Total number of schedules that matched your query.", "x-example": 5, "format": "int32" }, - "indexes": { + "schedules": { "type": "array", - "description": "List of indexes.", + "description": "List of schedules.", "items": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/schedule" }, "x-example": "" } }, "required": [ "total", - "indexes" + "schedules" ], "example": { "total": 5, - "indexes": "" + "schedules": "" } }, - "columnIndexList": { - "description": "Column Indexes List", + "localeCodeList": { + "description": "Locale codes list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of indexes that matched your query.", + "description": "Total number of localeCodes that matched your query.", "x-example": 5, "format": "int32" }, - "indexes": { + "localeCodes": { "type": "array", - "description": "List of indexes.", + "description": "List of localeCodes.", "items": { - "$ref": "#\/components\/schemas\/columnIndex" + "$ref": "#\/components\/schemas\/localeCode" }, "x-example": "" } }, "required": [ "total", - "indexes" + "localeCodes" ], "example": { "total": 5, - "indexes": "" + "localeCodes": "" } }, - "userList": { - "description": "Users List", + "providerList": { + "description": "Provider list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users that matched your query.", + "description": "Total number of providers that matched your query.", "x-example": 5, "format": "int32" }, - "users": { + "providers": { "type": "array", - "description": "List of users.", + "description": "List of providers.", "items": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/provider" }, "x-example": "" } }, "required": [ "total", - "users" + "providers" ], "example": { "total": 5, - "users": "" + "providers": "" } }, - "sessionList": { - "description": "Sessions List", + "messageList": { + "description": "Message list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of sessions that matched your query.", + "description": "Total number of messages that matched your query.", "x-example": 5, "format": "int32" }, - "sessions": { + "messages": { "type": "array", - "description": "List of sessions.", + "description": "List of messages.", "items": { - "$ref": "#\/components\/schemas\/session" + "$ref": "#\/components\/schemas\/message" }, "x-example": "" } }, "required": [ "total", - "sessions" + "messages" ], "example": { "total": 5, - "sessions": "" + "messages": "" } }, - "identityList": { - "description": "Identities List", + "topicList": { + "description": "Topic list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of identities that matched your query.", + "description": "Total number of topics that matched your query.", "x-example": 5, "format": "int32" }, - "identities": { + "topics": { "type": "array", - "description": "List of identities.", + "description": "List of topics.", "items": { - "$ref": "#\/components\/schemas\/identity" + "$ref": "#\/components\/schemas\/topic" }, "x-example": "" } }, "required": [ "total", - "identities" + "topics" ], "example": { "total": 5, - "identities": "" + "topics": "" } }, - "logList": { - "description": "Logs List", + "subscriberList": { + "description": "Subscriber list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of logs that matched your query.", + "description": "Total number of subscribers that matched your query.", "x-example": 5, "format": "int32" }, - "logs": { + "subscribers": { "type": "array", - "description": "List of logs.", + "description": "List of subscribers.", + "items": { + "$ref": "#\/components\/schemas\/subscriber" + }, + "x-example": "" + } + }, + "required": [ + "total", + "subscribers" + ], + "example": { + "total": 5, + "subscribers": "" + } + }, + "targetList": { + "description": "Target list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of targets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "targets": { + "type": "array", + "description": "List of targets.", + "items": { + "$ref": "#\/components\/schemas\/target" + }, + "x-example": "" + } + }, + "required": [ + "total", + "targets" + ], + "example": { + "total": 5, + "targets": "" + } + }, + "transactionList": { + "description": "Transaction List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of transactions that matched your query.", + "x-example": 5, + "format": "int32" + }, + "transactions": { + "type": "array", + "description": "List of transactions.", + "items": { + "$ref": "#\/components\/schemas\/transaction" + }, + "x-example": "" + } + }, + "required": [ + "total", + "transactions" + ], + "example": { + "total": 5, + "transactions": "" + } + }, + "migrationList": { + "description": "Migrations List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of migrations that matched your query.", + "x-example": 5, + "format": "int32" + }, + "migrations": { + "type": "array", + "description": "List of migrations.", + "items": { + "$ref": "#\/components\/schemas\/migration" + }, + "x-example": "" + } + }, + "required": [ + "total", + "migrations" + ], + "example": { + "total": 5, + "migrations": "" + } + }, + "specificationList": { + "description": "Specifications List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of specifications that matched your query.", + "x-example": 5, + "format": "int32" + }, + "specifications": { + "type": "array", + "description": "List of specifications.", + "items": { + "$ref": "#\/components\/schemas\/specification" + }, + "x-example": "" + } + }, + "required": [ + "total", + "specifications" + ], + "example": { + "total": 5, + "specifications": "" + } + }, + "vcsContentList": { + "description": "VCS Content List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of contents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "contents": { + "type": "array", + "description": "List of contents.", + "items": { + "$ref": "#\/components\/schemas\/vcsContent" + }, + "x-example": "" + } + }, + "required": [ + "total", + "contents" + ], + "example": { + "total": 5, + "contents": "" + } + }, + "vectorsdbCollectionList": { + "description": "VectorsDB Collections List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of collections that matched your query.", + "x-example": 5, + "format": "int32" + }, + "collections": { + "type": "array", + "description": "List of collections.", "items": { - "$ref": "#\/components\/schemas\/log" + "$ref": "#\/components\/schemas\/vectorsdbCollection" }, "x-example": "" } }, "required": [ "total", - "logs" + "collections" ], "example": { "total": 5, - "logs": "" + "collections": "" } }, - "fileList": { - "description": "Files List", + "embeddingList": { + "description": "Embedding list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of files that matched your query.", + "description": "Total number of embeddings that matched your query.", "x-example": 5, "format": "int32" }, - "files": { + "embeddings": { "type": "array", - "description": "List of files.", + "description": "List of embeddings.", "items": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/embedding" }, "x-example": "" } }, "required": [ "total", - "files" + "embeddings" ], "example": { "total": 5, - "files": "" + "embeddings": "" } }, - "bucketList": { - "description": "Buckets List", + "database": { + "description": "Database", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of buckets that matched your query.", - "x-example": 5, - "format": "int32" + "$id": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" }, - "buckets": { + "name": { + "type": "string", + "description": "Database name.", + "x-example": "My Database" + }, + "$createdAt": { + "type": "string", + "description": "Database creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Database update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "enabled": { + "type": "boolean", + "description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "type": { + "type": "string", + "description": "Database type.", + "x-example": "legacy", + "enum": [ + "legacy", + "tablesdb", + "documentsdb", + "vectorsdb" + ] + }, + "policies": { "type": "array", - "description": "List of buckets.", + "description": "Database backup policies.", "items": { - "$ref": "#\/components\/schemas\/bucket" + "$ref": "#\/components\/schemas\/index" }, - "x-example": "" + "x-example": {} + }, + "archives": { + "type": "array", + "description": "Database backup archives.", + "items": { + "$ref": "#\/components\/schemas\/collection" + }, + "x-example": {} } }, "required": [ - "total", - "buckets" + "$id", + "name", + "$createdAt", + "$updatedAt", + "enabled", + "type", + "policies", + "archives" ], "example": { - "total": 5, - "buckets": "" + "$id": "5e5ea5c16897e", + "name": "My Database", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "enabled": false, + "type": "legacy", + "policies": {}, + "archives": {} } }, - "resourceTokenList": { - "description": "Resource Tokens List", + "embedding": { + "description": "Embedding", "type": "object", "properties": { - "total": { + "model": { + "type": "string", + "description": "Embedding model used to generate embeddings.", + "x-example": "embeddinggemma" + }, + "dimension": { "type": "integer", - "description": "Total number of tokens that matched your query.", - "x-example": 5, + "description": "Number of dimensions for each embedding vector.", + "x-example": 768, "format": "int32" }, - "tokens": { + "embedding": { "type": "array", - "description": "List of tokens.", + "description": "Embedding vector values. If an error occurs, this will be an empty array.", "items": { - "$ref": "#\/components\/schemas\/resourceToken" + "type": "number", + "format": "double" }, - "x-example": "" + "x-example": [ + 0.01, + 0.02, + 0.03 + ] + }, + "error": { + "type": "string", + "description": "Error message if embedding generation fails. Empty string if no error.", + "x-example": "Error message" } }, "required": [ - "total", - "tokens" + "model", + "dimension", + "embedding", + "error" ], "example": { - "total": 5, - "tokens": "" + "model": "embeddinggemma", + "dimension": 768, + "embedding": [ + 0.01, + 0.02, + 0.03 + ], + "error": "Error message" } }, - "teamList": { - "description": "Teams List", + "collection": { + "description": "Collection", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of teams that matched your query.", - "x-example": 5, - "format": "int32" + "$id": { + "type": "string", + "description": "Collection ID.", + "x-example": "5e5ea5c16897e" }, - "teams": { + "$createdAt": { + "type": "string", + "description": "Collection creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Collection update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { "type": "array", - "description": "List of teams.", + "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "items": { - "$ref": "#\/components\/schemas\/team" + "type": "string" }, - "x-example": "" + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Collection name.", + "x-example": "My Collection" + }, + "enabled": { + "type": "boolean", + "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "documentSecurity": { + "type": "boolean", + "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "attributes": { + "type": "array", + "description": "Collection attributes.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/attributeBoolean" + }, + { + "$ref": "#\/components\/schemas\/attributeInteger" + }, + { + "$ref": "#\/components\/schemas\/attributeFloat" + }, + { + "$ref": "#\/components\/schemas\/attributeEmail" + }, + { + "$ref": "#\/components\/schemas\/attributeEnum" + }, + { + "$ref": "#\/components\/schemas\/attributeUrl" + }, + { + "$ref": "#\/components\/schemas\/attributeIp" + }, + { + "$ref": "#\/components\/schemas\/attributeDatetime" + }, + { + "$ref": "#\/components\/schemas\/attributeRelationship" + }, + { + "$ref": "#\/components\/schemas\/attributePoint" + }, + { + "$ref": "#\/components\/schemas\/attributeLine" + }, + { + "$ref": "#\/components\/schemas\/attributePolygon" + }, + { + "$ref": "#\/components\/schemas\/attributeVarchar" + }, + { + "$ref": "#\/components\/schemas\/attributeText" + }, + { + "$ref": "#\/components\/schemas\/attributeMediumtext" + }, + { + "$ref": "#\/components\/schemas\/attributeLongtext" + }, + { + "$ref": "#\/components\/schemas\/attributeString" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/components\/schemas\/attributeBoolean", + "integer": "#\/components\/schemas\/attributeInteger", + "double": "#\/components\/schemas\/attributeFloat", + "string": "#\/components\/schemas\/attributeString", + "datetime": "#\/components\/schemas\/attributeDatetime", + "relationship": "#\/components\/schemas\/attributeRelationship", + "point": "#\/components\/schemas\/attributePoint", + "linestring": "#\/components\/schemas\/attributeLine", + "polygon": "#\/components\/schemas\/attributePolygon", + "varchar": "#\/components\/schemas\/attributeVarchar", + "text": "#\/components\/schemas\/attributeText", + "mediumtext": "#\/components\/schemas\/attributeMediumtext", + "longtext": "#\/components\/schemas\/attributeLongtext" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/components\/schemas\/attributeBoolean": { + "type": "boolean" + }, + "#\/components\/schemas\/attributeInteger": { + "type": "integer" + }, + "#\/components\/schemas\/attributeFloat": { + "type": "double" + }, + "#\/components\/schemas\/attributeEmail": { + "type": "string", + "format": "email" + }, + "#\/components\/schemas\/attributeEnum": { + "type": "string", + "format": "enum" + }, + "#\/components\/schemas\/attributeUrl": { + "type": "string", + "format": "url" + }, + "#\/components\/schemas\/attributeIp": { + "type": "string", + "format": "ip" + }, + "#\/components\/schemas\/attributeDatetime": { + "type": "datetime" + }, + "#\/components\/schemas\/attributeRelationship": { + "type": "relationship" + }, + "#\/components\/schemas\/attributePoint": { + "type": "point" + }, + "#\/components\/schemas\/attributeLine": { + "type": "linestring" + }, + "#\/components\/schemas\/attributePolygon": { + "type": "polygon" + }, + "#\/components\/schemas\/attributeVarchar": { + "type": "varchar" + }, + "#\/components\/schemas\/attributeText": { + "type": "text" + }, + "#\/components\/schemas\/attributeMediumtext": { + "type": "mediumtext" + }, + "#\/components\/schemas\/attributeLongtext": { + "type": "longtext" + }, + "#\/components\/schemas\/attributeString": { + "type": "string" + } + } + } + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Collection indexes.", + "items": { + "$ref": "#\/components\/schemas\/index" + }, + "x-example": {} + }, + "bytesMax": { + "type": "integer", + "description": "Maximum document size in bytes. Returns 0 when no limit applies.", + "x-example": 65535, + "format": "int32" + }, + "bytesUsed": { + "type": "integer", + "description": "Currently used document size in bytes based on defined attributes.", + "x-example": 1500, + "format": "int32" } }, "required": [ - "total", - "teams" + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "documentSecurity", + "attributes", + "indexes", + "bytesMax", + "bytesUsed" ], "example": { - "total": 5, - "teams": "" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "databaseId": "5e5ea5c16897e", + "name": "My Collection", + "enabled": false, + "documentSecurity": true, + "attributes": {}, + "indexes": {}, + "bytesMax": 65535, + "bytesUsed": 1500 } }, - "membershipList": { - "description": "Memberships List", + "attributeList": { + "description": "Attributes List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of memberships that matched your query.", + "description": "Total number of attributes in the given collection.", "x-example": 5, "format": "int32" }, - "memberships": { + "attributes": { "type": "array", - "description": "List of memberships.", + "description": "List of attributes.", "items": { - "$ref": "#\/components\/schemas\/membership" + "anyOf": [ + { + "$ref": "#\/components\/schemas\/attributeBoolean" + }, + { + "$ref": "#\/components\/schemas\/attributeInteger" + }, + { + "$ref": "#\/components\/schemas\/attributeFloat" + }, + { + "$ref": "#\/components\/schemas\/attributeEmail" + }, + { + "$ref": "#\/components\/schemas\/attributeEnum" + }, + { + "$ref": "#\/components\/schemas\/attributeUrl" + }, + { + "$ref": "#\/components\/schemas\/attributeIp" + }, + { + "$ref": "#\/components\/schemas\/attributeDatetime" + }, + { + "$ref": "#\/components\/schemas\/attributeRelationship" + }, + { + "$ref": "#\/components\/schemas\/attributePoint" + }, + { + "$ref": "#\/components\/schemas\/attributeLine" + }, + { + "$ref": "#\/components\/schemas\/attributePolygon" + }, + { + "$ref": "#\/components\/schemas\/attributeVarchar" + }, + { + "$ref": "#\/components\/schemas\/attributeText" + }, + { + "$ref": "#\/components\/schemas\/attributeMediumtext" + }, + { + "$ref": "#\/components\/schemas\/attributeLongtext" + }, + { + "$ref": "#\/components\/schemas\/attributeString" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/components\/schemas\/attributeBoolean", + "integer": "#\/components\/schemas\/attributeInteger", + "double": "#\/components\/schemas\/attributeFloat", + "string": "#\/components\/schemas\/attributeString", + "datetime": "#\/components\/schemas\/attributeDatetime", + "relationship": "#\/components\/schemas\/attributeRelationship", + "point": "#\/components\/schemas\/attributePoint", + "linestring": "#\/components\/schemas\/attributeLine", + "polygon": "#\/components\/schemas\/attributePolygon", + "varchar": "#\/components\/schemas\/attributeVarchar", + "text": "#\/components\/schemas\/attributeText", + "mediumtext": "#\/components\/schemas\/attributeMediumtext", + "longtext": "#\/components\/schemas\/attributeLongtext" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/components\/schemas\/attributeBoolean": { + "type": "boolean" + }, + "#\/components\/schemas\/attributeInteger": { + "type": "integer" + }, + "#\/components\/schemas\/attributeFloat": { + "type": "double" + }, + "#\/components\/schemas\/attributeEmail": { + "type": "string", + "format": "email" + }, + "#\/components\/schemas\/attributeEnum": { + "type": "string", + "format": "enum" + }, + "#\/components\/schemas\/attributeUrl": { + "type": "string", + "format": "url" + }, + "#\/components\/schemas\/attributeIp": { + "type": "string", + "format": "ip" + }, + "#\/components\/schemas\/attributeDatetime": { + "type": "datetime" + }, + "#\/components\/schemas\/attributeRelationship": { + "type": "relationship" + }, + "#\/components\/schemas\/attributePoint": { + "type": "point" + }, + "#\/components\/schemas\/attributeLine": { + "type": "linestring" + }, + "#\/components\/schemas\/attributePolygon": { + "type": "polygon" + }, + "#\/components\/schemas\/attributeVarchar": { + "type": "varchar" + }, + "#\/components\/schemas\/attributeText": { + "type": "text" + }, + "#\/components\/schemas\/attributeMediumtext": { + "type": "mediumtext" + }, + "#\/components\/schemas\/attributeLongtext": { + "type": "longtext" + }, + "#\/components\/schemas\/attributeString": { + "type": "string" + } + } + } }, "x-example": "" } }, "required": [ "total", - "memberships" + "attributes" ], "example": { "total": 5, - "memberships": "" + "attributes": "" } }, - "siteList": { - "description": "Sites List", + "attributeString": { + "description": "AttributeString", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { "type": "integer", - "description": "Total number of sites that matched your query.", - "x-example": 5, + "description": "Attribute size.", + "x-example": 128, "format": "int32" }, - "sites": { - "type": "array", - "description": "List of sites.", - "items": { - "$ref": "#\/components\/schemas\/site" - }, - "x-example": "" + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ - "total", - "sites" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" ], "example": { - "total": 5, - "sites": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "size": 128, + "default": "default", + "encrypt": false } }, - "templateSiteList": { - "description": "Site Templates List", + "attributeInteger": { + "description": "AttributeInteger", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { "type": "integer", - "description": "Total number of templates that matched your query.", - "x-example": 5, - "format": "int32" + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true }, - "templates": { - "type": "array", - "description": "List of templates.", - "items": { - "$ref": "#\/components\/schemas\/templateSite" - }, - "x-example": "" - } - }, - "required": [ - "total", - "templates" - ], - "example": { - "total": 5, - "templates": "" - } - }, - "functionList": { - "description": "Functions List", - "type": "object", - "properties": { - "total": { + "max": { "type": "integer", - "description": "Total number of functions that matched your query.", - "x-example": 5, - "format": "int32" + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true }, - "functions": { - "type": "array", - "description": "List of functions.", - "items": { - "$ref": "#\/components\/schemas\/function" - }, - "x-example": "" + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "nullable": true } }, "required": [ - "total", - "functions" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "functions": "" + "key": "count", + "type": "integer", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 } }, - "templateFunctionList": { - "description": "Function Templates List", + "attributeFloat": { + "description": "AttributeFloat", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of templates that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "percentageCompleted" }, - "templates": { - "type": "array", - "description": "List of templates.", - "items": { - "$ref": "#\/components\/schemas\/templateFunction" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "nullable": true } }, "required": [ - "total", - "templates" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "templates": "" + "key": "percentageCompleted", + "type": "double", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1.5, + "max": 10.5, + "default": 2.5 } }, - "installationList": { - "description": "Installations List", + "attributeBoolean": { + "description": "AttributeBoolean", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of installations that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "isEnabled" }, - "installations": { - "type": "array", - "description": "List of installations.", - "items": { - "$ref": "#\/components\/schemas\/installation" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "nullable": true } }, "required": [ - "total", - "installations" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "installations": "" + "key": "isEnabled", + "type": "boolean", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": false } }, - "providerRepositoryFrameworkList": { - "description": "Framework Provider Repositories List", + "attributeEmail": { + "description": "AttributeEmail", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of frameworkProviderRepositories that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "userEmail" }, - "frameworkProviderRepositories": { - "type": "array", - "description": "List of frameworkProviderRepositories.", - "items": { - "$ref": "#\/components\/schemas\/providerRepositoryFramework" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "type": { + "format": { "type": "string", - "description": "Provider repository list type.", - "x-example": "framework" + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "nullable": true } }, "required": [ - "total", - "frameworkProviderRepositories", - "type" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "frameworkProviderRepositories": "", - "type": "framework" + "key": "userEmail", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "email", + "default": "default@example.com" } }, - "providerRepositoryRuntimeList": { - "description": "Runtime Provider Repositories List", + "attributeEnum": { + "description": "AttributeEnum", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of runtimeProviderRepositories that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "status" }, - "runtimeProviderRepositories": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { "type": "array", - "description": "List of runtimeProviderRepositories.", + "description": "Array of elements in enumerated type.", "items": { - "$ref": "#\/components\/schemas\/providerRepositoryRuntime" + "type": "string" }, - "x-example": "" + "x-example": "element" }, - "type": { + "format": { "type": "string", - "description": "Provider repository list type.", - "x-example": "runtime" + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "nullable": true } }, "required": [ - "total", - "runtimeProviderRepositories", - "type" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" ], "example": { - "total": 5, - "runtimeProviderRepositories": "", - "type": "runtime" + "key": "status", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "elements": "element", + "format": "enum", + "default": "element" } }, - "branchList": { - "description": "Branches List", + "attributeIp": { + "description": "AttributeIP", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of branches that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "ipAddress" }, - "branches": { - "type": "array", - "description": "List of branches.", - "items": { - "$ref": "#\/components\/schemas\/branch" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "nullable": true } }, "required": [ - "total", - "branches" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "branches": "" + "key": "ipAddress", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "ip", + "default": "192.0.2.0" } }, - "frameworkList": { - "description": "Frameworks List", + "attributeUrl": { + "description": "AttributeURL", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of frameworks that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "githubUrl" }, - "frameworks": { - "type": "array", - "description": "List of frameworks.", - "items": { - "$ref": "#\/components\/schemas\/framework" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "http:\/\/example.com", + "nullable": true } }, "required": [ - "total", - "frameworks" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "frameworks": "" + "key": "githubUrl", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "url", + "default": "http:\/\/example.com" } }, - "runtimeList": { - "description": "Runtimes List", + "attributeDatetime": { + "description": "AttributeDatetime", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of runtimes that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "birthDay" }, - "runtimes": { - "type": "array", - "description": "List of runtimes.", - "items": { - "$ref": "#\/components\/schemas\/runtime" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true } }, "required": [ - "total", - "runtimes" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "runtimes": "" + "key": "birthDay", + "type": "datetime", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "deploymentList": { - "description": "Deployments List", + "attributeRelationship": { + "description": "AttributeRelationship", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of deployments that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedCollection": { + "type": "string", + "description": "The ID of the related collection.", + "x-example": "collection" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" }, - "deployments": { - "type": "array", - "description": "List of deployments.", - "items": { - "$ref": "#\/components\/schemas\/deployment" - }, - "x-example": "" + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ - "total", - "deployments" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedCollection", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { - "total": 5, - "deployments": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "relatedCollection": "collection", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "executionList": { - "description": "Executions List", + "attributePoint": { + "description": "AttributePoint", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of executions that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "executions": { - "type": "array", - "description": "List of executions.", - "items": { - "$ref": "#\/components\/schemas\/execution" - }, - "x-example": "" - } - }, - "required": [ - "total", - "executions" - ], - "example": { - "total": 5, - "executions": "" - } - }, - "projectList": { - "description": "Projects List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of projects that matched your query.", - "x-example": 5, - "format": "int32" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" }, - "projects": { - "type": "array", - "description": "List of projects.", - "items": { - "$ref": "#\/components\/schemas\/project" - }, - "x-example": "" - } - }, - "required": [ - "total", - "projects" - ], - "example": { - "total": 5, - "projects": "" - } - }, - "webhookList": { - "description": "Webhooks List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of webhooks that matched your query.", - "x-example": 5, - "format": "int32" + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" }, - "webhooks": { - "type": "array", - "description": "List of webhooks.", - "items": { - "$ref": "#\/components\/schemas\/webhook" - }, - "x-example": "" - } - }, - "required": [ - "total", - "webhooks" - ], - "example": { - "total": 5, - "webhooks": "" - } - }, - "keyList": { - "description": "API Keys List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of keys that matched your query.", - "x-example": 5, - "format": "int32" + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" }, - "keys": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { "type": "array", - "description": "List of keys.", - "items": { - "$ref": "#\/components\/schemas\/key" - }, - "x-example": "" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": [ + 0, + 0 + ], + "nullable": true } }, "required": [ - "total", - "keys" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "keys": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + 0, + 0 + ] } }, - "devKeyList": { - "description": "Dev Keys List", + "attributeLine": { + "description": "AttributeLine", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of devKeys that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "devKeys": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { "type": "array", - "description": "List of devKeys.", - "items": { - "$ref": "#\/components\/schemas\/devKey" - }, - "x-example": "" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], + "nullable": true } }, "required": [ - "total", - "devKeys" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "devKeys": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "countryList": { - "description": "Countries List", + "attributePolygon": { + "description": "AttributePolygon", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of countries that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "countries": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { "type": "array", - "description": "List of countries.", - "items": { - "$ref": "#\/components\/schemas\/country" - }, - "x-example": "" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], + "nullable": true } }, "required": [ - "total", - "countries" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "countries": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, - "continentList": { - "description": "Continents List", + "attributeVarchar": { + "description": "AttributeVarchar", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { "type": "integer", - "description": "Total number of continents that matched your query.", - "x-example": 5, + "description": "Attribute size.", + "x-example": 128, "format": "int32" }, - "continents": { - "type": "array", - "description": "List of continents.", - "items": { - "$ref": "#\/components\/schemas\/continent" - }, - "x-example": "" + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ - "total", - "continents" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" ], "example": { - "total": 5, - "continents": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "size": 128, + "default": "default", + "encrypt": false } }, - "languageList": { - "description": "Languages List", + "attributeText": { + "description": "AttributeText", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of languages that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "languages": { - "type": "array", - "description": "List of languages.", - "items": { - "$ref": "#\/components\/schemas\/language" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ - "total", - "languages" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "languages": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "currencyList": { - "description": "Currencies List", + "attributeMediumtext": { + "description": "AttributeMediumtext", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of currencies that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "currencies": { - "type": "array", - "description": "List of currencies.", - "items": { - "$ref": "#\/components\/schemas\/currency" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ - "total", - "currencies" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "currencies": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "phoneList": { - "description": "Phones List", + "attributeLongtext": { + "description": "AttributeLongtext", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of phones that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "phones": { - "type": "array", - "description": "List of phones.", - "items": { - "$ref": "#\/components\/schemas\/phone" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ - "total", - "phones" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "phones": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "variableList": { - "description": "Variables List", + "usageDocumentsDB": { + "description": "UsageDocumentsDB", "type": "object", "properties": { - "total": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "collectionsTotal": { "type": "integer", - "description": "Total number of variables that matched your query.", - "x-example": 5, + "description": "Total aggregated number of collections.", + "x-example": 0, "format": "int32" }, - "variables": { - "type": "array", - "description": "List of variables.", - "items": { - "$ref": "#\/components\/schemas\/variable" - }, - "x-example": "" - } - }, - "required": [ - "total", - "variables" - ], - "example": { - "total": 5, - "variables": "" - } - }, - "healthStatusList": { - "description": "Status List", - "type": "object", - "properties": { - "total": { + "documentsTotal": { "type": "integer", - "description": "Total number of statuses that matched your query.", - "x-example": 5, + "description": "Total aggregated number of documents.", + "x-example": 0, "format": "int32" }, - "statuses": { - "type": "array", - "description": "List of statuses.", - "items": { - "$ref": "#\/components\/schemas\/healthStatus" - }, - "x-example": "" - } - }, - "required": [ - "total", - "statuses" - ], - "example": { - "total": 5, - "statuses": "" - } - }, - "proxyRuleList": { - "description": "Rule List", - "type": "object", - "properties": { - "total": { + "storageTotal": { "type": "integer", - "description": "Total number of rules that matched your query.", - "x-example": 5, + "description": "Total aggregated storage used in bytes.", + "x-example": 0, "format": "int32" }, - "rules": { - "type": "array", - "description": "List of rules.", - "items": { - "$ref": "#\/components\/schemas\/proxyRule" - }, - "x-example": "" - } - }, - "required": [ - "total", - "rules" - ], - "example": { - "total": 5, - "rules": "" - } - }, - "scheduleList": { - "description": "Schedules List", - "type": "object", - "properties": { - "total": { + "databaseReadsTotal": { "type": "integer", - "description": "Total number of schedules that matched your query.", - "x-example": 5, + "description": "Total number of database reads.", + "x-example": 0, "format": "int32" }, - "schedules": { + "databaseWritesTotal": { + "type": "integer", + "description": "Total number of database writes.", + "x-example": 0, + "format": "int32" + }, + "collections": { "type": "array", - "description": "List of schedules.", + "description": "Aggregated number of collections per period.", "items": { - "$ref": "#\/components\/schemas\/schedule" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "schedules" - ], - "example": { - "total": 5, - "schedules": "" - } - }, - "localeCodeList": { - "description": "Locale codes list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of localeCodes that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, - "localeCodes": { + "documents": { "type": "array", - "description": "List of localeCodes.", + "description": "Aggregated number of documents per period.", "items": { - "$ref": "#\/components\/schemas\/localeCode" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "localeCodes" - ], - "example": { - "total": 5, - "localeCodes": "" - } - }, - "providerList": { - "description": "Provider list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of providers that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, - "providers": { + "storage": { "type": "array", - "description": "List of providers.", + "description": "Aggregated storage used in bytes per period.", "items": { - "$ref": "#\/components\/schemas\/provider" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "providers" - ], - "example": { - "total": 5, - "providers": "" - } - }, - "messageList": { - "description": "Message list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of messages that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, - "messages": { + "databaseReads": { "type": "array", - "description": "List of messages.", + "description": "An array of aggregated number of database reads.", "items": { - "$ref": "#\/components\/schemas\/message" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "messages" - ], - "example": { - "total": 5, - "messages": "" - } - }, - "topicList": { - "description": "Topic list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of topics that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, - "topics": { + "databaseWrites": { "type": "array", - "description": "List of topics.", + "description": "An array of aggregated number of database writes.", "items": { - "$ref": "#\/components\/schemas\/topic" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": "" + "x-example": [] } }, "required": [ - "total", - "topics" + "range", + "collectionsTotal", + "documentsTotal", + "storageTotal", + "databaseReadsTotal", + "databaseWritesTotal", + "collections", + "documents", + "storage", + "databaseReads", + "databaseWrites" ], "example": { - "total": 5, - "topics": "" + "range": "30d", + "collectionsTotal": 0, + "documentsTotal": 0, + "storageTotal": 0, + "databaseReadsTotal": 0, + "databaseWritesTotal": 0, + "collections": [], + "documents": [], + "storage": [], + "databaseReads": [], + "databaseWrites": [] } }, - "subscriberList": { - "description": "Subscriber list", + "vectorsdbCollection": { + "description": "VectorsDB Collection", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of subscribers that matched your query.", - "x-example": 5, - "format": "int32" + "$id": { + "type": "string", + "description": "Collection ID.", + "x-example": "5e5ea5c16897e" }, - "subscribers": { + "$createdAt": { + "type": "string", + "description": "Collection creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Collection update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { "type": "array", - "description": "List of subscribers.", + "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "items": { - "$ref": "#\/components\/schemas\/subscriber" + "type": "string" }, - "x-example": "" - } - }, - "required": [ - "total", - "subscribers" - ], - "example": { - "total": 5, - "subscribers": "" - } - }, - "targetList": { - "description": "Target list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of targets that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [ + "read(\"any\")" + ] }, - "targets": { + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Collection name.", + "x-example": "My Collection" + }, + "enabled": { + "type": "boolean", + "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "documentSecurity": { + "type": "boolean", + "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "attributes": { "type": "array", - "description": "List of targets.", + "description": "Collection attributes.", "items": { - "$ref": "#\/components\/schemas\/target" + "anyOf": [ + { + "$ref": "#\/components\/schemas\/attributeObject" + }, + { + "$ref": "#\/components\/schemas\/attributeVector" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "object": "#\/components\/schemas\/attributeObject", + "vector": "#\/components\/schemas\/attributeVector" + } + } }, - "x-example": "" - } - }, - "required": [ - "total", - "targets" - ], - "example": { - "total": 5, - "targets": "" - } - }, - "transactionList": { - "description": "Transaction List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of transactions that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": {} }, - "transactions": { + "indexes": { "type": "array", - "description": "List of transactions.", + "description": "Collection indexes.", "items": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/index" }, - "x-example": "" + "x-example": {} + }, + "bytesMax": { + "type": "integer", + "description": "Maximum document size in bytes. Returns 0 when no limit applies.", + "x-example": 65535, + "format": "int32" + }, + "bytesUsed": { + "type": "integer", + "description": "Currently used document size in bytes based on defined attributes.", + "x-example": 1500, + "format": "int32" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimension.", + "x-example": 1536, + "format": "int32" } }, "required": [ - "total", - "transactions" + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "documentSecurity", + "attributes", + "indexes", + "bytesMax", + "bytesUsed", + "dimension" ], "example": { - "total": 5, - "transactions": "" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "databaseId": "5e5ea5c16897e", + "name": "My Collection", + "enabled": false, + "documentSecurity": true, + "attributes": {}, + "indexes": {}, + "bytesMax": 65535, + "bytesUsed": 1500, + "dimension": 1536 } }, - "migrationList": { - "description": "Migrations List", + "attributeObject": { + "description": "AttributeObject", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of migrations that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "migrations": { - "type": "array", - "description": "List of migrations.", - "items": { - "$ref": "#\/components\/schemas\/migration" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "total", - "migrations" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "migrations": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "specificationList": { - "description": "Specifications List", + "attributeVector": { + "description": "AttributeVector", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { "type": "integer", - "description": "Total number of specifications that matched your query.", - "x-example": 5, + "description": "Vector dimensions.", + "x-example": 1536, "format": "int32" - }, - "specifications": { - "type": "array", - "description": "List of specifications.", - "items": { - "$ref": "#\/components\/schemas\/specification" - }, - "x-example": "" } }, "required": [ - "total", - "specifications" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" ], "example": { - "total": 5, - "specifications": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "size": 1536 } }, - "vcsContentList": { - "description": "VCS Content List", + "usageVectorsDBs": { + "description": "UsageVectorsDBs", "type": "object", "properties": { - "total": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "databasesTotal": { "type": "integer", - "description": "Total number of contents that matched your query.", - "x-example": 5, + "description": "Total aggregated number of VectorsDB databases.", + "x-example": 0, "format": "int32" }, - "contents": { + "collectionsTotal": { + "type": "integer", + "description": "Total aggregated number of collections.", + "x-example": 0, + "format": "int32" + }, + "documentsTotal": { + "type": "integer", + "description": "Total aggregated number of documents.", + "x-example": 0, + "format": "int32" + }, + "storageTotal": { + "type": "integer", + "description": "Total aggregated storage in bytes.", + "x-example": 0, + "format": "int32" + }, + "databasesReadsTotal": { + "type": "integer", + "description": "Total number of database reads.", + "x-example": 0, + "format": "int32" + }, + "databasesWritesTotal": { + "type": "integer", + "description": "Total number of database writes.", + "x-example": 0, + "format": "int32" + }, + "databases": { "type": "array", - "description": "List of contents.", + "description": "Aggregated number of databases per period.", "items": { - "$ref": "#\/components\/schemas\/vcsContent" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "contents" - ], - "example": { - "total": 5, - "contents": "" - } - }, - "vectorsdbCollectionList": { - "description": "VectorsDB Collections List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of collections that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, "collections": { "type": "array", - "description": "List of collections.", + "description": "Aggregated number of collections per period.", "items": { - "$ref": "#\/components\/schemas\/vectorsdbCollection" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "collections" - ], - "example": { - "total": 5, - "collections": "" - } - }, - "embeddingList": { - "description": "Embedding list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of embeddings that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] + }, + "documents": { + "type": "array", + "description": "Aggregated number of documents per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] }, - "embeddings": { + "storage": { "type": "array", - "description": "List of embeddings.", + "description": "Aggregated storage in bytes per period.", "items": { - "$ref": "#\/components\/schemas\/embedding" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": "" + "x-example": [] + }, + "databasesReads": { + "type": "array", + "description": "An array of aggregated number of database reads.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "databasesWrites": { + "type": "array", + "description": "An array of aggregated number of database writes.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] } }, "required": [ - "total", - "embeddings" + "range", + "databasesTotal", + "collectionsTotal", + "documentsTotal", + "storageTotal", + "databasesReadsTotal", + "databasesWritesTotal", + "databases", + "collections", + "documents", + "storage", + "databasesReads", + "databasesWrites" ], "example": { - "total": 5, - "embeddings": "" + "range": "30d", + "databasesTotal": 0, + "collectionsTotal": 0, + "documentsTotal": 0, + "storageTotal": 0, + "databasesReadsTotal": 0, + "databasesWritesTotal": 0, + "databases": [], + "collections": [], + "documents": [], + "storage": [], + "databasesReads": [], + "databasesWrites": [] } }, - "database": { - "description": "Database", + "usageVectorsDB": { + "description": "UsageVectorsDB", "type": "object", "properties": { - "$id": { + "range": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "Time range of the usage stats.", + "x-example": "30d" }, - "name": { - "type": "string", - "description": "Database name.", - "x-example": "My Database" + "collectionsTotal": { + "type": "integer", + "description": "Total aggregated number of collections.", + "x-example": 0, + "format": "int32" }, - "$createdAt": { - "type": "string", - "description": "Database creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "documentsTotal": { + "type": "integer", + "description": "Total aggregated number of documents.", + "x-example": 0, + "format": "int32" }, - "$updatedAt": { - "type": "string", - "description": "Database update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "storageTotal": { + "type": "integer", + "description": "Total aggregated storage used in bytes.", + "x-example": 0, + "format": "int32" }, - "enabled": { - "type": "boolean", - "description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "databaseReadsTotal": { + "type": "integer", + "description": "Total number of database reads.", + "x-example": 0, + "format": "int32" }, - "type": { - "type": "string", - "description": "Database type.", - "x-example": "legacy", - "enum": [ - "legacy", - "tablesdb", - "documentsdb", - "vectorsdb" - ] + "databaseWritesTotal": { + "type": "integer", + "description": "Total number of database writes.", + "x-example": 0, + "format": "int32" }, - "policies": { + "collections": { "type": "array", - "description": "Database backup policies.", + "description": "Aggregated number of collections per period.", "items": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": {} + "x-example": [] }, - "archives": { + "documents": { "type": "array", - "description": "Database backup archives.", + "description": "Aggregated number of documents per period.", "items": { - "$ref": "#\/components\/schemas\/collection" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": {} - } - }, - "required": [ - "$id", - "name", - "$createdAt", - "$updatedAt", - "enabled", - "type", - "policies", - "archives" - ], - "example": { - "$id": "5e5ea5c16897e", - "name": "My Database", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "enabled": false, - "type": "legacy", - "policies": {}, - "archives": {} - } - }, - "embedding": { - "description": "Embedding", - "type": "object", - "properties": { - "model": { - "type": "string", - "description": "Embedding model used to generate embeddings.", - "x-example": "embeddinggemma" + "x-example": [] }, - "dimension": { - "type": "integer", - "description": "Number of dimensions for each embedding vector.", - "x-example": 768, - "format": "int32" + "storage": { + "type": "array", + "description": "Aggregated storage used in bytes per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] }, - "embedding": { + "databaseReads": { "type": "array", - "description": "Embedding vector values. If an error occurs, this will be an empty array.", + "description": "An array of aggregated number of database reads.", "items": { - "type": "number", - "format": "double" + "$ref": "#\/components\/schemas\/metric" }, - "x-example": [ - 0.01, - 0.02, - 0.03 - ] + "x-example": [] }, - "error": { - "type": "string", - "description": "Error message if embedding generation fails. Empty string if no error.", - "x-example": "Error message" + "databaseWrites": { + "type": "array", + "description": "An array of aggregated number of database writes.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] } }, "required": [ - "model", - "dimension", - "embedding", - "error" + "range", + "collectionsTotal", + "documentsTotal", + "storageTotal", + "databaseReadsTotal", + "databaseWritesTotal", + "collections", + "documents", + "storage", + "databaseReads", + "databaseWrites" ], "example": { - "model": "embeddinggemma", - "dimension": 768, - "embedding": [ - 0.01, - 0.02, - 0.03 - ], - "error": "Error message" + "range": "30d", + "collectionsTotal": 0, + "documentsTotal": 0, + "storageTotal": 0, + "databaseReadsTotal": 0, + "databaseWritesTotal": 0, + "collections": [], + "documents": [], + "storage": [], + "databaseReads": [], + "databaseWrites": [] } }, - "collection": { - "description": "Collection", + "table": { + "description": "Table", "type": "object", "properties": { "$id": { "type": "string", - "description": "Collection ID.", + "description": "Table ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Collection creation date in ISO 8601 format.", + "description": "Table creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Collection update date in ISO 8601 format.", + "description": "Table update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", - "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "items": { "type": "string" }, @@ -71058,151 +78511,151 @@ }, "name": { "type": "string", - "description": "Collection name.", - "x-example": "My Collection" + "description": "Table name.", + "x-example": "My Table" }, "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.", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", "x-example": false }, - "documentSecurity": { + "rowSecurity": { "type": "boolean", - "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": true }, - "attributes": { + "columns": { "type": "array", - "description": "Collection attributes.", + "description": "Table columns.", "items": { "anyOf": [ { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/columnBoolean" }, { - "$ref": "#\/components\/schemas\/attributeInteger" + "$ref": "#\/components\/schemas\/columnInteger" }, { - "$ref": "#\/components\/schemas\/attributeFloat" + "$ref": "#\/components\/schemas\/columnFloat" }, { - "$ref": "#\/components\/schemas\/attributeEmail" + "$ref": "#\/components\/schemas\/columnEmail" }, { - "$ref": "#\/components\/schemas\/attributeEnum" + "$ref": "#\/components\/schemas\/columnEnum" }, { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/columnUrl" }, { - "$ref": "#\/components\/schemas\/attributeIp" + "$ref": "#\/components\/schemas\/columnIp" }, { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/columnDatetime" }, { - "$ref": "#\/components\/schemas\/attributeRelationship" + "$ref": "#\/components\/schemas\/columnRelationship" }, { - "$ref": "#\/components\/schemas\/attributePoint" + "$ref": "#\/components\/schemas\/columnPoint" }, { - "$ref": "#\/components\/schemas\/attributeLine" + "$ref": "#\/components\/schemas\/columnLine" }, { - "$ref": "#\/components\/schemas\/attributePolygon" + "$ref": "#\/components\/schemas\/columnPolygon" }, { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/columnVarchar" }, { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/columnText" }, { - "$ref": "#\/components\/schemas\/attributeMediumtext" + "$ref": "#\/components\/schemas\/columnMediumtext" }, { - "$ref": "#\/components\/schemas\/attributeLongtext" + "$ref": "#\/components\/schemas\/columnLongtext" }, { - "$ref": "#\/components\/schemas\/attributeString" + "$ref": "#\/components\/schemas\/columnString" } ], "discriminator": { "propertyName": "type", "mapping": { - "boolean": "#\/components\/schemas\/attributeBoolean", - "integer": "#\/components\/schemas\/attributeInteger", - "double": "#\/components\/schemas\/attributeFloat", - "string": "#\/components\/schemas\/attributeString", - "datetime": "#\/components\/schemas\/attributeDatetime", - "relationship": "#\/components\/schemas\/attributeRelationship", - "point": "#\/components\/schemas\/attributePoint", - "linestring": "#\/components\/schemas\/attributeLine", - "polygon": "#\/components\/schemas\/attributePolygon", - "varchar": "#\/components\/schemas\/attributeVarchar", - "text": "#\/components\/schemas\/attributeText", - "mediumtext": "#\/components\/schemas\/attributeMediumtext", - "longtext": "#\/components\/schemas\/attributeLongtext" + "boolean": "#\/components\/schemas\/columnBoolean", + "integer": "#\/components\/schemas\/columnInteger", + "double": "#\/components\/schemas\/columnFloat", + "string": "#\/components\/schemas\/columnString", + "datetime": "#\/components\/schemas\/columnDatetime", + "relationship": "#\/components\/schemas\/columnRelationship", + "point": "#\/components\/schemas\/columnPoint", + "linestring": "#\/components\/schemas\/columnLine", + "polygon": "#\/components\/schemas\/columnPolygon", + "varchar": "#\/components\/schemas\/columnVarchar", + "text": "#\/components\/schemas\/columnText", + "mediumtext": "#\/components\/schemas\/columnMediumtext", + "longtext": "#\/components\/schemas\/columnLongtext" }, "x-propertyNames": [ "type", "format" ], "x-mapping": { - "#\/components\/schemas\/attributeBoolean": { + "#\/components\/schemas\/columnBoolean": { "type": "boolean" }, - "#\/components\/schemas\/attributeInteger": { + "#\/components\/schemas\/columnInteger": { "type": "integer" }, - "#\/components\/schemas\/attributeFloat": { + "#\/components\/schemas\/columnFloat": { "type": "double" }, - "#\/components\/schemas\/attributeEmail": { + "#\/components\/schemas\/columnEmail": { "type": "string", "format": "email" }, - "#\/components\/schemas\/attributeEnum": { + "#\/components\/schemas\/columnEnum": { "type": "string", "format": "enum" }, - "#\/components\/schemas\/attributeUrl": { + "#\/components\/schemas\/columnUrl": { "type": "string", "format": "url" }, - "#\/components\/schemas\/attributeIp": { + "#\/components\/schemas\/columnIp": { "type": "string", "format": "ip" }, - "#\/components\/schemas\/attributeDatetime": { + "#\/components\/schemas\/columnDatetime": { "type": "datetime" }, - "#\/components\/schemas\/attributeRelationship": { + "#\/components\/schemas\/columnRelationship": { "type": "relationship" }, - "#\/components\/schemas\/attributePoint": { + "#\/components\/schemas\/columnPoint": { "type": "point" }, - "#\/components\/schemas\/attributeLine": { + "#\/components\/schemas\/columnLine": { "type": "linestring" }, - "#\/components\/schemas\/attributePolygon": { + "#\/components\/schemas\/columnPolygon": { "type": "polygon" }, - "#\/components\/schemas\/attributeVarchar": { + "#\/components\/schemas\/columnVarchar": { "type": "varchar" }, - "#\/components\/schemas\/attributeText": { + "#\/components\/schemas\/columnText": { "type": "text" }, - "#\/components\/schemas\/attributeMediumtext": { + "#\/components\/schemas\/columnMediumtext": { "type": "mediumtext" }, - "#\/components\/schemas\/attributeLongtext": { + "#\/components\/schemas\/columnLongtext": { "type": "longtext" }, - "#\/components\/schemas\/attributeString": { + "#\/components\/schemas\/columnString": { "type": "string" } } @@ -71212,21 +78665,21 @@ }, "indexes": { "type": "array", - "description": "Collection indexes.", + "description": "Table indexes.", "items": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/columnIndex" }, "x-example": {} }, "bytesMax": { "type": "integer", - "description": "Maximum document size in bytes. Returns 0 when no limit applies.", + "description": "Maximum row size in bytes. Returns 0 when no limit applies.", "x-example": 65535, "format": "int32" }, "bytesUsed": { "type": "integer", - "description": "Currently used document size in bytes based on defined attributes.", + "description": "Currently used row size in bytes based on defined columns.", "x-example": 1500, "format": "int32" } @@ -71239,8 +78692,8 @@ "databaseId", "name", "enabled", - "documentSecurity", - "attributes", + "rowSecurity", + "columns", "indexes", "bytesMax", "bytesUsed" @@ -71253,157 +78706,157 @@ "read(\"any\")" ], "databaseId": "5e5ea5c16897e", - "name": "My Collection", + "name": "My Table", "enabled": false, - "documentSecurity": true, - "attributes": {}, + "rowSecurity": true, + "columns": {}, "indexes": {}, "bytesMax": 65535, "bytesUsed": 1500 } }, - "attributeList": { - "description": "Attributes List", + "columnList": { + "description": "Columns List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of attributes in the given collection.", + "description": "Total number of columns in the given table.", "x-example": 5, "format": "int32" }, - "attributes": { + "columns": { "type": "array", - "description": "List of attributes.", + "description": "List of columns.", "items": { "anyOf": [ { - "$ref": "#\/components\/schemas\/attributeBoolean" + "$ref": "#\/components\/schemas\/columnBoolean" }, { - "$ref": "#\/components\/schemas\/attributeInteger" + "$ref": "#\/components\/schemas\/columnInteger" }, { - "$ref": "#\/components\/schemas\/attributeFloat" + "$ref": "#\/components\/schemas\/columnFloat" }, { - "$ref": "#\/components\/schemas\/attributeEmail" + "$ref": "#\/components\/schemas\/columnEmail" }, { - "$ref": "#\/components\/schemas\/attributeEnum" + "$ref": "#\/components\/schemas\/columnEnum" }, { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/columnUrl" }, { - "$ref": "#\/components\/schemas\/attributeIp" + "$ref": "#\/components\/schemas\/columnIp" }, { - "$ref": "#\/components\/schemas\/attributeDatetime" + "$ref": "#\/components\/schemas\/columnDatetime" }, { - "$ref": "#\/components\/schemas\/attributeRelationship" + "$ref": "#\/components\/schemas\/columnRelationship" }, { - "$ref": "#\/components\/schemas\/attributePoint" + "$ref": "#\/components\/schemas\/columnPoint" }, { - "$ref": "#\/components\/schemas\/attributeLine" + "$ref": "#\/components\/schemas\/columnLine" }, { - "$ref": "#\/components\/schemas\/attributePolygon" + "$ref": "#\/components\/schemas\/columnPolygon" }, { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/columnVarchar" }, { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/columnText" }, { - "$ref": "#\/components\/schemas\/attributeMediumtext" + "$ref": "#\/components\/schemas\/columnMediumtext" }, { - "$ref": "#\/components\/schemas\/attributeLongtext" + "$ref": "#\/components\/schemas\/columnLongtext" }, { - "$ref": "#\/components\/schemas\/attributeString" + "$ref": "#\/components\/schemas\/columnString" } ], "discriminator": { "propertyName": "type", "mapping": { - "boolean": "#\/components\/schemas\/attributeBoolean", - "integer": "#\/components\/schemas\/attributeInteger", - "double": "#\/components\/schemas\/attributeFloat", - "string": "#\/components\/schemas\/attributeString", - "datetime": "#\/components\/schemas\/attributeDatetime", - "relationship": "#\/components\/schemas\/attributeRelationship", - "point": "#\/components\/schemas\/attributePoint", - "linestring": "#\/components\/schemas\/attributeLine", - "polygon": "#\/components\/schemas\/attributePolygon", - "varchar": "#\/components\/schemas\/attributeVarchar", - "text": "#\/components\/schemas\/attributeText", - "mediumtext": "#\/components\/schemas\/attributeMediumtext", - "longtext": "#\/components\/schemas\/attributeLongtext" + "boolean": "#\/components\/schemas\/columnBoolean", + "integer": "#\/components\/schemas\/columnInteger", + "double": "#\/components\/schemas\/columnFloat", + "string": "#\/components\/schemas\/columnString", + "datetime": "#\/components\/schemas\/columnDatetime", + "relationship": "#\/components\/schemas\/columnRelationship", + "point": "#\/components\/schemas\/columnPoint", + "linestring": "#\/components\/schemas\/columnLine", + "polygon": "#\/components\/schemas\/columnPolygon", + "varchar": "#\/components\/schemas\/columnVarchar", + "text": "#\/components\/schemas\/columnText", + "mediumtext": "#\/components\/schemas\/columnMediumtext", + "longtext": "#\/components\/schemas\/columnLongtext" }, "x-propertyNames": [ "type", "format" ], "x-mapping": { - "#\/components\/schemas\/attributeBoolean": { + "#\/components\/schemas\/columnBoolean": { "type": "boolean" }, - "#\/components\/schemas\/attributeInteger": { + "#\/components\/schemas\/columnInteger": { "type": "integer" }, - "#\/components\/schemas\/attributeFloat": { + "#\/components\/schemas\/columnFloat": { "type": "double" }, - "#\/components\/schemas\/attributeEmail": { + "#\/components\/schemas\/columnEmail": { "type": "string", "format": "email" }, - "#\/components\/schemas\/attributeEnum": { + "#\/components\/schemas\/columnEnum": { "type": "string", "format": "enum" }, - "#\/components\/schemas\/attributeUrl": { + "#\/components\/schemas\/columnUrl": { "type": "string", "format": "url" }, - "#\/components\/schemas\/attributeIp": { + "#\/components\/schemas\/columnIp": { "type": "string", "format": "ip" }, - "#\/components\/schemas\/attributeDatetime": { + "#\/components\/schemas\/columnDatetime": { "type": "datetime" }, - "#\/components\/schemas\/attributeRelationship": { + "#\/components\/schemas\/columnRelationship": { "type": "relationship" }, - "#\/components\/schemas\/attributePoint": { + "#\/components\/schemas\/columnPoint": { "type": "point" }, - "#\/components\/schemas\/attributeLine": { + "#\/components\/schemas\/columnLine": { "type": "linestring" }, - "#\/components\/schemas\/attributePolygon": { + "#\/components\/schemas\/columnPolygon": { "type": "polygon" }, - "#\/components\/schemas\/attributeVarchar": { + "#\/components\/schemas\/columnVarchar": { "type": "varchar" }, - "#\/components\/schemas\/attributeText": { + "#\/components\/schemas\/columnText": { "type": "text" }, - "#\/components\/schemas\/attributeMediumtext": { + "#\/components\/schemas\/columnMediumtext": { "type": "mediumtext" }, - "#\/components\/schemas\/attributeLongtext": { + "#\/components\/schemas\/columnLongtext": { "type": "longtext" }, - "#\/components\/schemas\/attributeString": { + "#\/components\/schemas\/columnString": { "type": "string" } } @@ -71414,30 +78867,30 @@ }, "required": [ "total", - "attributes" + "columns" ], "example": { "total": 5, - "attributes": "" + "columns": "" } }, - "attributeString": { - "description": "AttributeString", + "columnString": { + "description": "ColumnString", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71446,49 +78899,49 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", - "description": "Attribute size.", + "description": "Column size.", "x-example": 128, "format": "int32" }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": "default", "nullable": true }, "encrypt": { "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", + "description": "Defines whether this column is encrypted or not.", "x-example": false, "nullable": true } @@ -71517,23 +78970,23 @@ "encrypt": false } }, - "attributeInteger": { - "description": "AttributeInteger", + "columnInteger": { + "description": "ColumnInteger", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "count" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "integer" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71542,32 +78995,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "min": { @@ -71586,7 +79039,7 @@ }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": 10, "format": "int32", "nullable": true @@ -71615,23 +79068,23 @@ "default": 10 } }, - "attributeFloat": { - "description": "AttributeFloat", + "columnFloat": { + "description": "ColumnFloat", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "percentageCompleted" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "double" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71640,32 +79093,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "min": { @@ -71684,7 +79137,7 @@ }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": 2.5, "format": "double", "nullable": true @@ -71713,23 +79166,23 @@ "default": 2.5 } }, - "attributeBoolean": { - "description": "AttributeBoolean", + "columnBoolean": { + "description": "ColumnBoolean", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "isEnabled" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "boolean" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71738,37 +79191,37 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": false, "nullable": true } @@ -71794,23 +79247,23 @@ "default": false } }, - "attributeEmail": { - "description": "AttributeEmail", + "columnEmail": { + "description": "ColumnEmail", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "userEmail" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71819,32 +79272,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "format": { @@ -71854,7 +79307,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": "default@example.com", "nullable": true } @@ -71882,23 +79335,23 @@ "default": "default@example.com" } }, - "attributeEnum": { - "description": "AttributeEnum", + "columnEnum": { + "description": "ColumnEnum", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "status" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71907,32 +79360,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "elements": { @@ -71950,7 +79403,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": "element", "nullable": true } @@ -71980,111 +79433,23 @@ "default": "element" } }, - "attributeIp": { - "description": "AttributeIP", + "columnIp": { + "description": "ColumnIP", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "ipAddress" }, "type": { "type": "string", - "description": "Attribute type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "ip" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "192.0.2.0", - "nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" - ], - "example": { - "key": "ipAddress", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "ip", - "default": "192.0.2.0" - } - }, - "attributeUrl": { - "description": "AttributeURL", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "githubUrl" - }, - "type": { - "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72093,333 +79458,43 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "url" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", - "nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" - ], - "example": { - "key": "githubUrl", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "url", - "default": "http:\/\/example.com" - } - }, - "attributeDatetime": { - "description": "AttributeDatetime", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "birthDay" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "datetime" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "format": { - "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", - "nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" - ], - "example": { - "key": "birthDay", - "type": "datetime", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" - } - }, - "attributeRelationship": { - "description": "AttributeRelationship", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "relatedCollection": { - "type": "string", - "description": "The ID of the related collection.", - "x-example": "collection" - }, - "relationType": { - "type": "string", - "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" - }, - "twoWay": { - "type": "boolean", - "description": "Is the relationship two-way?", - "x-example": false - }, - "twoWayKey": { - "type": "string", - "description": "The key of the two-way relationship.", - "x-example": "string" - }, - "onDelete": { - "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" - }, - "side": { - "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "relatedCollection", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" - ], - "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "relatedCollection": "collection", - "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", - "twoWay": false, - "twoWayKey": "string", - "onDelete": "restrict|cascade|setNull", - "side": "parent|child" - } - }, - "attributePoint": { - "description": "AttributePoint", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "x-example": "ip" }, "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - 0, - 0 - ], + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "192.0.2.0", "nullable": true } }, @@ -72430,10 +79505,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -72441,29 +79517,27 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "attributeLine": { - "description": "AttributeLine", + "columnUrl": { + "description": "ColumnURL", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "githubUrl" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72472,47 +79546,43 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", "nullable": true } }, @@ -72523,10 +79593,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -72534,35 +79605,27 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ] + "format": "url", + "default": "https:\/\/example.com" } }, - "attributePolygon": { - "description": "AttributePolygon", + "columnDatetime": { + "description": "ColumnDatetime", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "birthDay" }, "type": { "type": "string", - "description": "Attribute type.", - "x-example": "string" + "description": "Column type.", + "x-example": "datetime" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72571,59 +79634,43 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ], + "type": "string", + "description": "Default value for column when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -72634,58 +79681,39 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "key": "birthDay", + "type": "datetime", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "attributeVarchar": { - "description": "AttributeVarchar", + "columnRelationship": { + "description": "ColumnRelationship", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72694,51 +79722,63 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" }, - "encrypt": { + "twoWay": { "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, - "nullable": true + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ @@ -72749,7 +79789,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -72760,28 +79805,31 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "relatedTable": "table", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "attributeText": { - "description": "AttributeText", + "columnPoint": { + "description": "ColumnPoint", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72790,44 +79838,41 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "type": "array", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": [ + 0, + 0 + ], "nullable": true } }, @@ -72849,27 +79894,29 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "attributeMediumtext": { - "description": "AttributeMediumtext", + "columnLine": { + "description": "ColumnLine", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72878,44 +79925,47 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "type": "array", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "nullable": true } }, @@ -72937,27 +79987,35 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "attributeLongtext": { - "description": "AttributeLongtext", + "columnPolygon": { + "description": "ColumnPolygon", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72966,44 +80024,59 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "type": "array", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "nullable": true } }, @@ -73022,268 +80095,146 @@ "status": "available", "error": "string", "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false - } - }, - "usageDocumentsDB": { - "description": "UsageDocumentsDB", - "type": "object", - "properties": { - "range": { - "type": "string", - "description": "Time range of the usage stats.", - "x-example": "30d" - }, - "collectionsTotal": { - "type": "integer", - "description": "Total aggregated number of collections.", - "x-example": 0, - "format": "int32" - }, - "documentsTotal": { - "type": "integer", - "description": "Total aggregated number of documents.", - "x-example": 0, - "format": "int32" - }, - "storageTotal": { - "type": "integer", - "description": "Total aggregated storage used in bytes.", - "x-example": 0, - "format": "int32" - }, - "databaseReadsTotal": { - "type": "integer", - "description": "Total number of database reads.", - "x-example": 0, - "format": "int32" - }, - "databaseWritesTotal": { - "type": "integer", - "description": "Total number of database writes.", - "x-example": 0, - "format": "int32" - }, - "collections": { - "type": "array", - "description": "Aggregated number of collections per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] - }, - "documents": { - "type": "array", - "description": "Aggregated number of documents per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] - }, - "storage": { - "type": "array", - "description": "Aggregated storage used in bytes per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] - }, - "databaseReads": { - "type": "array", - "description": "An array of aggregated number of database reads.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] - }, - "databaseWrites": { - "type": "array", - "description": "An array of aggregated number of database writes.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] - } - }, - "required": [ - "range", - "collectionsTotal", - "documentsTotal", - "storageTotal", - "databaseReadsTotal", - "databaseWritesTotal", - "collections", - "documents", - "storage", - "databaseReads", - "databaseWrites" - ], - "example": { - "range": "30d", - "collectionsTotal": 0, - "documentsTotal": 0, - "storageTotal": 0, - "databaseReadsTotal": 0, - "databaseWritesTotal": 0, - "collections": [], - "documents": [], - "storage": [], - "databaseReads": [], - "databaseWrites": [] + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, - "vectorsdbCollection": { - "description": "VectorsDB Collection", + "columnVarchar": { + "description": "ColumnVarchar", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Collection ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { + "key": { "type": "string", - "description": "Collection creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Column Key.", + "x-example": "fullName" }, - "$updatedAt": { + "type": { "type": "string", - "description": "Collection update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "description": "Column type.", + "x-example": "string" }, - "databaseId": { + "status": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" }, - "name": { + "error": { "type": "string", - "description": "Collection name.", - "x-example": "My Collection" + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" }, - "enabled": { + "required": { "type": "boolean", - "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "description": "Is column required?", + "x-example": true }, - "documentSecurity": { + "array": { "type": "boolean", - "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "description": "Is column an array?", + "x-example": false, + "nullable": true }, - "attributes": { - "type": "array", - "description": "Collection attributes.", - "items": { - "anyOf": [ - { - "$ref": "#\/components\/schemas\/attributeObject" - }, - { - "$ref": "#\/components\/schemas\/attributeVector" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "object": "#\/components\/schemas\/attributeObject", - "vector": "#\/components\/schemas\/attributeVector" - } - } - }, - "x-example": {} + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "indexes": { - "type": "array", - "description": "Collection indexes.", - "items": { - "$ref": "#\/components\/schemas\/index" - }, - "x-example": {} + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "bytesMax": { + "size": { "type": "integer", - "description": "Maximum document size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, + "description": "Column size.", + "x-example": 128, "format": "int32" }, - "bytesUsed": { - "type": "integer", - "description": "Currently used document size in bytes based on defined attributes.", - "x-example": 1500, - "format": "int32" + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true }, - "dimension": { - "type": "integer", - "description": "Embedding dimension.", - "x-example": 1536, - "format": "int32" + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ - "$id", + "key", + "type", + "status", + "error", + "required", "$createdAt", "$updatedAt", - "$permissions", - "databaseId", - "name", - "enabled", - "documentSecurity", - "attributes", - "indexes", - "bytesMax", - "bytesUsed", - "dimension" + "size" ], "example": { - "$id": "5e5ea5c16897e", + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "databaseId": "5e5ea5c16897e", - "name": "My Collection", - "enabled": false, - "documentSecurity": true, - "attributes": {}, - "indexes": {}, - "bytesMax": 65535, - "bytesUsed": 1500, - "dimension": 1536 + "size": 128, + "default": "default", + "encrypt": false } }, - "attributeObject": { - "description": "AttributeObject", + "columnText": { + "description": "ColumnText", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -73292,33 +80243,45 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ @@ -73338,26 +80301,28 @@ "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00" + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "attributeVector": { - "description": "AttributeVector", + "columnMediumtext": { + "description": "ColumnMediumtext", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -73366,39 +80331,45 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Vector dimensions.", - "x-example": 1536, - "format": "int32" + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ @@ -73408,8 +80379,7 @@ "error", "required", "$createdAt", - "$updatedAt", - "size" + "$updatedAt" ], "example": { "key": "fullName", @@ -73420,7010 +80390,7022 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 1536 + "default": "default", + "encrypt": false } }, - "usageVectorsDBs": { - "description": "UsageVectorsDBs", + "columnLongtext": { + "description": "ColumnLongtext", "type": "object", "properties": { - "range": { + "key": { "type": "string", - "description": "Time range of the usage stats.", - "x-example": "30d" - }, - "databasesTotal": { - "type": "integer", - "description": "Total aggregated number of VectorsDB databases.", - "x-example": 0, - "format": "int32" - }, - "collectionsTotal": { - "type": "integer", - "description": "Total aggregated number of collections.", - "x-example": 0, - "format": "int32" - }, - "documentsTotal": { - "type": "integer", - "description": "Total aggregated number of documents.", - "x-example": 0, - "format": "int32" + "description": "Column Key.", + "x-example": "fullName" }, - "storageTotal": { - "type": "integer", - "description": "Total aggregated storage in bytes.", - "x-example": 0, - "format": "int32" + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" }, - "databasesReadsTotal": { - "type": "integer", - "description": "Total number of database reads.", - "x-example": 0, - "format": "int32" + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" }, - "databasesWritesTotal": { - "type": "integer", - "description": "Total number of database writes.", - "x-example": 0, - "format": "int32" + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" }, - "databases": { - "type": "array", - "description": "Aggregated number of databases per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true }, - "collections": { - "type": "array", - "description": "Aggregated number of collections per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true }, - "documents": { - "type": "array", - "description": "Aggregated number of documents per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "storage": { - "type": "array", - "description": "Aggregated storage in bytes per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "databasesReads": { - "type": "array", - "description": "An array of aggregated number of database reads.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true }, - "databasesWrites": { - "type": "array", - "description": "An array of aggregated number of database writes.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true } }, "required": [ - "range", - "databasesTotal", - "collectionsTotal", - "documentsTotal", - "storageTotal", - "databasesReadsTotal", - "databasesWritesTotal", - "databases", - "collections", - "documents", - "storage", - "databasesReads", - "databasesWrites" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "range": "30d", - "databasesTotal": 0, - "collectionsTotal": 0, - "documentsTotal": 0, - "storageTotal": 0, - "databasesReadsTotal": 0, - "databasesWritesTotal": 0, - "databases": [], - "collections": [], - "documents": [], - "storage": [], - "databasesReads": [], - "databasesWrites": [] + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "usageVectorsDB": { - "description": "UsageVectorsDB", + "index": { + "description": "Index", "type": "object", "properties": { - "range": { + "$id": { "type": "string", - "description": "Time range of the usage stats.", - "x-example": "30d" - }, - "collectionsTotal": { - "type": "integer", - "description": "Total aggregated number of collections.", - "x-example": 0, - "format": "int32" + "description": "Index ID.", + "x-example": "5e5ea5c16897e" }, - "documentsTotal": { - "type": "integer", - "description": "Total aggregated number of documents.", - "x-example": 0, - "format": "int32" + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "storageTotal": { - "type": "integer", - "description": "Total aggregated storage used in bytes.", - "x-example": 0, - "format": "int32" + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "databaseReadsTotal": { - "type": "integer", - "description": "Total number of database reads.", - "x-example": 0, - "format": "int32" + "key": { + "type": "string", + "description": "Index key.", + "x-example": "index1" }, - "databaseWritesTotal": { - "type": "integer", - "description": "Total number of database writes.", - "x-example": 0, - "format": "int32" + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" }, - "collections": { - "type": "array", - "description": "Aggregated number of collections per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ] }, - "documents": { - "type": "array", - "description": "Aggregated number of documents per period.", - "items": { - "$ref": "#\/components\/schemas\/metric" - }, - "x-example": [] + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" }, - "storage": { + "attributes": { "type": "array", - "description": "Aggregated storage used in bytes per period.", + "description": "Index attributes.", "items": { - "$ref": "#\/components\/schemas\/metric" + "type": "string" }, "x-example": [] }, - "databaseReads": { + "lengths": { "type": "array", - "description": "An array of aggregated number of database reads.", + "description": "Index attributes length.", "items": { - "$ref": "#\/components\/schemas\/metric" + "type": "integer", + "format": "int32" }, "x-example": [] }, - "databaseWrites": { + "orders": { "type": "array", - "description": "An array of aggregated number of database writes.", + "description": "Index orders.", "items": { - "$ref": "#\/components\/schemas\/metric" + "type": "string" }, - "x-example": [] + "x-example": [], + "nullable": true } }, "required": [ - "range", - "collectionsTotal", - "documentsTotal", - "storageTotal", - "databaseReadsTotal", - "databaseWritesTotal", - "collections", - "documents", - "storage", - "databaseReads", - "databaseWrites" + "$id", + "$createdAt", + "$updatedAt", + "key", + "type", + "status", + "error", + "attributes", + "lengths" ], "example": { - "range": "30d", - "collectionsTotal": 0, - "documentsTotal": 0, - "storageTotal": 0, - "databaseReadsTotal": 0, - "databaseWritesTotal": 0, - "collections": [], - "documents": [], - "storage": [], - "databaseReads": [], - "databaseWrites": [] + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "key": "index1", + "type": "primary", + "status": "available", + "error": "string", + "attributes": [], + "lengths": [], + "orders": [] } }, - "table": { - "description": "Table", + "columnIndex": { + "description": "Index", "type": "object", "properties": { "$id": { "type": "string", - "description": "Table ID.", + "description": "Index ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Table creation date in ISO 8601 format.", + "description": "Index creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Table update date in ISO 8601 format.", + "description": "Index update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$permissions": { - "type": "array", - "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - }, - "databaseId": { + "key": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "Index Key.", + "x-example": "index1" }, - "name": { + "type": { "type": "string", - "description": "Table name.", - "x-example": "My Table" + "description": "Index type.", + "x-example": "primary" }, - "enabled": { - "type": "boolean", - "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" }, - "rowSecurity": { - "type": "boolean", - "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" }, "columns": { "type": "array", - "description": "Table columns.", + "description": "Index columns.", "items": { - "anyOf": [ - { - "$ref": "#\/components\/schemas\/columnBoolean" - }, - { - "$ref": "#\/components\/schemas\/columnInteger" - }, - { - "$ref": "#\/components\/schemas\/columnFloat" - }, - { - "$ref": "#\/components\/schemas\/columnEmail" - }, - { - "$ref": "#\/components\/schemas\/columnEnum" - }, - { - "$ref": "#\/components\/schemas\/columnUrl" - }, - { - "$ref": "#\/components\/schemas\/columnIp" - }, - { - "$ref": "#\/components\/schemas\/columnDatetime" - }, - { - "$ref": "#\/components\/schemas\/columnRelationship" - }, - { - "$ref": "#\/components\/schemas\/columnPoint" - }, - { - "$ref": "#\/components\/schemas\/columnLine" - }, - { - "$ref": "#\/components\/schemas\/columnPolygon" - }, - { - "$ref": "#\/components\/schemas\/columnVarchar" - }, - { - "$ref": "#\/components\/schemas\/columnText" - }, - { - "$ref": "#\/components\/schemas\/columnMediumtext" - }, - { - "$ref": "#\/components\/schemas\/columnLongtext" - }, - { - "$ref": "#\/components\/schemas\/columnString" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/components\/schemas\/columnBoolean", - "integer": "#\/components\/schemas\/columnInteger", - "double": "#\/components\/schemas\/columnFloat", - "string": "#\/components\/schemas\/columnString", - "datetime": "#\/components\/schemas\/columnDatetime", - "relationship": "#\/components\/schemas\/columnRelationship", - "point": "#\/components\/schemas\/columnPoint", - "linestring": "#\/components\/schemas\/columnLine", - "polygon": "#\/components\/schemas\/columnPolygon", - "varchar": "#\/components\/schemas\/columnVarchar", - "text": "#\/components\/schemas\/columnText", - "mediumtext": "#\/components\/schemas\/columnMediumtext", - "longtext": "#\/components\/schemas\/columnLongtext" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/components\/schemas\/columnBoolean": { - "type": "boolean" - }, - "#\/components\/schemas\/columnInteger": { - "type": "integer" - }, - "#\/components\/schemas\/columnFloat": { - "type": "double" - }, - "#\/components\/schemas\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/components\/schemas\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/components\/schemas\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/components\/schemas\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/components\/schemas\/columnDatetime": { - "type": "datetime" - }, - "#\/components\/schemas\/columnRelationship": { - "type": "relationship" - }, - "#\/components\/schemas\/columnPoint": { - "type": "point" - }, - "#\/components\/schemas\/columnLine": { - "type": "linestring" - }, - "#\/components\/schemas\/columnPolygon": { - "type": "polygon" - }, - "#\/components\/schemas\/columnVarchar": { - "type": "varchar" - }, - "#\/components\/schemas\/columnText": { - "type": "text" - }, - "#\/components\/schemas\/columnMediumtext": { - "type": "mediumtext" - }, - "#\/components\/schemas\/columnLongtext": { - "type": "longtext" - }, - "#\/components\/schemas\/columnString": { - "type": "string" - } - } - } + "type": "string" }, - "x-example": {} + "x-example": [] }, - "indexes": { + "lengths": { "type": "array", - "description": "Table indexes.", + "description": "Index columns length.", "items": { - "$ref": "#\/components\/schemas\/columnIndex" + "type": "integer", + "format": "int32" }, - "x-example": {} - }, - "bytesMax": { - "type": "integer", - "description": "Maximum row size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "x-example": [] }, - "bytesUsed": { - "type": "integer", - "description": "Currently used row size in bytes based on defined columns.", - "x-example": 1500, - "format": "int32" + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "nullable": true } }, "required": [ "$id", "$createdAt", "$updatedAt", - "$permissions", - "databaseId", - "name", - "enabled", - "rowSecurity", + "key", + "type", + "status", + "error", "columns", - "indexes", - "bytesMax", - "bytesUsed" + "lengths" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "databaseId": "5e5ea5c16897e", - "name": "My Table", - "enabled": false, - "rowSecurity": true, - "columns": {}, - "indexes": {}, - "bytesMax": 65535, - "bytesUsed": 1500 - } - }, - "columnList": { - "description": "Columns List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of columns in the given table.", - "x-example": 5, - "format": "int32" - }, - "columns": { - "type": "array", - "description": "List of columns.", - "items": { - "anyOf": [ - { - "$ref": "#\/components\/schemas\/columnBoolean" - }, - { - "$ref": "#\/components\/schemas\/columnInteger" - }, - { - "$ref": "#\/components\/schemas\/columnFloat" - }, - { - "$ref": "#\/components\/schemas\/columnEmail" - }, - { - "$ref": "#\/components\/schemas\/columnEnum" - }, - { - "$ref": "#\/components\/schemas\/columnUrl" - }, - { - "$ref": "#\/components\/schemas\/columnIp" - }, - { - "$ref": "#\/components\/schemas\/columnDatetime" - }, - { - "$ref": "#\/components\/schemas\/columnRelationship" - }, - { - "$ref": "#\/components\/schemas\/columnPoint" - }, - { - "$ref": "#\/components\/schemas\/columnLine" - }, - { - "$ref": "#\/components\/schemas\/columnPolygon" - }, - { - "$ref": "#\/components\/schemas\/columnVarchar" - }, - { - "$ref": "#\/components\/schemas\/columnText" - }, - { - "$ref": "#\/components\/schemas\/columnMediumtext" - }, - { - "$ref": "#\/components\/schemas\/columnLongtext" - }, - { - "$ref": "#\/components\/schemas\/columnString" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/components\/schemas\/columnBoolean", - "integer": "#\/components\/schemas\/columnInteger", - "double": "#\/components\/schemas\/columnFloat", - "string": "#\/components\/schemas\/columnString", - "datetime": "#\/components\/schemas\/columnDatetime", - "relationship": "#\/components\/schemas\/columnRelationship", - "point": "#\/components\/schemas\/columnPoint", - "linestring": "#\/components\/schemas\/columnLine", - "polygon": "#\/components\/schemas\/columnPolygon", - "varchar": "#\/components\/schemas\/columnVarchar", - "text": "#\/components\/schemas\/columnText", - "mediumtext": "#\/components\/schemas\/columnMediumtext", - "longtext": "#\/components\/schemas\/columnLongtext" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/components\/schemas\/columnBoolean": { - "type": "boolean" - }, - "#\/components\/schemas\/columnInteger": { - "type": "integer" - }, - "#\/components\/schemas\/columnFloat": { - "type": "double" - }, - "#\/components\/schemas\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/components\/schemas\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/components\/schemas\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/components\/schemas\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/components\/schemas\/columnDatetime": { - "type": "datetime" - }, - "#\/components\/schemas\/columnRelationship": { - "type": "relationship" - }, - "#\/components\/schemas\/columnPoint": { - "type": "point" - }, - "#\/components\/schemas\/columnLine": { - "type": "linestring" - }, - "#\/components\/schemas\/columnPolygon": { - "type": "polygon" - }, - "#\/components\/schemas\/columnVarchar": { - "type": "varchar" - }, - "#\/components\/schemas\/columnText": { - "type": "text" - }, - "#\/components\/schemas\/columnMediumtext": { - "type": "mediumtext" - }, - "#\/components\/schemas\/columnLongtext": { - "type": "longtext" - }, - "#\/components\/schemas\/columnString": { - "type": "string" - } - } - } - }, - "x-example": "" - } - }, - "required": [ - "total", - "columns" - ], - "example": { - "total": 5, - "columns": "" + "key": "index1", + "type": "primary", + "status": "available", + "error": "string", + "columns": [], + "lengths": [], + "orders": [] } }, - "columnString": { - "description": "ColumnString", + "row": { + "description": "Row", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, - "type": { + "$id": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Row ID.", + "x-example": "5e5ea5c16897e" }, - "status": { + "$sequence": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Row sequence ID.", + "x-example": "1", + "readOnly": true }, - "error": { + "$tableId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "description": "Table ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Row creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Row update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Column size.", - "x-example": 128, - "format": "int32" - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] } }, + "additionalProperties": true, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", + "$sequence", + "$tableId", + "$databaseId", "$createdAt", "$updatedAt", - "size" + "$permissions" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$tableId": "5e5ea5c15117e", + "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "$permissions": [ + "read(\"any\")" + ] } }, - "columnInteger": { - "description": "ColumnInteger", + "document": { + "description": "Document", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "count" + "description": "Document ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$sequence": { "type": "string", - "description": "Column type.", - "x-example": "integer" + "description": "Document sequence ID.", + "x-example": "1", + "readOnly": true }, - "status": { + "$collectionId": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Collection ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, - "error": { + "$databaseId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "Database ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Document creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Document update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "min": { - "type": "integer", - "description": "Minimum value to enforce for new documents.", - "x-example": 1, - "format": "int64", - "nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value to enforce for new documents.", - "x-example": 10, - "format": "int64", - "nullable": true - }, - "default": { - "type": "integer", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 10, - "format": "int32", - "nullable": true + "$permissions": { + "type": "array", + "description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] } }, + "additionalProperties": true, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", + "$sequence", + "$collectionId", + "$databaseId", "$createdAt", - "$updatedAt" + "$updatedAt", + "$permissions" ], "example": { - "key": "count", - "type": "integer", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$collectionId": "5e5ea5c15117e", + "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "min": 1, - "max": 10, - "default": 10 + "$permissions": [ + "read(\"any\")" + ], + "username": "john.doe", + "email": "john.doe@example.com", + "fullName": "John Doe", + "age": 30, + "isAdmin": false } }, - "columnFloat": { - "description": "ColumnFloat", + "log": { + "description": "Log", "type": "object", "properties": { - "key": { + "event": { "type": "string", - "description": "Column Key.", - "x-example": "percentageCompleted" + "description": "Event name.", + "x-example": "account.sessions.create" }, - "type": { + "userId": { "type": "string", - "description": "Column type.", - "x-example": "double" + "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", + "x-example": "610fc2f985ee0" }, - "status": { + "userEmail": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", + "x-example": "john@appwrite.io" }, - "error": { + "userName": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", + "x-example": "John Doe" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "mode": { + "type": "string", + "description": "API mode when event triggered.", + "x-example": "admin" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" }, - "$createdAt": { + "ip": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "IP session in use when the session was created.", + "x-example": "127.0.0.1" }, - "$updatedAt": { + "time": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Log creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "min": { - "type": "number", - "description": "Minimum value to enforce for new documents.", - "x-example": 1.5, - "format": "double", - "nullable": true + "osCode": { + "type": "string", + "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", + "x-example": "Mac" }, - "max": { - "type": "number", - "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, - "format": "double", - "nullable": true + "osName": { + "type": "string", + "description": "Operating system name.", + "x-example": "Mac" }, - "default": { - "type": "number", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 2.5, - "format": "double", - "nullable": true + "osVersion": { + "type": "string", + "description": "Operating system version.", + "x-example": "Mac" + }, + "clientType": { + "type": "string", + "description": "Client type.", + "x-example": "browser" + }, + "clientCode": { + "type": "string", + "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", + "x-example": "CM" + }, + "clientName": { + "type": "string", + "description": "Client name.", + "x-example": "Chrome Mobile iOS" + }, + "clientVersion": { + "type": "string", + "description": "Client version.", + "x-example": "84.0" + }, + "clientEngine": { + "type": "string", + "description": "Client engine name.", + "x-example": "WebKit" + }, + "clientEngineVersion": { + "type": "string", + "description": "Client engine name.", + "x-example": "605.1.15" + }, + "deviceName": { + "type": "string", + "description": "Device name.", + "x-example": "smartphone" + }, + "deviceBrand": { + "type": "string", + "description": "Device brand name.", + "x-example": "Google" + }, + "deviceModel": { + "type": "string", + "description": "Device model name.", + "x-example": "Nexus 5" + }, + "countryCode": { + "type": "string", + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" + }, + "countryName": { + "type": "string", + "description": "Country name.", + "x-example": "United States" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "event", + "userId", + "userEmail", + "userName", + "mode", + "userType", + "ip", + "time", + "osCode", + "osName", + "osVersion", + "clientType", + "clientCode", + "clientName", + "clientVersion", + "clientEngine", + "clientEngineVersion", + "deviceName", + "deviceBrand", + "deviceModel", + "countryCode", + "countryName" ], "example": { - "key": "percentageCompleted", - "type": "double", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "min": 1.5, - "max": 10.5, - "default": 2.5 + "event": "account.sessions.create", + "userId": "610fc2f985ee0", + "userEmail": "john@appwrite.io", + "userName": "John Doe", + "mode": "admin", + "userType": "user", + "ip": "127.0.0.1", + "time": "2020-10-15T06:38:00.000+00:00", + "osCode": "Mac", + "osName": "Mac", + "osVersion": "Mac", + "clientType": "browser", + "clientCode": "CM", + "clientName": "Chrome Mobile iOS", + "clientVersion": "84.0", + "clientEngine": "WebKit", + "clientEngineVersion": "605.1.15", + "deviceName": "smartphone", + "deviceBrand": "Google", + "deviceModel": "Nexus 5", + "countryCode": "US", + "countryName": "United States" } }, - "columnBoolean": { - "description": "ColumnBoolean", + "user": { + "description": "User", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "isEnabled" + "description": "User ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "User creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "User update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "User name.", + "x-example": "John Doe" + }, + "password": { + "type": "string", + "description": "Hashed user password.", + "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "nullable": true + }, + "hash": { + "type": "string", + "description": "Password hashing algorithm.", + "x-example": "argon2", + "nullable": true + }, + "hashOptions": { + "type": "object", + "description": "Password hashing algorithm configuration.", + "x-example": {}, + "items": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/algoArgon2" + }, + { + "$ref": "#\/components\/schemas\/algoScrypt" + }, + { + "$ref": "#\/components\/schemas\/algoScryptModified" + }, + { + "$ref": "#\/components\/schemas\/algoBcrypt" + }, + { + "$ref": "#\/components\/schemas\/algoPhpass" + }, + { + "$ref": "#\/components\/schemas\/algoSha" + }, + { + "$ref": "#\/components\/schemas\/algoMd5" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/components\/schemas\/algoArgon2", + "scrypt": "#\/components\/schemas\/algoScrypt", + "scryptMod": "#\/components\/schemas\/algoScryptModified", + "bcrypt": "#\/components\/schemas\/algoBcrypt", + "phpass": "#\/components\/schemas\/algoPhpass", + "sha": "#\/components\/schemas\/algoSha", + "md5": "#\/components\/schemas\/algoMd5" + } + } + }, + "nullable": true + }, + "registration": { + "type": "string", + "description": "User registration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "status": { + "type": "boolean", + "description": "User status. Pass `true` for enabled and `false` for disabled.", + "x-example": true + }, + "labels": { + "type": "array", + "description": "Labels for the user.", + "items": { + "type": "string" + }, + "x-example": [ + "vip" + ] + }, + "passwordUpdate": { + "type": "string", + "description": "Password update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "type": { + "email": { "type": "string", - "description": "Column type.", - "x-example": "boolean" + "description": "User email address.", + "x-example": "john@appwrite.io" }, - "status": { + "phone": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "User phone number in E.164 format.", + "x-example": "+4930901820" }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "emailVerification": { + "type": "boolean", + "description": "Email verification status.", + "x-example": true }, - "required": { + "phoneVerification": { "type": "boolean", - "description": "Is column required?", + "description": "Phone verification status.", "x-example": true }, - "array": { + "mfa": { "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "Multi factor authentication status.", + "x-example": true }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "prefs": { + "type": "object", + "description": "User preferences as a key-value object", + "x-example": { + "theme": "pink", + "timezone": "UTC" + }, + "items": { + "$ref": "#\/components\/schemas\/preferences" + } }, - "$updatedAt": { + "targets": { + "type": "array", + "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", + "items": { + "$ref": "#\/components\/schemas\/target" + }, + "x-example": [] + }, + "accessedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "impersonator": { "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Whether the user can impersonate other users.", "x-example": false, "nullable": true + }, + "impersonatorUserId": { + "type": "string", + "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", + "x-example": "5e5ea5c16897e", + "nullable": true } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "name", + "registration", + "status", + "labels", + "passwordUpdate", + "email", + "phone", + "emailVerification", + "phoneVerification", + "mfa", + "prefs", + "targets", + "accessedAt" ], "example": { - "key": "isEnabled", - "type": "boolean", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": false + "name": "John Doe", + "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "hash": "argon2", + "hashOptions": {}, + "registration": "2020-10-15T06:38:00.000+00:00", + "status": true, + "labels": [ + "vip" + ], + "passwordUpdate": "2020-10-15T06:38:00.000+00:00", + "email": "john@appwrite.io", + "phone": "+4930901820", + "emailVerification": true, + "phoneVerification": true, + "mfa": true, + "prefs": { + "theme": "pink", + "timezone": "UTC" + }, + "targets": [], + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "impersonator": false, + "impersonatorUserId": "5e5ea5c16897e" } }, - "columnEmail": { - "description": "ColumnEmail", + "algoMd5": { + "description": "AlgoMD5", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "userEmail" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "email" - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default@example.com", - "nullable": true + "description": "Algo type.", + "x-example": "md5" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "type" ], "example": { - "key": "userEmail", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "email", - "default": "default@example.com" + "type": "md5" } }, - "columnEnum": { - "description": "ColumnEnum", + "algoSha": { + "description": "AlgoSHA", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "status" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { + "description": "Algo type.", + "x-example": "sha" + } + }, + "required": [ + "type" + ], + "example": { + "type": "sha" + } + }, + "algoPhpass": { + "description": "AlgoPHPass", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { + "description": "Algo type.", + "x-example": "phpass" + } + }, + "required": [ + "type" + ], + "example": { + "type": "phpass" + } + }, + "algoBcrypt": { + "description": "AlgoBcrypt", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true - }, - "$createdAt": { + "description": "Algo type.", + "x-example": "bcrypt" + } + }, + "required": [ + "type" + ], + "example": { + "type": "bcrypt" + } + }, + "algoScrypt": { + "description": "AlgoScrypt", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Algo type.", + "x-example": "scrypt" }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "costCpu": { + "type": "integer", + "description": "CPU complexity of computed hash.", + "x-example": 8, + "format": "int32" }, - "elements": { - "type": "array", - "description": "Array of elements in enumerated type.", - "items": { - "type": "string" - }, - "x-example": "element" + "costMemory": { + "type": "integer", + "description": "Memory complexity of computed hash.", + "x-example": 14, + "format": "int32" }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "enum" + "costParallel": { + "type": "integer", + "description": "Parallelization of computed hash.", + "x-example": 1, + "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", - "nullable": true + "length": { + "type": "integer", + "description": "Length used to compute hash.", + "x-example": 64, + "format": "int32" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "elements", - "format" + "costCpu", + "costMemory", + "costParallel", + "length" ], "example": { - "key": "status", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "elements": "element", - "format": "enum", - "default": "element" + "type": "scrypt", + "costCpu": 8, + "costMemory": 14, + "costParallel": 1, + "length": 64 } }, - "columnIp": { - "description": "ColumnIP", + "algoScryptModified": { + "description": "AlgoScryptModified", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "ipAddress" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Algo type.", + "x-example": "scryptMod" }, - "$updatedAt": { + "salt": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Salt used to compute hash.", + "x-example": "UxLMreBr6tYyjQ==" }, - "format": { + "saltSeparator": { "type": "string", - "description": "String format.", - "x-example": "ip" + "description": "Separator used to compute hash.", + "x-example": "Bw==" }, - "default": { + "signerKey": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", - "nullable": true + "description": "Key used to compute hash.", + "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "salt", + "saltSeparator", + "signerKey" ], "example": { - "key": "ipAddress", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "ip", - "default": "192.0.2.0" + "type": "scryptMod", + "salt": "UxLMreBr6tYyjQ==", + "saltSeparator": "Bw==", + "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, - "columnUrl": { - "description": "ColumnURL", + "algoArgon2": { + "description": "AlgoArgon2", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "githubUrl" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Algo type.", + "x-example": "argon2" }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "memoryCost": { + "type": "integer", + "description": "Memory used to compute hash.", + "x-example": 65536, + "format": "int32" }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "url" + "timeCost": { + "type": "integer", + "description": "Amount of time consumed to compute hash", + "x-example": 4, + "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "nullable": true + "threads": { + "type": "integer", + "description": "Number of threads used to compute hash.", + "x-example": 3, + "format": "int32" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "memoryCost", + "timeCost", + "threads" ], "example": { - "key": "githubUrl", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "url", - "default": "https:\/\/example.com" + "type": "argon2", + "memoryCost": 65536, + "timeCost": 4, + "threads": 3 } }, - "columnDatetime": { - "description": "ColumnDatetime", + "preferences": { + "description": "Preferences", + "type": "object", + "additionalProperties": true, + "example": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } + }, + "session": { + "description": "Session", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "birthDay" + "description": "Session ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "datetime" + "description": "Session creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "$updatedAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Session update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { + "userId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User ID.", + "x-example": "5e5bb8c16897e" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "expire": { + "type": "string", + "description": "Session expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "provider": { + "type": "string", + "description": "Session Provider.", + "x-example": "email" }, - "$createdAt": { + "providerUid": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Session Provider User ID.", + "x-example": "user@example.com" }, - "$updatedAt": { + "providerAccessToken": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Session Provider Access Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + }, + "providerAccessTokenExpiry": { + "type": "string", + "description": "The date of when the access token expires in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "format": { + "providerRefreshToken": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "Session Provider Refresh Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, - "default": { + "ip": { "type": "string", - "description": "Default value for column when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", - "nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" - ], - "example": { - "key": "birthDay", - "type": "datetime", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" - } - }, - "columnRelationship": { - "description": "ColumnRelationship", - "type": "object", - "properties": { - "key": { + "description": "IP in use when the session was created.", + "x-example": "127.0.0.1" + }, + "osCode": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", + "x-example": "Mac" }, - "type": { + "osName": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Operating system name.", + "x-example": "Mac" }, - "status": { + "osVersion": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Operating system version.", + "x-example": "Mac" }, - "error": { + "clientType": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "Client type.", + "x-example": "browser" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "clientCode": { + "type": "string", + "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", + "x-example": "CM" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "clientName": { + "type": "string", + "description": "Client name.", + "x-example": "Chrome Mobile iOS" }, - "$createdAt": { + "clientVersion": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Client version.", + "x-example": "84.0" }, - "$updatedAt": { + "clientEngine": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Client engine name.", + "x-example": "WebKit" }, - "relatedTable": { + "clientEngineVersion": { "type": "string", - "description": "The ID of the related table.", - "x-example": "table" + "description": "Client engine name.", + "x-example": "605.1.15" }, - "relationType": { + "deviceName": { "type": "string", - "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + "description": "Device name.", + "x-example": "smartphone" }, - "twoWay": { - "type": "boolean", - "description": "Is the relationship two-way?", - "x-example": false + "deviceBrand": { + "type": "string", + "description": "Device brand name.", + "x-example": "Google" }, - "twoWayKey": { + "deviceModel": { "type": "string", - "description": "The key of the two-way relationship.", - "x-example": "string" + "description": "Device model name.", + "x-example": "Nexus 5" }, - "onDelete": { + "countryCode": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" }, - "side": { + "countryName": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Country name.", + "x-example": "United States" + }, + "current": { + "type": "boolean", + "description": "Returns true if this the current user session.", + "x-example": true + }, + "factors": { + "type": "array", + "description": "Returns a list of active session factors.", + "items": { + "type": "string" + }, + "x-example": [ + "email" + ] + }, + "secret": { + "type": "string", + "description": "Secret used to authenticate the user. Only included if the request was made with an API key", + "x-example": "5e5bb8c16897e" + }, + "mfaUpdatedAt": { + "type": "string", + "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", "$updatedAt", - "relatedTable", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "userId", + "expire", + "provider", + "providerUid", + "providerAccessToken", + "providerAccessTokenExpiry", + "providerRefreshToken", + "ip", + "osCode", + "osName", + "osVersion", + "clientType", + "clientCode", + "clientName", + "clientVersion", + "clientEngine", + "clientEngineVersion", + "deviceName", + "deviceBrand", + "deviceModel", + "countryCode", + "countryName", + "current", + "factors", + "secret", + "mfaUpdatedAt" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "relatedTable": "table", - "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", - "twoWay": false, - "twoWayKey": "string", - "onDelete": "restrict|cascade|setNull", - "side": "parent|child" + "userId": "5e5bb8c16897e", + "expire": "2020-10-15T06:38:00.000+00:00", + "provider": "email", + "providerUid": "user@example.com", + "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", + "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "ip": "127.0.0.1", + "osCode": "Mac", + "osName": "Mac", + "osVersion": "Mac", + "clientType": "browser", + "clientCode": "CM", + "clientName": "Chrome Mobile iOS", + "clientVersion": "84.0", + "clientEngine": "WebKit", + "clientEngineVersion": "605.1.15", + "deviceName": "smartphone", + "deviceBrand": "Google", + "deviceModel": "Nexus 5", + "countryCode": "US", + "countryName": "United States", + "current": true, + "factors": [ + "email" + ], + "secret": "5e5bb8c16897e", + "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "columnPoint": { - "description": "ColumnPoint", + "identity": { + "description": "Identity", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Identity ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Identity creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "$updatedAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Identity update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { + "userId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User ID.", + "x-example": "5e5bb8c16897e" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "provider": { + "type": "string", + "description": "Identity Provider.", + "x-example": "email" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "providerUid": { + "type": "string", + "description": "ID of the User in the Identity Provider.", + "x-example": "5e5bb8c16897e" }, - "$createdAt": { + "providerEmail": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Email of the User in the Identity Provider.", + "x-example": "user@example.com" }, - "$updatedAt": { + "providerAccessToken": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Identity Provider Access Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + }, + "providerAccessTokenExpiry": { + "type": "string", + "description": "The date of when the access token expires in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - 0, - 0 - ], - "nullable": true + "providerRefreshToken": { + "type": "string", + "description": "Identity Provider Refresh Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "userId", + "provider", + "providerUid", + "providerEmail", + "providerAccessToken", + "providerAccessTokenExpiry", + "providerRefreshToken" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "userId": "5e5bb8c16897e", + "provider": "email", + "providerUid": "5e5bb8c16897e", + "providerEmail": "user@example.com", + "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", + "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, - "columnLine": { - "description": "ColumnLine", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { + "token": { + "description": "Token", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "Token ID.", + "x-example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Token creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$updatedAt": { + "userId": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "User ID.", + "x-example": "5e5ea5c168bb8" + }, + "secret": { + "type": "string", + "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" + }, + "expire": { + "type": "string", + "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], - "nullable": true + "phrase": { + "type": "string", + "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", + "x-example": "Golden Fox" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "userId", + "secret", + "expire", + "phrase" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "bb8ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ] + "userId": "5e5ea5c168bb8", + "secret": "", + "expire": "2020-10-15T06:38:00.000+00:00", + "phrase": "Golden Fox" } }, - "columnPolygon": { - "description": "ColumnPolygon", + "jwt": { + "description": "JWT", "type": "object", "properties": { - "key": { + "jwt": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + }, + "required": [ + "jwt" + ], + "example": { + "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + }, + "locale": { + "description": "Locale", + "type": "object", + "properties": { + "ip": { + "type": "string", + "description": "User IP address.", + "x-example": "127.0.0.1" }, - "type": { + "countryCode": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", + "x-example": "US" }, - "status": { + "country": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Country name. This field support localization.", + "x-example": "United States" }, - "error": { + "continentCode": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", + "x-example": "NA" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "continent": { + "type": "string", + "description": "Continent name. This field support localization.", + "x-example": "North America" }, - "array": { + "eu": { "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "True if country is part of the European Union.", + "x-example": false }, - "$createdAt": { + "currency": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { + "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", + "x-example": "USD" + } + }, + "required": [ + "ip", + "countryCode", + "country", + "continentCode", + "continent", + "eu", + "currency" + ], + "example": { + "ip": "127.0.0.1", + "countryCode": "US", + "country": "United States", + "continentCode": "NA", + "continent": "North America", + "eu": false, + "currency": "USD" + } + }, + "localeCode": { + "description": "LocaleCode", + "type": "object", + "properties": { + "code": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", + "x-example": "en-us" }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ], - "nullable": true + "name": { + "type": "string", + "description": "Locale name", + "x-example": "US" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "code", + "name" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "code": "en-us", + "name": "US" } }, - "columnVarchar": { - "description": "ColumnVarchar", + "file": { + "description": "File", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "File ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "bucketId": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Bucket ID.", + "x-example": "5e5ea5c16897e" }, - "status": { + "$createdAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "File creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { + "$updatedAt": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "File update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "$permissions": { + "type": "array", + "description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "name": { + "type": "string", + "description": "File name.", + "x-example": "Pink.png" }, - "$createdAt": { + "signature": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "File MD5 signature.", + "x-example": "5d529fd02b544198ae075bd57c1762bb" }, - "$updatedAt": { + "mimeType": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "File mime type.", + "x-example": "image\/png" }, - "size": { + "sizeOriginal": { "type": "integer", - "description": "Column size.", - "x-example": 128, + "description": "File original size in bytes.", + "x-example": 17890, "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true + "chunksTotal": { + "type": "integer", + "description": "Total number of chunks available", + "x-example": 17890, + "format": "int32" }, - "encrypt": { + "chunksUploaded": { + "type": "integer", + "description": "Total number of chunks uploaded", + "x-example": 17890, + "format": "int32" + }, + "encryption": { "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "description": "Whether file contents are encrypted at rest.", + "x-example": true + }, + "compression": { + "type": "string", + "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", + "x-example": "gzip" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", + "bucketId", "$createdAt", "$updatedAt", - "size" + "$permissions", + "name", + "signature", + "mimeType", + "sizeOriginal", + "chunksTotal", + "chunksUploaded", + "encryption", + "compression" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", + "bucketId": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "$permissions": [ + "read(\"any\")" + ], + "name": "Pink.png", + "signature": "5d529fd02b544198ae075bd57c1762bb", + "mimeType": "image\/png", + "sizeOriginal": 17890, + "chunksTotal": 17890, + "chunksUploaded": 17890, + "encryption": true, + "compression": "gzip" } }, - "columnText": { - "description": "ColumnText", + "bucket": { + "description": "Bucket", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Bucket ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Bucket creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "$updatedAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Bucket update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "$permissions": { + "type": "array", + "description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] }, - "required": { + "fileSecurity": { "type": "boolean", - "description": "Is column required?", + "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": true }, - "array": { + "name": { + "type": "string", + "description": "Bucket name.", + "x-example": "Documents" + }, + "enabled": { "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "Bucket enabled.", + "x-example": false }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size supported.", + "x-example": 100, + "format": "int32" }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions.", + "items": { + "type": "string" + }, + "x-example": [ + "jpg", + "png" + ] }, - "default": { + "compression": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true + "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", + "x-example": "gzip" }, - "encrypt": { + "encryption": { "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "description": "Bucket is encrypted.", + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Virus scanning is enabled.", + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Image transformations are enabled.", + "x-example": false + }, + "totalSize": { + "type": "integer", + "description": "Total size of this bucket in bytes.", + "x-example": 128, + "format": "int32" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "$permissions", + "fileSecurity", + "name", + "enabled", + "maximumFileSize", + "allowedFileExtensions", + "compression", + "encryption", + "antivirus", + "transformations", + "totalSize" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "$permissions": [ + "read(\"any\")" + ], + "fileSecurity": true, + "name": "Documents", + "enabled": false, + "maximumFileSize": 100, + "allowedFileExtensions": [ + "jpg", + "png" + ], + "compression": "gzip", + "encryption": false, + "antivirus": false, + "transformations": false, + "totalSize": 128 } }, - "columnMediumtext": { - "description": "ColumnMediumtext", + "resourceToken": { + "description": "ResourceToken", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Token ID.", + "x-example": "bb8ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Token creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "resourceId": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Resource ID.", + "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" }, - "error": { + "resourceType": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "Resource type.", + "x-example": "files" }, - "$createdAt": { + "expire": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$updatedAt": { + "secret": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, - "default": { + "accessedAt": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "resourceId", + "resourceType", + "expire", + "secret", + "accessedAt" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "bb8ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8", + "resourceType": "files", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "accessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "columnLongtext": { - "description": "ColumnLongtext", + "team": { + "description": "Team", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { + "$id": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "Team ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Team creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Team update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "name": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true + "description": "Team name.", + "x-example": "VIP" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "total": { + "type": "integer", + "description": "Total number of team members.", + "x-example": 7, + "format": "int32" + }, + "prefs": { + "type": "object", + "description": "Team preferences as a key-value object", + "x-example": { + "theme": "pink", + "timezone": "UTC" + }, + "items": { + "$ref": "#\/components\/schemas\/preferences" + } } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "name", + "total", + "prefs" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "name": "VIP", + "total": 7, + "prefs": { + "theme": "pink", + "timezone": "UTC" + } } }, - "index": { - "description": "Index", + "membership": { + "description": "Membership", "type": "object", "properties": { "$id": { "type": "string", - "description": "Index ID.", + "description": "Membership ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Index creation date in ISO 8601 format.", + "description": "Membership creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Index update date in ISO 8601 format.", + "description": "Membership update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "key": { + "userId": { "type": "string", - "description": "Index key.", - "x-example": "index1" + "description": "User ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "userName": { "type": "string", - "description": "Index type.", - "x-example": "primary" + "description": "User name. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "John Doe" }, - "status": { + "userEmail": { "type": "string", - "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ] + "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "john@appwrite.io" }, - "error": { + "userPhone": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "+1 555 555 5555" }, - "attributes": { - "type": "array", - "description": "Index attributes.", - "items": { - "type": "string" - }, - "x-example": [] + "teamId": { + "type": "string", + "description": "Team ID.", + "x-example": "5e5ea5c16897e" }, - "lengths": { - "type": "array", - "description": "Index attributes length.", - "items": { - "type": "integer", - "format": "int32" - }, - "x-example": [] + "teamName": { + "type": "string", + "description": "Team name.", + "x-example": "VIP" }, - "orders": { + "invited": { + "type": "string", + "description": "Date, the user has been invited to join the team in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "joined": { + "type": "string", + "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "confirm": { + "type": "boolean", + "description": "User confirmation status, true if the user has joined the team or false otherwise.", + "x-example": false + }, + "mfa": { + "type": "boolean", + "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", + "x-example": false + }, + "roles": { "type": "array", - "description": "Index orders.", + "description": "User list of roles", "items": { "type": "string" }, - "x-example": [], - "nullable": true + "x-example": [ + "owner" + ] } }, "required": [ "$id", "$createdAt", "$updatedAt", - "key", - "type", - "status", - "error", - "attributes", - "lengths" + "userId", + "userName", + "userEmail", + "userPhone", + "teamId", + "teamName", + "invited", + "joined", + "confirm", + "mfa", + "roles" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "key": "index1", - "type": "primary", - "status": "available", - "error": "string", - "attributes": [], - "lengths": [], - "orders": [] + "userId": "5e5ea5c16897e", + "userName": "John Doe", + "userEmail": "john@appwrite.io", + "userPhone": "+1 555 555 5555", + "teamId": "5e5ea5c16897e", + "teamName": "VIP", + "invited": "2020-10-15T06:38:00.000+00:00", + "joined": "2020-10-15T06:38:00.000+00:00", + "confirm": false, + "mfa": false, + "roles": [ + "owner" + ] } }, - "columnIndex": { - "description": "Index", + "site": { + "description": "Site", "type": "object", "properties": { "$id": { "type": "string", - "description": "Index ID.", + "description": "Site ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Index creation date in ISO 8601 format.", + "description": "Site creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Index update date in ISO 8601 format.", + "description": "Site update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "key": { + "name": { "type": "string", - "description": "Index Key.", - "x-example": "index1" + "description": "Site name.", + "x-example": "My Site" }, - "type": { + "enabled": { + "type": "boolean", + "description": "Site enabled.", + "x-example": false + }, + "live": { + "type": "boolean", + "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "x-example": false + }, + "framework": { "type": "string", - "description": "Index type.", - "x-example": "primary" + "description": "Site framework.", + "x-example": "react" }, - "status": { + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, + "deploymentId": { "type": "string", - "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available" + "description": "Site's active deployment ID.", + "x-example": "5e5ea5c16897e" }, - "error": { + "deploymentCreatedAt": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "description": "Active deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "columns": { - "type": "array", - "description": "Index columns.", - "items": { - "type": "string" - }, - "x-example": [] + "deploymentScreenshotLight": { + "type": "string", + "description": "Screenshot of active deployment with light theme preference file ID.", + "x-example": "5e5ea5c16897e" }, - "lengths": { - "type": "array", - "description": "Index columns length.", - "items": { - "type": "integer", - "format": "int32" - }, - "x-example": [] + "deploymentScreenshotDark": { + "type": "string", + "description": "Screenshot of active deployment with dark theme preference file ID.", + "x-example": "5e5ea5c16897e" }, - "orders": { + "latestDeploymentId": { + "type": "string", + "description": "Site's latest deployment ID.", + "x-example": "5e5ea5c16897e" + }, + "latestDeploymentCreatedAt": { + "type": "string", + "description": "Latest deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "latestDeploymentStatus": { + "type": "string", + "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", + "x-example": "ready" + }, + "vars": { "type": "array", - "description": "Index orders.", + "description": "Site variables.", "items": { - "type": "string" - }, - "x-example": [], - "nullable": true - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "key", - "type", - "status", - "error", - "columns", - "lengths" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "key": "index1", - "type": "primary", - "status": "available", - "error": "string", - "columns": [], - "lengths": [], - "orders": [] - } - }, - "row": { - "description": "Row", - "type": "object", - "properties": { - "$id": { + "$ref": "#\/components\/schemas\/variable" + }, + "x-example": [] + }, + "timeout": { + "type": "integer", + "description": "Site request timeout in seconds.", + "x-example": 300, + "format": "int32" + }, + "installCommand": { "type": "string", - "description": "Row ID.", - "x-example": "5e5ea5c16897e" + "description": "The install command used to install the site dependencies.", + "x-example": "npm install" }, - "$sequence": { + "buildCommand": { "type": "string", - "description": "Row sequence ID.", - "x-example": "1", - "readOnly": true + "description": "The build command used to build the site.", + "x-example": "npm run build" }, - "$tableId": { + "startCommand": { "type": "string", - "description": "Table ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "Custom command to use when starting site runtime.", + "x-example": "node custom-server.mjs" }, - "$databaseId": { + "outputDirectory": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "The directory where the site build output is located.", + "x-example": "build" }, - "$createdAt": { + "installationId": { "type": "string", - "description": "Row creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site VCS (Version Control System) installation id.", + "x-example": "6m40at4ejk5h2u9s1hboo" }, - "$updatedAt": { + "providerRepositoryId": { "type": "string", - "description": "Row update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "VCS (Version Control System) Repository ID", + "x-example": "appwrite" }, - "$permissions": { - "type": "array", - "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - } - }, - "additionalProperties": true, - "required": [ - "$id", - "$sequence", - "$tableId", - "$databaseId", - "$createdAt", - "$updatedAt", - "$permissions" - ], - "example": { - "$id": "5e5ea5c16897e", - "$sequence": "1", - "$tableId": "5e5ea5c15117e", - "$databaseId": "5e5ea5c15117e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ] - } - }, - "document": { - "description": "Document", - "type": "object", - "properties": { - "$id": { + "providerBranch": { "type": "string", - "description": "Document ID.", - "x-example": "5e5ea5c16897e" + "description": "VCS (Version Control System) branch name", + "x-example": "main" }, - "$sequence": { + "providerRootDirectory": { "type": "string", - "description": "Document sequence ID.", - "x-example": "1", - "readOnly": true + "description": "Path to site in VCS (Version Control System) repository", + "x-example": "sites\/helloWorld" }, - "$collectionId": { + "providerSilentMode": { + "type": "boolean", + "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", + "x-example": false + }, + "buildSpecification": { "type": "string", - "description": "Collection ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" }, - "$databaseId": { + "runtimeSpecification": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "Machine specification for SSR executions.", + "x-example": "s-1vcpu-512mb" }, - "$createdAt": { + "buildRuntime": { "type": "string", - "description": "Document creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site build runtime.", + "x-example": "node-22" }, - "$updatedAt": { + "adapter": { "type": "string", - "description": "Document update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site framework adapter.", + "x-example": "static" }, - "$permissions": { - "type": "array", - "description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "fallbackFile": { + "type": "string", + "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", + "x-example": "index.html" } }, - "additionalProperties": true, "required": [ "$id", - "$sequence", - "$collectionId", - "$databaseId", "$createdAt", "$updatedAt", - "$permissions" + "name", + "enabled", + "live", + "logging", + "framework", + "deploymentRetention", + "deploymentId", + "deploymentCreatedAt", + "deploymentScreenshotLight", + "deploymentScreenshotDark", + "latestDeploymentId", + "latestDeploymentCreatedAt", + "latestDeploymentStatus", + "vars", + "timeout", + "installCommand", + "buildCommand", + "startCommand", + "outputDirectory", + "installationId", + "providerRepositoryId", + "providerBranch", + "providerRootDirectory", + "providerSilentMode", + "buildSpecification", + "runtimeSpecification", + "buildRuntime", + "adapter", + "fallbackFile" ], "example": { "$id": "5e5ea5c16897e", - "$sequence": "1", - "$collectionId": "5e5ea5c15117e", - "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "username": "john.doe", - "email": "john.doe@example.com", - "fullName": "John Doe", - "age": 30, - "isAdmin": false + "name": "My Site", + "enabled": false, + "live": false, + "logging": false, + "framework": "react", + "deploymentRetention": 7, + "deploymentId": "5e5ea5c16897e", + "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "deploymentScreenshotLight": "5e5ea5c16897e", + "deploymentScreenshotDark": "5e5ea5c16897e", + "latestDeploymentId": "5e5ea5c16897e", + "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentStatus": "ready", + "vars": [], + "timeout": 300, + "installCommand": "npm install", + "buildCommand": "npm run build", + "startCommand": "node custom-server.mjs", + "outputDirectory": "build", + "installationId": "6m40at4ejk5h2u9s1hboo", + "providerRepositoryId": "appwrite", + "providerBranch": "main", + "providerRootDirectory": "sites\/helloWorld", + "providerSilentMode": false, + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb", + "buildRuntime": "node-22", + "adapter": "static", + "fallbackFile": "index.html" } }, - "log": { - "description": "Log", + "templateSite": { + "description": "Template Site", "type": "object", "properties": { - "event": { - "type": "string", - "description": "Event name.", - "x-example": "account.sessions.create" - }, - "userId": { + "key": { "type": "string", - "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", - "x-example": "610fc2f985ee0" + "description": "Site Template ID.", + "x-example": "starter" }, - "userEmail": { + "name": { "type": "string", - "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "john@appwrite.io" + "description": "Site Template Name.", + "x-example": "Starter site" }, - "userName": { + "tagline": { "type": "string", - "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "John Doe" + "description": "Short description of template", + "x-example": "Minimal web app integrating with Appwrite." }, - "mode": { + "demoUrl": { "type": "string", - "description": "API mode when event triggered.", - "x-example": "admin" + "description": "URL hosting a template demo.", + "x-example": "https:\/\/nextjs-starter.appwrite.network\/" }, - "userType": { + "screenshotDark": { "type": "string", - "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", - "x-example": "user" + "description": "File URL with preview screenshot in dark theme preference.", + "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png" }, - "ip": { + "screenshotLight": { "type": "string", - "description": "IP session in use when the session was created.", - "x-example": "127.0.0.1" + "description": "File URL with preview screenshot in light theme preference.", + "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png" }, - "time": { - "type": "string", - "description": "Log creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "useCases": { + "type": "array", + "description": "Site use cases.", + "items": { + "type": "string" + }, + "x-example": "Starter" }, - "osCode": { - "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "frameworks": { + "type": "array", + "description": "List of frameworks that can be used with this template.", + "items": { + "$ref": "#\/components\/schemas\/templateFramework" + }, + "x-example": [] }, - "osName": { + "vcsProvider": { "type": "string", - "description": "Operating system name.", - "x-example": "Mac" + "description": "VCS (Version Control System) Provider.", + "x-example": "github" }, - "osVersion": { + "providerRepositoryId": { "type": "string", - "description": "Operating system version.", - "x-example": "Mac" + "description": "VCS (Version Control System) Repository ID", + "x-example": "templates" }, - "clientType": { + "providerOwner": { "type": "string", - "description": "Client type.", - "x-example": "browser" + "description": "VCS (Version Control System) Owner.", + "x-example": "appwrite" }, - "clientCode": { + "providerVersion": { "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "description": "VCS (Version Control System) branch version (tag).", + "x-example": "main" }, - "clientName": { + "variables": { + "type": "array", + "description": "Site variables.", + "items": { + "$ref": "#\/components\/schemas\/templateVariable" + }, + "x-example": [] + } + }, + "required": [ + "key", + "name", + "tagline", + "demoUrl", + "screenshotDark", + "screenshotLight", + "useCases", + "frameworks", + "vcsProvider", + "providerRepositoryId", + "providerOwner", + "providerVersion", + "variables" + ], + "example": { + "key": "starter", + "name": "Starter site", + "tagline": "Minimal web app integrating with Appwrite.", + "demoUrl": "https:\/\/nextjs-starter.appwrite.network\/", + "screenshotDark": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png", + "screenshotLight": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png", + "useCases": "Starter", + "frameworks": [], + "vcsProvider": "github", + "providerRepositoryId": "templates", + "providerOwner": "appwrite", + "providerVersion": "main", + "variables": [] + } + }, + "templateFramework": { + "description": "Template Framework", + "type": "object", + "properties": { + "key": { "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "description": "Parent framework key.", + "x-example": "sveltekit" }, - "clientVersion": { + "name": { "type": "string", - "description": "Client version.", - "x-example": "84.0" + "description": "Framework Name.", + "x-example": "SvelteKit" }, - "clientEngine": { + "installCommand": { "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" + "description": "The install command used to install the dependencies.", + "x-example": "npm install" }, - "clientEngineVersion": { + "buildCommand": { "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" + "description": "The build command used to build the deployment.", + "x-example": "npm run build" }, - "deviceName": { + "outputDirectory": { "type": "string", - "description": "Device name.", - "x-example": "smartphone" + "description": "The output directory to store the build output.", + "x-example": ".\/build" }, - "deviceBrand": { + "providerRootDirectory": { "type": "string", - "description": "Device brand name.", - "x-example": "Google" + "description": "Path to site in VCS (Version Control System) repository", + "x-example": ".\/svelte-kit\/starter" }, - "deviceModel": { + "buildRuntime": { "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" + "description": "Runtime used during build step of template.", + "x-example": "node-22" }, - "countryCode": { + "adapter": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "Site framework runtime", + "x-example": "ssr" }, - "countryName": { + "fallbackFile": { "type": "string", - "description": "Country name.", - "x-example": "United States" + "description": "Fallback file for SPA. Only relevant for static serve runtime.", + "x-example": "index.html" } }, "required": [ - "event", - "userId", - "userEmail", - "userName", - "mode", - "userType", - "ip", - "time", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", - "countryCode", - "countryName" + "key", + "name", + "installCommand", + "buildCommand", + "outputDirectory", + "providerRootDirectory", + "buildRuntime", + "adapter", + "fallbackFile" ], "example": { - "event": "account.sessions.create", - "userId": "610fc2f985ee0", - "userEmail": "john@appwrite.io", - "userName": "John Doe", - "mode": "admin", - "userType": "user", - "ip": "127.0.0.1", - "time": "2020-10-15T06:38:00.000+00:00", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", - "countryCode": "US", - "countryName": "United States" + "key": "sveltekit", + "name": "SvelteKit", + "installCommand": "npm install", + "buildCommand": "npm run build", + "outputDirectory": ".\/build", + "providerRootDirectory": ".\/svelte-kit\/starter", + "buildRuntime": "node-22", + "adapter": "ssr", + "fallbackFile": "index.html" } }, - "user": { - "description": "User", + "function": { + "description": "Function", "type": "object", "properties": { "$id": { "type": "string", - "description": "User ID.", - "x-example": "5e5ea5c16897e" + "description": "Function ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Function creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Function update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "execute": { + "type": "array", + "description": "Execution permissions.", + "items": { + "type": "string" + }, + "x-example": "users" + }, + "name": { + "type": "string", + "description": "Function name.", + "x-example": "My Function" + }, + "enabled": { + "type": "boolean", + "description": "Function enabled.", + "x-example": false + }, + "live": { + "type": "boolean", + "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", + "x-example": false + }, + "runtime": { + "type": "string", + "description": "Function execution and build runtime.", + "x-example": "python-3.8" }, - "$createdAt": { + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, + "deploymentId": { "type": "string", - "description": "User creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Function's active deployment ID.", + "x-example": "5e5ea5c16897e" }, - "$updatedAt": { + "deploymentCreatedAt": { "type": "string", - "description": "User update date in ISO 8601 format.", + "description": "Active deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "latestDeploymentId": { "type": "string", - "description": "User name.", - "x-example": "John Doe" + "description": "Function's latest deployment ID.", + "x-example": "5e5ea5c16897e" }, - "password": { + "latestDeploymentCreatedAt": { "type": "string", - "description": "Hashed user password.", - "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", - "nullable": true + "description": "Latest deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "hash": { + "latestDeploymentStatus": { "type": "string", - "description": "Password hashing algorithm.", - "x-example": "argon2", - "nullable": true + "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", + "x-example": "ready" }, - "hashOptions": { - "type": "object", - "description": "Password hashing algorithm configuration.", - "x-example": {}, + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", "items": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/algoArgon2" - }, - { - "$ref": "#\/components\/schemas\/algoScrypt" - }, - { - "$ref": "#\/components\/schemas\/algoScryptModified" - }, - { - "$ref": "#\/components\/schemas\/algoBcrypt" - }, - { - "$ref": "#\/components\/schemas\/algoPhpass" - }, - { - "$ref": "#\/components\/schemas\/algoSha" - }, - { - "$ref": "#\/components\/schemas\/algoMd5" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/components\/schemas\/algoArgon2", - "scrypt": "#\/components\/schemas\/algoScrypt", - "scryptMod": "#\/components\/schemas\/algoScryptModified", - "bcrypt": "#\/components\/schemas\/algoBcrypt", - "phpass": "#\/components\/schemas\/algoPhpass", - "sha": "#\/components\/schemas\/algoSha", - "md5": "#\/components\/schemas\/algoMd5" - } - } + "type": "string" }, - "nullable": true - }, - "registration": { - "type": "string", - "description": "User registration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "x-example": "users.read" }, - "status": { - "type": "boolean", - "description": "User status. Pass `true` for enabled and `false` for disabled.", - "x-example": true + "vars": { + "type": "array", + "description": "Function variables.", + "items": { + "$ref": "#\/components\/schemas\/variable" + }, + "x-example": [] }, - "labels": { + "events": { "type": "array", - "description": "Labels for the user.", + "description": "Function trigger events.", "items": { "type": "string" }, - "x-example": [ - "vip" - ] + "x-example": "account.create" }, - "passwordUpdate": { + "schedule": { "type": "string", - "description": "Password update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Function execution schedule in CRON format.", + "x-example": "5 4 * * *" }, - "email": { - "type": "string", - "description": "User email address.", - "x-example": "john@appwrite.io" + "timeout": { + "type": "integer", + "description": "Function execution timeout in seconds.", + "x-example": 300, + "format": "int32" }, - "phone": { + "entrypoint": { "type": "string", - "description": "User phone number in E.164 format.", - "x-example": "+4930901820" + "description": "The entrypoint file used to execute the deployment.", + "x-example": "index.js" }, - "emailVerification": { - "type": "boolean", - "description": "Email verification status.", - "x-example": true + "commands": { + "type": "string", + "description": "The build command used to build the deployment.", + "x-example": "npm install" }, - "phoneVerification": { - "type": "boolean", - "description": "Phone verification status.", - "x-example": true + "version": { + "type": "string", + "description": "Version of Open Runtimes used for the function.", + "x-example": "v2" }, - "mfa": { - "type": "boolean", - "description": "Multi factor authentication status.", - "x-example": true + "installationId": { + "type": "string", + "description": "Function VCS (Version Control System) installation id.", + "x-example": "6m40at4ejk5h2u9s1hboo" }, - "prefs": { - "type": "object", - "description": "User preferences as a key-value object", - "x-example": { - "theme": "pink", - "timezone": "UTC" - }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "providerRepositoryId": { + "type": "string", + "description": "VCS (Version Control System) Repository ID", + "x-example": "appwrite" }, - "targets": { - "type": "array", - "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", - "items": { - "$ref": "#\/components\/schemas\/target" - }, - "x-example": [] + "providerBranch": { + "type": "string", + "description": "VCS (Version Control System) branch name", + "x-example": "main" }, - "accessedAt": { + "providerRootDirectory": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Path to function in VCS (Version Control System) repository", + "x-example": "functions\/helloWorld" }, - "impersonator": { + "providerSilentMode": { "type": "boolean", - "description": "Whether the user can impersonate other users.", - "x-example": false, - "nullable": true + "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", + "x-example": false }, - "impersonatorUserId": { + "buildSpecification": { "type": "string", - "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", - "x-example": "5e5ea5c16897e", - "nullable": true + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { + "type": "string", + "description": "Machine specification for executions.", + "x-example": "s-1vcpu-512mb" } }, "required": [ "$id", "$createdAt", "$updatedAt", + "execute", "name", - "registration", - "status", - "labels", - "passwordUpdate", - "email", - "phone", - "emailVerification", - "phoneVerification", - "mfa", - "prefs", - "targets", - "accessedAt" + "enabled", + "live", + "logging", + "runtime", + "deploymentRetention", + "deploymentId", + "deploymentCreatedAt", + "latestDeploymentId", + "latestDeploymentCreatedAt", + "latestDeploymentStatus", + "scopes", + "vars", + "events", + "schedule", + "timeout", + "entrypoint", + "commands", + "version", + "installationId", + "providerRepositoryId", + "providerBranch", + "providerRootDirectory", + "providerSilentMode", + "buildSpecification", + "runtimeSpecification" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "John Doe", - "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", - "hash": "argon2", - "hashOptions": {}, - "registration": "2020-10-15T06:38:00.000+00:00", - "status": true, - "labels": [ - "vip" - ], - "passwordUpdate": "2020-10-15T06:38:00.000+00:00", - "email": "john@appwrite.io", - "phone": "+4930901820", - "emailVerification": true, - "phoneVerification": true, - "mfa": true, - "prefs": { - "theme": "pink", - "timezone": "UTC" - }, - "targets": [], - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "impersonator": false, - "impersonatorUserId": "5e5ea5c16897e" + "execute": "users", + "name": "My Function", + "enabled": false, + "live": false, + "logging": false, + "runtime": "python-3.8", + "deploymentRetention": 7, + "deploymentId": "5e5ea5c16897e", + "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentId": "5e5ea5c16897e", + "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentStatus": "ready", + "scopes": "users.read", + "vars": [], + "events": "account.create", + "schedule": "5 4 * * *", + "timeout": 300, + "entrypoint": "index.js", + "commands": "npm install", + "version": "v2", + "installationId": "6m40at4ejk5h2u9s1hboo", + "providerRepositoryId": "appwrite", + "providerBranch": "main", + "providerRootDirectory": "functions\/helloWorld", + "providerSilentMode": false, + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb" } }, - "algoMd5": { - "description": "AlgoMD5", + "templateFunction": { + "description": "Template Function", "type": "object", "properties": { - "type": { + "icon": { "type": "string", - "description": "Algo type.", - "x-example": "md5" - } - }, - "required": [ - "type" - ], - "example": { - "type": "md5" - } - }, - "algoSha": { - "description": "AlgoSHA", - "type": "object", - "properties": { - "type": { + "description": "Function Template Icon.", + "x-example": "icon-lightning-bolt" + }, + "id": { "type": "string", - "description": "Algo type.", - "x-example": "sha" - } - }, - "required": [ - "type" - ], - "example": { - "type": "sha" - } - }, - "algoPhpass": { - "description": "AlgoPHPass", - "type": "object", - "properties": { - "type": { + "description": "Function Template ID.", + "x-example": "starter" + }, + "name": { "type": "string", - "description": "Algo type.", - "x-example": "phpass" - } - }, - "required": [ - "type" - ], - "example": { - "type": "phpass" - } - }, - "algoBcrypt": { - "description": "AlgoBcrypt", - "type": "object", - "properties": { - "type": { + "description": "Function Template Name.", + "x-example": "Starter function" + }, + "tagline": { "type": "string", - "description": "Algo type.", - "x-example": "bcrypt" - } - }, - "required": [ - "type" - ], - "example": { - "type": "bcrypt" - } - }, - "algoScrypt": { - "description": "AlgoScrypt", - "type": "object", - "properties": { - "type": { + "description": "Function Template Tagline.", + "x-example": "A simple function to get started." + }, + "permissions": { + "type": "array", + "description": "Execution permissions.", + "items": { + "type": "string" + }, + "x-example": "any" + }, + "events": { + "type": "array", + "description": "Function trigger events.", + "items": { + "type": "string" + }, + "x-example": "account.create" + }, + "cron": { "type": "string", - "description": "Algo type.", - "x-example": "scrypt" + "description": "Function execution schedult in CRON format.", + "x-example": "0 0 * * *" }, - "costCpu": { + "timeout": { "type": "integer", - "description": "CPU complexity of computed hash.", - "x-example": 8, + "description": "Function execution timeout in seconds.", + "x-example": 300, "format": "int32" }, - "costMemory": { - "type": "integer", - "description": "Memory complexity of computed hash.", - "x-example": 14, - "format": "int32" + "useCases": { + "type": "array", + "description": "Function use cases.", + "items": { + "type": "string" + }, + "x-example": "Starter" }, - "costParallel": { - "type": "integer", - "description": "Parallelization of computed hash.", - "x-example": 1, - "format": "int32" + "runtimes": { + "type": "array", + "description": "List of runtimes that can be used with this template.", + "items": { + "$ref": "#\/components\/schemas\/templateRuntime" + }, + "x-example": [] }, - "length": { - "type": "integer", - "description": "Length used to compute hash.", - "x-example": 64, - "format": "int32" + "instructions": { + "type": "string", + "description": "Function Template Instructions.", + "x-example": "For documentation and instructions check out ." + }, + "vcsProvider": { + "type": "string", + "description": "VCS (Version Control System) Provider.", + "x-example": "github" + }, + "providerRepositoryId": { + "type": "string", + "description": "VCS (Version Control System) Repository ID", + "x-example": "templates" + }, + "providerOwner": { + "type": "string", + "description": "VCS (Version Control System) Owner.", + "x-example": "appwrite" + }, + "providerVersion": { + "type": "string", + "description": "VCS (Version Control System) branch version (tag).", + "x-example": "main" + }, + "variables": { + "type": "array", + "description": "Function variables.", + "items": { + "$ref": "#\/components\/schemas\/templateVariable" + }, + "x-example": [] + }, + "scopes": { + "type": "array", + "description": "Function scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" } }, "required": [ - "type", - "costCpu", - "costMemory", - "costParallel", - "length" + "icon", + "id", + "name", + "tagline", + "permissions", + "events", + "cron", + "timeout", + "useCases", + "runtimes", + "instructions", + "vcsProvider", + "providerRepositoryId", + "providerOwner", + "providerVersion", + "variables", + "scopes" ], "example": { - "type": "scrypt", - "costCpu": 8, - "costMemory": 14, - "costParallel": 1, - "length": 64 + "icon": "icon-lightning-bolt", + "id": "starter", + "name": "Starter function", + "tagline": "A simple function to get started.", + "permissions": "any", + "events": "account.create", + "cron": "0 0 * * *", + "timeout": 300, + "useCases": "Starter", + "runtimes": [], + "instructions": "For documentation and instructions check out .", + "vcsProvider": "github", + "providerRepositoryId": "templates", + "providerOwner": "appwrite", + "providerVersion": "main", + "variables": [], + "scopes": "users.read" } }, - "algoScryptModified": { - "description": "AlgoScryptModified", + "templateRuntime": { + "description": "Template Runtime", "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Algo type.", - "x-example": "scryptMod" + "description": "Runtime Name.", + "x-example": "node-19.0" }, - "salt": { + "commands": { "type": "string", - "description": "Salt used to compute hash.", - "x-example": "UxLMreBr6tYyjQ==" + "description": "The build command used to build the deployment.", + "x-example": "npm install" }, - "saltSeparator": { + "entrypoint": { "type": "string", - "description": "Separator used to compute hash.", - "x-example": "Bw==" + "description": "The entrypoint file used to execute the deployment.", + "x-example": "index.js" }, - "signerKey": { + "providerRootDirectory": { "type": "string", - "description": "Key used to compute hash.", - "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "description": "Path to function in VCS (Version Control System) repository", + "x-example": "node\/starter" } }, "required": [ - "type", - "salt", - "saltSeparator", - "signerKey" + "name", + "commands", + "entrypoint", + "providerRootDirectory" ], "example": { - "type": "scryptMod", - "salt": "UxLMreBr6tYyjQ==", - "saltSeparator": "Bw==", - "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "name": "node-19.0", + "commands": "npm install", + "entrypoint": "index.js", + "providerRootDirectory": "node\/starter" } }, - "algoArgon2": { - "description": "AlgoArgon2", + "templateVariable": { + "description": "Template Variable", "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Algo type.", - "x-example": "argon2" + "description": "Variable Name.", + "x-example": "APPWRITE_DATABASE_ID" }, - "memoryCost": { - "type": "integer", - "description": "Memory used to compute hash.", - "x-example": 65536, - "format": "int32" + "description": { + "type": "string", + "description": "Variable Description.", + "x-example": "The ID of the Appwrite database that contains the collection to sync." }, - "timeCost": { - "type": "integer", - "description": "Amount of time consumed to compute hash", - "x-example": 4, - "format": "int32" + "value": { + "type": "string", + "description": "Variable Value.", + "x-example": "512" }, - "threads": { - "type": "integer", - "description": "Number of threads used to compute hash.", - "x-example": 3, - "format": "int32" + "secret": { + "type": "boolean", + "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", + "x-example": false + }, + "placeholder": { + "type": "string", + "description": "Variable Placeholder.", + "x-example": "64a55...7b912" + }, + "required": { + "type": "boolean", + "description": "Is the variable required?", + "x-example": false + }, + "type": { + "type": "string", + "description": "Variable Type.", + "x-example": "password" } }, "required": [ - "type", - "memoryCost", - "timeCost", - "threads" + "name", + "description", + "value", + "secret", + "placeholder", + "required", + "type" ], "example": { - "type": "argon2", - "memoryCost": 65536, - "timeCost": 4, - "threads": 3 - } - }, - "preferences": { - "description": "Preferences", - "type": "object", - "additionalProperties": true, - "example": { - "language": "en", - "timezone": "UTC", - "darkTheme": true + "name": "APPWRITE_DATABASE_ID", + "description": "The ID of the Appwrite database that contains the collection to sync.", + "value": "512", + "secret": false, + "placeholder": "64a55...7b912", + "required": false, + "type": "password" } }, - "session": { - "description": "Session", + "installation": { + "description": "Installation", "type": "object", "properties": { "$id": { "type": "string", - "description": "Session ID.", + "description": "Function ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Session creation date in ISO 8601 format.", + "description": "Function creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Session update date in ISO 8601 format.", + "description": "Function update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "userId": { + "provider": { "type": "string", - "description": "User ID.", - "x-example": "5e5bb8c16897e" + "description": "VCS (Version Control System) provider name.", + "x-example": "github" }, - "expire": { + "organization": { "type": "string", - "description": "Session expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "VCS (Version Control System) organization name.", + "x-example": "appwrite" }, - "provider": { + "providerInstallationId": { "type": "string", - "description": "Session Provider.", - "x-example": "email" + "description": "VCS (Version Control System) installation ID.", + "x-example": "5322" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "provider", + "organization", + "providerInstallationId" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "provider": "github", + "organization": "appwrite", + "providerInstallationId": "5322" + } + }, + "providerRepository": { + "description": "ProviderRepository", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" }, - "providerUid": { + "name": { "type": "string", - "description": "Session Provider User ID.", - "x-example": "user@example.com" + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" }, - "providerAccessToken": { + "organization": { "type": "string", - "description": "Session Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" }, - "providerAccessTokenExpiry": { + "provider": { "type": "string", - "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "VCS (Version Control System) provider name.", + "x-example": "github" }, - "providerRefreshToken": { + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "defaultBranch": { "type": "string", - "description": "Session Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "VCS (Version Control System) repository's default branch name.", + "x-example": "main" }, - "ip": { + "providerInstallationId": { "type": "string", - "description": "IP in use when the session was created.", - "x-example": "127.0.0.1" + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" }, - "osCode": { + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, + "pushedAt": { "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" }, - "osName": { + "variables": { + "type": "array", + "description": "Environment variables found in .env files", + "items": { + "type": "string" + }, + "x-example": [ + "PORT", + "NODE_ENV" + ] + } + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "defaultBranch", + "providerInstallationId", + "authorized", + "pushedAt", + "variables" + ], + "example": { + "id": "5e5ea5c16897e", + "name": "appwrite", + "organization": "appwrite", + "provider": "github", + "private": true, + "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, + "pushedAt": "datetime", + "variables": [ + "PORT", + "NODE_ENV" + ] + } + }, + "providerRepositoryFramework": { + "description": "ProviderRepositoryFramework", + "type": "object", + "properties": { + "id": { "type": "string", - "description": "Operating system name.", - "x-example": "Mac" + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" }, - "osVersion": { + "name": { "type": "string", - "description": "Operating system version.", - "x-example": "Mac" + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" }, - "clientType": { + "organization": { "type": "string", - "description": "Client type.", - "x-example": "browser" + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" }, - "clientCode": { + "provider": { "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "description": "VCS (Version Control System) provider name.", + "x-example": "github" }, - "clientName": { + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "defaultBranch": { "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "description": "VCS (Version Control System) repository's default branch name.", + "x-example": "main" }, - "clientVersion": { + "providerInstallationId": { "type": "string", - "description": "Client version.", - "x-example": "84.0" + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" }, - "clientEngine": { + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, + "pushedAt": { "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" }, - "clientEngineVersion": { + "variables": { + "type": "array", + "description": "Environment variables found in .env files", + "items": { + "type": "string" + }, + "x-example": [ + "PORT", + "NODE_ENV" + ] + }, + "framework": { "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" + "description": "Auto-detected framework. Empty if type is not \"framework\".", + "x-example": "nextjs" + } + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "defaultBranch", + "providerInstallationId", + "authorized", + "pushedAt", + "variables", + "framework" + ], + "example": { + "id": "5e5ea5c16897e", + "name": "appwrite", + "organization": "appwrite", + "provider": "github", + "private": true, + "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, + "pushedAt": "datetime", + "variables": [ + "PORT", + "NODE_ENV" + ], + "framework": "nextjs" + } + }, + "providerRepositoryRuntime": { + "description": "ProviderRepositoryRuntime", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" }, - "deviceName": { + "name": { "type": "string", - "description": "Device name.", - "x-example": "smartphone" + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" }, - "deviceBrand": { + "organization": { "type": "string", - "description": "Device brand name.", - "x-example": "Google" + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" }, - "deviceModel": { + "provider": { "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" + "description": "VCS (Version Control System) provider name.", + "x-example": "github" }, - "countryCode": { + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "defaultBranch": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "VCS (Version Control System) repository's default branch name.", + "x-example": "main" }, - "countryName": { + "providerInstallationId": { "type": "string", - "description": "Country name.", - "x-example": "United States" + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" }, - "current": { + "authorized": { "type": "boolean", - "description": "Returns true if this the current user session.", + "description": "Is VCS (Version Control System) repository authorized for the installation?", "x-example": true }, - "factors": { + "pushedAt": { + "type": "string", + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" + }, + "variables": { "type": "array", - "description": "Returns a list of active session factors.", + "description": "Environment variables found in .env files", "items": { "type": "string" }, "x-example": [ - "email" + "PORT", + "NODE_ENV" ] }, - "secret": { - "type": "string", - "description": "Secret used to authenticate the user. Only included if the request was made with an API key", - "x-example": "5e5bb8c16897e" - }, - "mfaUpdatedAt": { + "runtime": { "type": "string", - "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Auto-detected runtime. Empty if type is not \"runtime\".", + "x-example": "node-22" } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "userId", - "expire", - "provider", - "providerUid", - "providerAccessToken", - "providerAccessTokenExpiry", - "providerRefreshToken", - "ip", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", - "countryCode", - "countryName", - "current", - "factors", - "secret", - "mfaUpdatedAt" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5bb8c16897e", - "expire": "2020-10-15T06:38:00.000+00:00", - "provider": "email", - "providerUid": "user@example.com", - "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", - "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "ip": "127.0.0.1", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", - "countryCode": "US", - "countryName": "United States", - "current": true, - "factors": [ - "email" + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "defaultBranch", + "providerInstallationId", + "authorized", + "pushedAt", + "variables", + "runtime" + ], + "example": { + "id": "5e5ea5c16897e", + "name": "appwrite", + "organization": "appwrite", + "provider": "github", + "private": true, + "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, + "pushedAt": "datetime", + "variables": [ + "PORT", + "NODE_ENV" ], - "secret": "5e5bb8c16897e", - "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00" + "runtime": "node-22" } }, - "identity": { - "description": "Identity", + "detectionFramework": { + "description": "DetectionFramework", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Identity ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Identity creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Identity update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "userId": { - "type": "string", - "description": "User ID.", - "x-example": "5e5bb8c16897e" - }, - "provider": { + "type": { "type": "string", - "description": "Identity Provider.", - "x-example": "email" + "description": "Repository detection type.", + "x-example": "framework", + "enum": [ + "framework" + ] }, - "providerUid": { - "type": "string", - "description": "ID of the User in the Identity Provider.", - "x-example": "5e5bb8c16897e" + "variables": { + "type": "array", + "description": "Environment variables found in .env files", + "items": { + "$ref": "#\/components\/schemas\/detectionVariable" + }, + "x-example": {}, + "nullable": true }, - "providerEmail": { + "framework": { "type": "string", - "description": "Email of the User in the Identity Provider.", - "x-example": "user@example.com" + "description": "Framework", + "x-example": "nuxt" }, - "providerAccessToken": { + "installCommand": { "type": "string", - "description": "Identity Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Site Install Command", + "x-example": "npm install" }, - "providerAccessTokenExpiry": { + "buildCommand": { "type": "string", - "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site Build Command", + "x-example": "npm run build" }, - "providerRefreshToken": { + "outputDirectory": { "type": "string", - "description": "Identity Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Site Output Directory", + "x-example": "dist" } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "userId", - "provider", - "providerUid", - "providerEmail", - "providerAccessToken", - "providerAccessTokenExpiry", - "providerRefreshToken" + "type", + "framework", + "installCommand", + "buildCommand", + "outputDirectory" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5bb8c16897e", - "provider": "email", - "providerUid": "5e5bb8c16897e", - "providerEmail": "user@example.com", - "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", - "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "type": "framework", + "variables": {}, + "framework": "nuxt", + "installCommand": "npm install", + "buildCommand": "npm run build", + "outputDirectory": "dist" } }, - "token": { - "description": "Token", + "detectionRuntime": { + "description": "DetectionRuntime", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" - }, - "$createdAt": { + "type": { "type": "string", - "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Repository detection type.", + "x-example": "runtime", + "enum": [ + "runtime" + ] }, - "userId": { - "type": "string", - "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "variables": { + "type": "array", + "description": "Environment variables found in .env files", + "items": { + "$ref": "#\/components\/schemas\/detectionVariable" + }, + "x-example": {}, + "nullable": true }, - "secret": { + "runtime": { "type": "string", - "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "description": "Runtime", + "x-example": "node" }, - "expire": { + "entrypoint": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Function Entrypoint", + "x-example": "index.js" }, - "phrase": { + "commands": { "type": "string", - "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", - "x-example": "Golden Fox" + "description": "Function install and build commands", + "x-example": "npm install && npm run build" } }, "required": [ - "$id", - "$createdAt", - "userId", - "secret", - "expire", - "phrase" + "type", + "runtime", + "entrypoint", + "commands" ], "example": { - "$id": "bb8ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c168bb8", - "secret": "", - "expire": "2020-10-15T06:38:00.000+00:00", - "phrase": "Golden Fox" + "type": "runtime", + "variables": {}, + "runtime": "node", + "entrypoint": "index.js", + "commands": "npm install && npm run build" } }, - "jwt": { - "description": "JWT", + "detectionVariable": { + "description": "DetectionVariable", "type": "object", "properties": { - "jwt": { + "name": { "type": "string", - "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "description": "Name of environment variable", + "x-example": "NODE_ENV" + }, + "value": { + "type": "string", + "description": "Value of environment variable", + "x-example": "production" } }, "required": [ - "jwt" + "name", + "value" ], "example": { - "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "name": "NODE_ENV", + "value": "production" } }, - "locale": { - "description": "Locale", + "vcsContent": { + "description": "VcsContents", "type": "object", "properties": { - "ip": { - "type": "string", - "description": "User IP address.", - "x-example": "127.0.0.1" - }, - "countryCode": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", - "x-example": "US" - }, - "country": { - "type": "string", - "description": "Country name. This field support localization.", - "x-example": "United States" - }, - "continentCode": { - "type": "string", - "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", - "x-example": "NA" - }, - "continent": { - "type": "string", - "description": "Continent name. This field support localization.", - "x-example": "North America" + "size": { + "type": "integer", + "description": "Content size in bytes. Only files have size, and for directories, 0 is returned.", + "x-example": 1523, + "format": "int32", + "nullable": true }, - "eu": { + "isDirectory": { "type": "boolean", - "description": "True if country is part of the European Union.", - "x-example": false + "description": "If a content is a directory. Directories can be used to check nested contents.", + "x-example": true, + "nullable": true }, - "currency": { + "name": { "type": "string", - "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", - "x-example": "USD" + "description": "Name of directory or file.", + "x-example": "Main.java" } }, "required": [ - "ip", - "countryCode", - "country", - "continentCode", - "continent", - "eu", - "currency" + "name" ], "example": { - "ip": "127.0.0.1", - "countryCode": "US", - "country": "United States", - "continentCode": "NA", - "continent": "North America", - "eu": false, - "currency": "USD" + "size": 1523, + "isDirectory": true, + "name": "Main.java" } }, - "localeCode": { - "description": "LocaleCode", + "branch": { + "description": "Branch", "type": "object", "properties": { - "code": { - "type": "string", - "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", - "x-example": "en-us" - }, "name": { "type": "string", - "description": "Locale name", - "x-example": "US" + "description": "Branch Name.", + "x-example": "main" } }, "required": [ - "code", "name" ], "example": { - "code": "en-us", - "name": "US" + "name": "main" } }, - "file": { - "description": "File", + "runtime": { + "description": "Runtime", "type": "object", "properties": { "$id": { "type": "string", - "description": "File ID.", - "x-example": "5e5ea5c16897e" + "description": "Runtime ID.", + "x-example": "python-3.8" }, - "bucketId": { + "key": { "type": "string", - "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" + "description": "Parent runtime key.", + "x-example": "python" }, - "$createdAt": { + "name": { "type": "string", - "description": "File creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Runtime Name.", + "x-example": "Python" }, - "$updatedAt": { + "version": { "type": "string", - "description": "File update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "description": "Runtime version.", + "x-example": "3.8" }, - "name": { + "base": { "type": "string", - "description": "File name.", - "x-example": "Pink.png" + "description": "Base Docker image used to build the runtime.", + "x-example": "python:3.8-alpine" }, - "signature": { + "image": { "type": "string", - "description": "File MD5 signature.", - "x-example": "5d529fd02b544198ae075bd57c1762bb" + "description": "Image name of Docker Hub.", + "x-example": "appwrite\\\/runtime-for-python:3.8" }, - "mimeType": { + "logo": { "type": "string", - "description": "File mime type.", - "x-example": "image\/png" - }, - "sizeOriginal": { - "type": "integer", - "description": "File original size in bytes.", - "x-example": 17890, - "format": "int32" - }, - "chunksTotal": { - "type": "integer", - "description": "Total number of chunks available", - "x-example": 17890, - "format": "int32" - }, - "chunksUploaded": { - "type": "integer", - "description": "Total number of chunks uploaded", - "x-example": 17890, - "format": "int32" - }, - "encryption": { - "type": "boolean", - "description": "Whether file contents are encrypted at rest.", - "x-example": true + "description": "Name of the logo image.", + "x-example": "python.png" }, - "compression": { - "type": "string", - "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "supports": { + "type": "array", + "description": "List of supported architectures.", + "items": { + "type": "string" + }, + "x-example": "amd64" } }, "required": [ "$id", - "bucketId", - "$createdAt", - "$updatedAt", - "$permissions", + "key", "name", - "signature", - "mimeType", - "sizeOriginal", - "chunksTotal", - "chunksUploaded", - "encryption", - "compression" + "version", + "base", + "image", + "logo", + "supports" ], "example": { - "$id": "5e5ea5c16897e", - "bucketId": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "name": "Pink.png", - "signature": "5d529fd02b544198ae075bd57c1762bb", - "mimeType": "image\/png", - "sizeOriginal": 17890, - "chunksTotal": 17890, - "chunksUploaded": 17890, - "encryption": true, - "compression": "gzip" + "$id": "python-3.8", + "key": "python", + "name": "Python", + "version": "3.8", + "base": "python:3.8-alpine", + "image": "appwrite\\\/runtime-for-python:3.8", + "logo": "python.png", + "supports": "amd64" } }, - "bucket": { - "description": "Bucket", + "framework": { + "description": "Framework", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Bucket creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { + "key": { "type": "string", - "description": "Bucket update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - }, - "fileSecurity": { - "type": "boolean", - "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "description": "Framework key.", + "x-example": "sveltekit" }, "name": { "type": "string", - "description": "Bucket name.", - "x-example": "Documents" - }, - "enabled": { - "type": "boolean", - "description": "Bucket enabled.", - "x-example": false + "description": "Framework Name.", + "x-example": "SvelteKit" }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size supported.", - "x-example": 100, - "format": "int32" + "buildRuntime": { + "type": "string", + "description": "Default runtime version.", + "x-example": "node-22" }, - "allowedFileExtensions": { + "runtimes": { "type": "array", - "description": "Allowed file extensions.", + "description": "List of supported runtime versions.", "items": { "type": "string" - }, - "x-example": [ - "jpg", - "png" - ] - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" - }, - "encryption": { - "type": "boolean", - "description": "Bucket is encrypted.", - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Virus scanning is enabled.", - "x-example": false - }, - "transformations": { - "type": "boolean", - "description": "Image transformations are enabled.", - "x-example": false + }, + "x-example": [ + "static-1", + "node-22" + ] }, - "totalSize": { - "type": "integer", - "description": "Total size of this bucket in bytes.", - "x-example": 128, - "format": "int32" + "adapters": { + "type": "array", + "description": "List of supported adapters.", + "items": { + "$ref": "#\/components\/schemas\/frameworkAdapter" + }, + "x-example": [ + { + "key": "static", + "buildRuntime": "node-22", + "buildCommand": "npm run build", + "installCommand": "npm install", + "outputDirectory": ".\/dist" + } + ] } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "$permissions", - "fileSecurity", + "key", "name", - "enabled", - "maximumFileSize", - "allowedFileExtensions", - "compression", - "encryption", - "antivirus", - "transformations", - "totalSize" + "buildRuntime", + "runtimes", + "adapters" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "fileSecurity": true, - "name": "Documents", - "enabled": false, - "maximumFileSize": 100, - "allowedFileExtensions": [ - "jpg", - "png" + "key": "sveltekit", + "name": "SvelteKit", + "buildRuntime": "node-22", + "runtimes": [ + "static-1", + "node-22" ], - "compression": "gzip", - "encryption": false, - "antivirus": false, - "transformations": false, - "totalSize": 128 + "adapters": [ + { + "key": "static", + "buildRuntime": "node-22", + "buildCommand": "npm run build", + "installCommand": "npm install", + "outputDirectory": ".\/dist" + } + ] } }, - "resourceToken": { - "description": "ResourceToken", + "frameworkAdapter": { + "description": "Framework Adapter", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "resourceId": { + "key": { "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" + "description": "Adapter key.", + "x-example": "static" }, - "resourceType": { + "installCommand": { "type": "string", - "description": "Resource type.", - "x-example": "files" + "description": "Default command to download dependencies.", + "x-example": "npm install" }, - "expire": { + "buildCommand": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Default command to build site into output directory.", + "x-example": "npm run build" }, - "secret": { + "outputDirectory": { "type": "string", - "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "description": "Default output directory of build.", + "x-example": ".\/dist" }, - "accessedAt": { + "fallbackFile": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", + "x-example": "index.html" } }, "required": [ - "$id", - "$createdAt", - "resourceId", - "resourceType", - "expire", - "secret", - "accessedAt" + "key", + "installCommand", + "buildCommand", + "outputDirectory", + "fallbackFile" ], "example": { - "$id": "bb8ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8", - "resourceType": "files", - "expire": "2020-10-15T06:38:00.000+00:00", - "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", - "accessedAt": "2020-10-15T06:38:00.000+00:00" + "key": "static", + "installCommand": "npm install", + "buildCommand": "npm run build", + "outputDirectory": ".\/dist", + "fallbackFile": "index.html" } }, - "team": { - "description": "Team", + "deployment": { + "description": "Deployment", "type": "object", "properties": { "$id": { "type": "string", - "description": "Team ID.", + "description": "Deployment ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Team creation date in ISO 8601 format.", + "description": "Deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Team update date in ISO 8601 format.", + "description": "Deployment update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "type": { "type": "string", - "description": "Team name.", - "x-example": "VIP" + "description": "Type of deployment.", + "x-example": "vcs" }, - "total": { + "resourceId": { + "type": "string", + "description": "Resource ID.", + "x-example": "5e5ea6g16897e" + }, + "resourceType": { + "type": "string", + "description": "Resource type.", + "x-example": "functions" + }, + "entrypoint": { + "type": "string", + "description": "The entrypoint file to use to execute the deployment code.", + "x-example": "index.js" + }, + "sourceSize": { "type": "integer", - "description": "Total number of team members.", - "x-example": 7, + "description": "The code size in bytes.", + "x-example": 128, "format": "int32" }, - "prefs": { - "type": "object", - "description": "Team preferences as a key-value object", - "x-example": { - "theme": "pink", - "timezone": "UTC" - }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "name", - "total", - "prefs" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "VIP", - "total": 7, - "prefs": { - "theme": "pink", - "timezone": "UTC" - } - } - }, - "membership": { - "description": "Membership", - "type": "object", - "properties": { - "$id": { + "buildSize": { + "type": "integer", + "description": "The build output size in bytes.", + "x-example": 128, + "format": "int32" + }, + "totalSize": { + "type": "integer", + "description": "The total size in bytes (source and build output).", + "x-example": 128, + "format": "int32" + }, + "buildId": { "type": "string", - "description": "Membership ID.", + "description": "The current build ID.", "x-example": "5e5ea5c16897e" }, - "$createdAt": { - "type": "string", - "description": "Membership creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "activate": { + "type": "boolean", + "description": "Whether the deployment should be automatically activated.", + "x-example": true }, - "$updatedAt": { + "screenshotLight": { "type": "string", - "description": "Membership update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Screenshot with light theme preference file ID.", + "x-example": "5e5ea5c16897e" }, - "userId": { + "screenshotDark": { "type": "string", - "description": "User ID.", + "description": "Screenshot with dark theme preference file ID.", "x-example": "5e5ea5c16897e" }, - "userName": { + "status": { "type": "string", - "description": "User name. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "John Doe" + "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", + "x-example": "ready", + "enum": [ + "waiting", + "processing", + "building", + "ready", + "canceled", + "failed" + ] }, - "userEmail": { + "buildLogs": { "type": "string", - "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "john@appwrite.io" + "description": "The build logs.", + "x-example": "Compiling source files..." }, - "userPhone": { + "buildDuration": { + "type": "integer", + "description": "The current build time in seconds.", + "x-example": 128, + "format": "int32" + }, + "providerRepositoryName": { "type": "string", - "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "+1 555 555 5555" + "description": "The name of the vcs provider repository", + "x-example": "database" }, - "teamId": { + "providerRepositoryOwner": { "type": "string", - "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "description": "The name of the vcs provider repository owner", + "x-example": "utopia" }, - "teamName": { + "providerRepositoryUrl": { "type": "string", - "description": "Team name.", - "x-example": "VIP" + "description": "The url of the vcs provider repository", + "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" }, - "invited": { + "providerCommitHash": { "type": "string", - "description": "Date, the user has been invited to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "The commit hash of the vcs commit", + "x-example": "7c3f25d" }, - "joined": { + "providerCommitAuthorUrl": { "type": "string", - "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "The url of vcs commit author", + "x-example": "https:\/\/github.com\/vermakhushboo" }, - "confirm": { - "type": "boolean", - "description": "User confirmation status, true if the user has joined the team or false otherwise.", - "x-example": false + "providerCommitAuthor": { + "type": "string", + "description": "The name of vcs commit author", + "x-example": "Khushboo Verma" }, - "mfa": { - "type": "boolean", - "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", - "x-example": false + "providerCommitMessage": { + "type": "string", + "description": "The commit message", + "x-example": "Update index.js" }, - "roles": { - "type": "array", - "description": "User list of roles", - "items": { - "type": "string" - }, - "x-example": [ - "owner" - ] + "providerCommitUrl": { + "type": "string", + "description": "The url of the vcs commit", + "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + }, + "providerBranch": { + "type": "string", + "description": "The branch of the vcs repository", + "x-example": "0.7.x" + }, + "providerBranchUrl": { + "type": "string", + "description": "The branch of the vcs repository", + "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "userId", - "userName", - "userEmail", - "userPhone", - "teamId", - "teamName", - "invited", - "joined", - "confirm", - "mfa", - "roles" + "type", + "resourceId", + "resourceType", + "entrypoint", + "sourceSize", + "buildSize", + "totalSize", + "buildId", + "activate", + "screenshotLight", + "screenshotDark", + "status", + "buildLogs", + "buildDuration", + "providerRepositoryName", + "providerRepositoryOwner", + "providerRepositoryUrl", + "providerCommitHash", + "providerCommitAuthorUrl", + "providerCommitAuthor", + "providerCommitMessage", + "providerCommitUrl", + "providerBranch", + "providerBranchUrl" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c16897e", - "userName": "John Doe", - "userEmail": "john@appwrite.io", - "userPhone": "+1 555 555 5555", - "teamId": "5e5ea5c16897e", - "teamName": "VIP", - "invited": "2020-10-15T06:38:00.000+00:00", - "joined": "2020-10-15T06:38:00.000+00:00", - "confirm": false, - "mfa": false, - "roles": [ - "owner" - ] + "type": "vcs", + "resourceId": "5e5ea6g16897e", + "resourceType": "functions", + "entrypoint": "index.js", + "sourceSize": 128, + "buildSize": 128, + "totalSize": 128, + "buildId": "5e5ea5c16897e", + "activate": true, + "screenshotLight": "5e5ea5c16897e", + "screenshotDark": "5e5ea5c16897e", + "status": "ready", + "buildLogs": "Compiling source files...", + "buildDuration": 128, + "providerRepositoryName": "database", + "providerRepositoryOwner": "utopia", + "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function", + "providerCommitHash": "7c3f25d", + "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo", + "providerCommitAuthor": "Khushboo Verma", + "providerCommitMessage": "Update index.js", + "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", + "providerBranch": "0.7.x", + "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, - "site": { - "description": "Site", + "execution": { + "description": "Execution", "type": "object", "properties": { "$id": { "type": "string", - "description": "Site ID.", + "description": "Execution ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Site creation date in ISO 8601 format.", + "description": "Execution creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Site update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "name": { - "type": "string", - "description": "Site name.", - "x-example": "My Site" - }, - "enabled": { - "type": "boolean", - "description": "Site enabled.", - "x-example": false - }, - "live": { - "type": "boolean", - "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false - }, - "framework": { - "type": "string", - "description": "Site framework.", - "x-example": "react" - }, - "deploymentRetention": { - "type": "integer", - "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" - }, - "deploymentId": { - "type": "string", - "description": "Site's active deployment ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentCreatedAt": { - "type": "string", - "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "deploymentScreenshotLight": { - "type": "string", - "description": "Screenshot of active deployment with light theme preference file ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentScreenshotDark": { - "type": "string", - "description": "Screenshot of active deployment with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" - }, - "latestDeploymentId": { - "type": "string", - "description": "Site's latest deployment ID.", - "x-example": "5e5ea5c16897e" - }, - "latestDeploymentCreatedAt": { - "type": "string", - "description": "Latest deployment creation date in ISO 8601 format.", + "description": "Execution update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "latestDeploymentStatus": { - "type": "string", - "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" - }, - "vars": { - "type": "array", - "description": "Site variables.", - "items": { - "$ref": "#\/components\/schemas\/variable" - }, - "x-example": [] - }, - "timeout": { - "type": "integer", - "description": "Site request timeout in seconds.", - "x-example": 300, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "The install command used to install the site dependencies.", - "x-example": "npm install" + "$permissions": { + "type": "array", + "description": "Execution roles.", + "items": { + "type": "string" + }, + "x-example": [ + "any" + ] }, - "buildCommand": { + "functionId": { "type": "string", - "description": "The build command used to build the site.", - "x-example": "npm run build" + "description": "Function ID.", + "x-example": "5e5ea6g16897e" }, - "startCommand": { + "deploymentId": { "type": "string", - "description": "Custom command to use when starting site runtime.", - "x-example": "node custom-server.mjs" + "description": "Function's deployment ID used to create the execution.", + "x-example": "5e5ea5c16897e" }, - "outputDirectory": { + "trigger": { "type": "string", - "description": "The directory where the site build output is located.", - "x-example": "build" + "description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.", + "x-example": "http", + "enum": [ + "http", + "schedule", + "event" + ] }, - "installationId": { + "status": { "type": "string", - "description": "Site VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", + "x-example": "processing", + "enum": [ + "waiting", + "processing", + "completed", + "failed", + "scheduled" + ] }, - "providerRepositoryId": { + "requestMethod": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "description": "HTTP request method type.", + "x-example": "GET" }, - "providerBranch": { + "requestPath": { "type": "string", - "description": "VCS (Version Control System) branch name", - "x-example": "main" + "description": "HTTP request path and query.", + "x-example": "\/articles?id=5" }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site in VCS (Version Control System) repository", - "x-example": "sites\/helloWorld" + "requestHeaders": { + "type": "array", + "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", + "items": { + "$ref": "#\/components\/schemas\/headers" + }, + "x-example": [ + { + "Content-Type": "application\/json" + } + ] }, - "providerSilentMode": { - "type": "boolean", - "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "responseStatusCode": { + "type": "integer", + "description": "HTTP response status code.", + "x-example": 200, + "format": "int32" }, - "buildSpecification": { + "responseBody": { "type": "string", - "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "description": "HTTP response body. This will return empty unless execution is created as synchronous.", + "x-example": "" }, - "runtimeSpecification": { - "type": "string", - "description": "Machine specification for SSR executions.", - "x-example": "s-1vcpu-512mb" + "responseHeaders": { + "type": "array", + "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", + "items": { + "$ref": "#\/components\/schemas\/headers" + }, + "x-example": [ + { + "Content-Type": "application\/json" + } + ] }, - "buildRuntime": { + "logs": { "type": "string", - "description": "Site build runtime.", - "x-example": "node-22" + "description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" }, - "adapter": { + "errors": { "type": "string", - "description": "Site framework adapter.", - "x-example": "static" + "description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" }, - "fallbackFile": { + "duration": { + "type": "number", + "description": "Resource(function\/site) execution duration in seconds.", + "x-example": 0.4, + "format": "double" + }, + "scheduledAt": { "type": "string", - "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true } }, "required": [ "$id", "$createdAt", "$updatedAt", - "name", - "enabled", - "live", - "logging", - "framework", - "deploymentRetention", + "$permissions", + "functionId", "deploymentId", - "deploymentCreatedAt", - "deploymentScreenshotLight", - "deploymentScreenshotDark", - "latestDeploymentId", - "latestDeploymentCreatedAt", - "latestDeploymentStatus", - "vars", - "timeout", - "installCommand", - "buildCommand", - "startCommand", - "outputDirectory", - "installationId", - "providerRepositoryId", - "providerBranch", - "providerRootDirectory", - "providerSilentMode", - "buildSpecification", - "runtimeSpecification", - "buildRuntime", - "adapter", - "fallbackFile" + "trigger", + "status", + "requestMethod", + "requestPath", + "requestHeaders", + "responseStatusCode", + "responseBody", + "responseHeaders", + "logs", + "errors", + "duration" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My Site", - "enabled": false, - "live": false, - "logging": false, - "framework": "react", - "deploymentRetention": 7, + "$permissions": [ + "any" + ], + "functionId": "5e5ea6g16897e", "deploymentId": "5e5ea5c16897e", - "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "deploymentScreenshotLight": "5e5ea5c16897e", - "deploymentScreenshotDark": "5e5ea5c16897e", - "latestDeploymentId": "5e5ea5c16897e", - "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentStatus": "ready", - "vars": [], - "timeout": 300, - "installCommand": "npm install", - "buildCommand": "npm run build", - "startCommand": "node custom-server.mjs", - "outputDirectory": "build", - "installationId": "6m40at4ejk5h2u9s1hboo", - "providerRepositoryId": "appwrite", - "providerBranch": "main", - "providerRootDirectory": "sites\/helloWorld", - "providerSilentMode": false, - "buildSpecification": "s-1vcpu-512mb", - "runtimeSpecification": "s-1vcpu-512mb", - "buildRuntime": "node-22", - "adapter": "static", - "fallbackFile": "index.html" + "trigger": "http", + "status": "processing", + "requestMethod": "GET", + "requestPath": "\/articles?id=5", + "requestHeaders": [ + { + "Content-Type": "application\/json" + } + ], + "responseStatusCode": 200, + "responseBody": "", + "responseHeaders": [ + { + "Content-Type": "application\/json" + } + ], + "logs": "", + "errors": "", + "duration": 0.4, + "scheduledAt": "2020-10-15T06:38:00.000+00:00" } }, - "templateSite": { - "description": "Template Site", + "project": { + "description": "Project", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Site Template ID.", - "x-example": "starter" - }, - "name": { - "type": "string", - "description": "Site Template Name.", - "x-example": "Starter site" - }, - "tagline": { - "type": "string", - "description": "Short description of template", - "x-example": "Minimal web app integrating with Appwrite." - }, - "demoUrl": { + "$id": { "type": "string", - "description": "URL hosting a template demo.", - "x-example": "https:\/\/nextjs-starter.appwrite.network\/" + "description": "Project ID.", + "x-example": "5e5ea5c16897e" }, - "screenshotDark": { + "$createdAt": { "type": "string", - "description": "File URL with preview screenshot in dark theme preference.", - "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png" + "description": "Project creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "screenshotLight": { + "$updatedAt": { "type": "string", - "description": "File URL with preview screenshot in light theme preference.", - "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png" - }, - "useCases": { - "type": "array", - "description": "Site use cases.", - "items": { - "type": "string" - }, - "x-example": "Starter" - }, - "frameworks": { - "type": "array", - "description": "List of frameworks that can be used with this template.", - "items": { - "$ref": "#\/components\/schemas\/templateFramework" - }, - "x-example": [] + "description": "Project update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "vcsProvider": { + "name": { "type": "string", - "description": "VCS (Version Control System) Provider.", - "x-example": "github" + "description": "Project name.", + "x-example": "New Project" }, - "providerRepositoryId": { + "description": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "templates" + "description": "Project description.", + "x-example": "This is a new project." }, - "providerOwner": { + "teamId": { "type": "string", - "description": "VCS (Version Control System) Owner.", - "x-example": "appwrite" + "description": "Project team ID.", + "x-example": "1592981250" }, - "providerVersion": { + "logo": { "type": "string", - "description": "VCS (Version Control System) branch version (tag).", - "x-example": "main" + "description": "Project logo file ID.", + "x-example": "5f5c451b403cb" }, - "variables": { - "type": "array", - "description": "Site variables.", - "items": { - "$ref": "#\/components\/schemas\/templateVariable" - }, - "x-example": [] - } - }, - "required": [ - "key", - "name", - "tagline", - "demoUrl", - "screenshotDark", - "screenshotLight", - "useCases", - "frameworks", - "vcsProvider", - "providerRepositoryId", - "providerOwner", - "providerVersion", - "variables" - ], - "example": { - "key": "starter", - "name": "Starter site", - "tagline": "Minimal web app integrating with Appwrite.", - "demoUrl": "https:\/\/nextjs-starter.appwrite.network\/", - "screenshotDark": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png", - "screenshotLight": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png", - "useCases": "Starter", - "frameworks": [], - "vcsProvider": "github", - "providerRepositoryId": "templates", - "providerOwner": "appwrite", - "providerVersion": "main", - "variables": [] - } - }, - "templateFramework": { - "description": "Template Framework", - "type": "object", - "properties": { - "key": { + "url": { "type": "string", - "description": "Parent framework key.", - "x-example": "sveltekit" + "description": "Project website URL.", + "x-example": "5f5c451b403cb" }, - "name": { + "legalName": { "type": "string", - "description": "Framework Name.", - "x-example": "SvelteKit" + "description": "Company legal name.", + "x-example": "Company LTD." }, - "installCommand": { + "legalCountry": { "type": "string", - "description": "The install command used to install the dependencies.", - "x-example": "npm install" + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", + "x-example": "US" }, - "buildCommand": { + "legalState": { "type": "string", - "description": "The build command used to build the deployment.", - "x-example": "npm run build" + "description": "State name.", + "x-example": "New York" }, - "outputDirectory": { + "legalCity": { "type": "string", - "description": "The output directory to store the build output.", - "x-example": ".\/build" + "description": "City name.", + "x-example": "New York City." }, - "providerRootDirectory": { + "legalAddress": { "type": "string", - "description": "Path to site in VCS (Version Control System) repository", - "x-example": ".\/svelte-kit\/starter" + "description": "Company Address.", + "x-example": "620 Eighth Avenue, New York, NY 10018" }, - "buildRuntime": { + "legalTaxId": { "type": "string", - "description": "Runtime used during build step of template.", - "x-example": "node-22" + "description": "Company Tax ID.", + "x-example": "131102020" }, - "adapter": { - "type": "string", - "description": "Site framework runtime", - "x-example": "ssr" + "authDuration": { + "type": "integer", + "description": "Session duration in seconds.", + "x-example": 60, + "format": "int32" }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for SPA. Only relevant for static serve runtime.", - "x-example": "index.html" - } - }, - "required": [ - "key", - "name", - "installCommand", - "buildCommand", - "outputDirectory", - "providerRootDirectory", - "buildRuntime", - "adapter", - "fallbackFile" - ], - "example": { - "key": "sveltekit", - "name": "SvelteKit", - "installCommand": "npm install", - "buildCommand": "npm run build", - "outputDirectory": ".\/build", - "providerRootDirectory": ".\/svelte-kit\/starter", - "buildRuntime": "node-22", - "adapter": "ssr", - "fallbackFile": "index.html" - } - }, - "function": { - "description": "Function", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Function ID.", - "x-example": "5e5ea5c16897e" + "authLimit": { + "type": "integer", + "description": "Max users allowed. 0 is unlimited.", + "x-example": 100, + "format": "int32" }, - "$createdAt": { - "type": "string", - "description": "Function creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authSessionsLimit": { + "type": "integer", + "description": "Max sessions allowed per user. 100 maximum.", + "x-example": 10, + "format": "int32" }, - "$updatedAt": { - "type": "string", - "description": "Function update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authPasswordHistory": { + "type": "integer", + "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", + "x-example": 5, + "format": "int32" }, - "execute": { - "type": "array", - "description": "Execution permissions.", - "items": { - "type": "string" - }, - "x-example": "users" + "authPasswordDictionary": { + "type": "boolean", + "description": "Whether or not to check user's password against most commonly used passwords.", + "x-example": true }, - "name": { - "type": "string", - "description": "Function name.", - "x-example": "My Function" + "authPersonalDataCheck": { + "type": "boolean", + "description": "Whether or not to check the user password for similarity with their personal data.", + "x-example": true }, - "enabled": { + "authDisposableEmails": { "type": "boolean", - "description": "Function enabled.", - "x-example": false + "description": "Whether or not to disallow disposable email addresses during signup and email updates.", + "x-example": true }, - "live": { + "authCanonicalEmails": { "type": "boolean", - "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", - "x-example": false + "description": "Whether or not to require canonical email addresses during signup and email updates.", + "x-example": true }, - "logging": { + "authFreeEmails": { "type": "boolean", - "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", - "x-example": false + "description": "Whether or not to disallow free email addresses during signup and email updates.", + "x-example": true }, - "runtime": { - "type": "string", - "description": "Function execution and build runtime.", - "x-example": "python-3.8" + "authMockNumbers": { + "type": "array", + "description": "An array of mock numbers and their corresponding verification codes (OTPs).", + "items": { + "$ref": "#\/components\/schemas\/mockNumber" + }, + "x-example": [ + {} + ] }, - "deploymentRetention": { - "type": "integer", - "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" + "authSessionAlerts": { + "type": "boolean", + "description": "Whether or not to send session alert emails to users.", + "x-example": true + }, + "authMembershipsUserName": { + "type": "boolean", + "description": "Whether or not to show user names in the teams membership response.", + "x-example": true }, - "deploymentId": { - "type": "string", - "description": "Function's active deployment ID.", - "x-example": "5e5ea5c16897e" + "authMembershipsUserEmail": { + "type": "boolean", + "description": "Whether or not to show user emails in the teams membership response.", + "x-example": true }, - "deploymentCreatedAt": { - "type": "string", - "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authMembershipsMfa": { + "type": "boolean", + "description": "Whether or not to show user MFA status in the teams membership response.", + "x-example": true }, - "latestDeploymentId": { - "type": "string", - "description": "Function's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "authMembershipsUserId": { + "type": "boolean", + "description": "Whether or not to show user IDs in the teams membership response.", + "x-example": true }, - "latestDeploymentCreatedAt": { - "type": "string", - "description": "Latest deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authMembershipsUserPhone": { + "type": "boolean", + "description": "Whether or not to show user phone numbers in the teams membership response.", + "x-example": true }, - "latestDeploymentStatus": { - "type": "string", - "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" + "authInvalidateSessions": { + "type": "boolean", + "description": "Whether or not all existing sessions should be invalidated on password change", + "x-example": true }, - "scopes": { + "oAuthProviders": { "type": "array", - "description": "Allowed permission scopes.", + "description": "List of Auth Providers.", "items": { - "type": "string" + "$ref": "#\/components\/schemas\/authProvider" }, - "x-example": "users.read" + "x-example": [ + {} + ] }, - "vars": { + "platforms": { "type": "array", - "description": "Function variables.", + "description": "List of Platforms.", "items": { - "$ref": "#\/components\/schemas\/variable" + "anyOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "web": "#\/components\/schemas\/platformWeb", + "apple": "#\/components\/schemas\/platformApple", + "android": "#\/components\/schemas\/platformAndroid", + "windows": "#\/components\/schemas\/platformWindows", + "linux": "#\/components\/schemas\/platformLinux" + } + } }, - "x-example": [] + "x-example": {} }, - "events": { + "webhooks": { "type": "array", - "description": "Function trigger events.", + "description": "List of Webhooks.", "items": { - "type": "string" + "$ref": "#\/components\/schemas\/webhook" }, - "x-example": "account.create" - }, - "schedule": { - "type": "string", - "description": "Function execution schedule in CRON format.", - "x-example": "5 4 * * *" + "x-example": {} }, - "timeout": { - "type": "integer", - "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" + "keys": { + "type": "array", + "description": "List of API Keys.", + "items": { + "$ref": "#\/components\/schemas\/key" + }, + "x-example": {} }, - "entrypoint": { - "type": "string", - "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "devKeys": { + "type": "array", + "description": "List of dev keys.", + "items": { + "$ref": "#\/components\/schemas\/devKey" + }, + "x-example": {} }, - "commands": { - "type": "string", - "description": "The build command used to build the deployment.", - "x-example": "npm install" + "smtpEnabled": { + "type": "boolean", + "description": "Status for custom SMTP", + "x-example": false }, - "version": { + "smtpSenderName": { "type": "string", - "description": "Version of Open Runtimes used for the function.", - "x-example": "v2" + "description": "SMTP sender name", + "x-example": "John Appwrite" }, - "installationId": { + "smtpSenderEmail": { "type": "string", - "description": "Function VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "description": "SMTP sender email", + "x-example": "john@appwrite.io" }, - "providerRepositoryId": { + "smtpReplyToName": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "description": "SMTP reply to name", + "x-example": "Support Team" }, - "providerBranch": { + "smtpReplyToEmail": { "type": "string", - "description": "VCS (Version Control System) branch name", - "x-example": "main" + "description": "SMTP reply to email", + "x-example": "support@appwrite.io" }, - "providerRootDirectory": { + "smtpHost": { "type": "string", - "description": "Path to function in VCS (Version Control System) repository", - "x-example": "functions\/helloWorld" + "description": "SMTP server host name", + "x-example": "mail.appwrite.io" }, - "providerSilentMode": { - "type": "boolean", - "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "smtpPort": { + "type": "integer", + "description": "SMTP server port", + "x-example": 25, + "format": "int32" }, - "buildSpecification": { + "smtpUsername": { "type": "string", - "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "description": "SMTP server username", + "x-example": "emailuser" }, - "runtimeSpecification": { - "type": "string", - "description": "Machine specification for executions.", - "x-example": "s-1vcpu-512mb" - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "execute", - "name", - "enabled", - "live", - "logging", - "runtime", - "deploymentRetention", - "deploymentId", - "deploymentCreatedAt", - "latestDeploymentId", - "latestDeploymentCreatedAt", - "latestDeploymentStatus", - "scopes", - "vars", - "events", - "schedule", - "timeout", - "entrypoint", - "commands", - "version", - "installationId", - "providerRepositoryId", - "providerBranch", - "providerRootDirectory", - "providerSilentMode", - "buildSpecification", - "runtimeSpecification" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "execute": "users", - "name": "My Function", - "enabled": false, - "live": false, - "logging": false, - "runtime": "python-3.8", - "deploymentRetention": 7, - "deploymentId": "5e5ea5c16897e", - "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentId": "5e5ea5c16897e", - "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentStatus": "ready", - "scopes": "users.read", - "vars": [], - "events": "account.create", - "schedule": "5 4 * * *", - "timeout": 300, - "entrypoint": "index.js", - "commands": "npm install", - "version": "v2", - "installationId": "6m40at4ejk5h2u9s1hboo", - "providerRepositoryId": "appwrite", - "providerBranch": "main", - "providerRootDirectory": "functions\/helloWorld", - "providerSilentMode": false, - "buildSpecification": "s-1vcpu-512mb", - "runtimeSpecification": "s-1vcpu-512mb" - } - }, - "templateFunction": { - "description": "Template Function", - "type": "object", - "properties": { - "icon": { + "smtpPassword": { "type": "string", - "description": "Function Template Icon.", - "x-example": "icon-lightning-bolt" + "description": "SMTP server password. This property is write-only and always returned empty.", + "x-example": "" }, - "id": { + "smtpSecure": { "type": "string", - "description": "Function Template ID.", - "x-example": "starter" + "description": "SMTP server secure protocol", + "x-example": "tls" }, - "name": { - "type": "string", - "description": "Function Template Name.", - "x-example": "Starter function" + "pingCount": { + "type": "integer", + "description": "Number of times the ping was received for this project.", + "x-example": 1, + "format": "int32" }, - "tagline": { + "pingedAt": { "type": "string", - "description": "Function Template Tagline.", - "x-example": "A simple function to get started." - }, - "permissions": { - "type": "array", - "description": "Execution permissions.", - "items": { - "type": "string" - }, - "x-example": "any" + "description": "Last ping datetime in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "events": { + "labels": { "type": "array", - "description": "Function trigger events.", + "description": "Labels for the project.", "items": { "type": "string" }, - "x-example": "account.create" + "x-example": [ + "vip" + ] }, - "cron": { + "status": { "type": "string", - "description": "Function execution schedult in CRON format.", - "x-example": "0 0 * * *" + "description": "Project status", + "x-example": "active" }, - "timeout": { - "type": "integer", - "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" + "authEmailPassword": { + "type": "boolean", + "description": "Email\/Password auth method status", + "x-example": true }, - "useCases": { - "type": "array", - "description": "Function use cases.", - "items": { - "type": "string" - }, - "x-example": "Starter" + "authUsersAuthMagicURL": { + "type": "boolean", + "description": "Magic URL auth method status", + "x-example": true }, - "runtimes": { - "type": "array", - "description": "List of runtimes that can be used with this template.", - "items": { - "$ref": "#\/components\/schemas\/templateRuntime" - }, - "x-example": [] + "authEmailOtp": { + "type": "boolean", + "description": "Email (OTP) auth method status", + "x-example": true }, - "instructions": { - "type": "string", - "description": "Function Template Instructions.", - "x-example": "For documentation and instructions check out ." + "authAnonymous": { + "type": "boolean", + "description": "Anonymous auth method status", + "x-example": true }, - "vcsProvider": { - "type": "string", - "description": "VCS (Version Control System) Provider.", - "x-example": "github" + "authInvites": { + "type": "boolean", + "description": "Invites auth method status", + "x-example": true }, - "providerRepositoryId": { - "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "templates" + "authJWT": { + "type": "boolean", + "description": "JWT auth method status", + "x-example": true }, - "providerOwner": { - "type": "string", - "description": "VCS (Version Control System) Owner.", - "x-example": "appwrite" + "authPhone": { + "type": "boolean", + "description": "Phone auth method status", + "x-example": true }, - "providerVersion": { - "type": "string", - "description": "VCS (Version Control System) branch version (tag).", - "x-example": "main" + "serviceStatusForAccount": { + "type": "boolean", + "description": "Account service status", + "x-example": true }, - "variables": { - "type": "array", - "description": "Function variables.", - "items": { - "$ref": "#\/components\/schemas\/templateVariable" - }, - "x-example": [] + "serviceStatusForAvatars": { + "type": "boolean", + "description": "Avatars service status", + "x-example": true }, - "scopes": { - "type": "array", - "description": "Function scopes.", - "items": { - "type": "string" - }, - "x-example": "users.read" - } - }, - "required": [ - "icon", - "id", - "name", - "tagline", - "permissions", - "events", - "cron", - "timeout", - "useCases", - "runtimes", - "instructions", - "vcsProvider", - "providerRepositoryId", - "providerOwner", - "providerVersion", - "variables", - "scopes" - ], - "example": { - "icon": "icon-lightning-bolt", - "id": "starter", - "name": "Starter function", - "tagline": "A simple function to get started.", - "permissions": "any", - "events": "account.create", - "cron": "0 0 * * *", - "timeout": 300, - "useCases": "Starter", - "runtimes": [], - "instructions": "For documentation and instructions check out .", - "vcsProvider": "github", - "providerRepositoryId": "templates", - "providerOwner": "appwrite", - "providerVersion": "main", - "variables": [], - "scopes": "users.read" - } - }, - "templateRuntime": { - "description": "Template Runtime", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Runtime Name.", - "x-example": "node-19.0" + "serviceStatusForDatabases": { + "type": "boolean", + "description": "Databases (legacy) service status", + "x-example": true }, - "commands": { - "type": "string", - "description": "The build command used to build the deployment.", - "x-example": "npm install" + "serviceStatusForTablesdb": { + "type": "boolean", + "description": "TablesDB service status", + "x-example": true }, - "entrypoint": { - "type": "string", - "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "serviceStatusForLocale": { + "type": "boolean", + "description": "Locale service status", + "x-example": true }, - "providerRootDirectory": { - "type": "string", - "description": "Path to function in VCS (Version Control System) repository", - "x-example": "node\/starter" - } - }, - "required": [ - "name", - "commands", - "entrypoint", - "providerRootDirectory" - ], - "example": { - "name": "node-19.0", - "commands": "npm install", - "entrypoint": "index.js", - "providerRootDirectory": "node\/starter" - } - }, - "templateVariable": { - "description": "Template Variable", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Variable Name.", - "x-example": "APPWRITE_DATABASE_ID" + "serviceStatusForHealth": { + "type": "boolean", + "description": "Health service status", + "x-example": true + }, + "serviceStatusForProject": { + "type": "boolean", + "description": "Project service status", + "x-example": true + }, + "serviceStatusForStorage": { + "type": "boolean", + "description": "Storage service status", + "x-example": true + }, + "serviceStatusForTeams": { + "type": "boolean", + "description": "Teams service status", + "x-example": true + }, + "serviceStatusForUsers": { + "type": "boolean", + "description": "Users service status", + "x-example": true + }, + "serviceStatusForVcs": { + "type": "boolean", + "description": "VCS service status", + "x-example": true }, - "description": { - "type": "string", - "description": "Variable Description.", - "x-example": "The ID of the Appwrite database that contains the collection to sync." + "serviceStatusForSites": { + "type": "boolean", + "description": "Sites service status", + "x-example": true }, - "value": { - "type": "string", - "description": "Variable Value.", - "x-example": "512" + "serviceStatusForFunctions": { + "type": "boolean", + "description": "Functions service status", + "x-example": true }, - "secret": { + "serviceStatusForProxy": { "type": "boolean", - "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", - "x-example": false + "description": "Proxy service status", + "x-example": true }, - "placeholder": { - "type": "string", - "description": "Variable Placeholder.", - "x-example": "64a55...7b912" + "serviceStatusForGraphql": { + "type": "boolean", + "description": "GraphQL service status", + "x-example": true }, - "required": { + "serviceStatusForMigrations": { "type": "boolean", - "description": "Is the variable required?", - "x-example": false + "description": "Migrations service status", + "x-example": true }, - "type": { - "type": "string", - "description": "Variable Type.", - "x-example": "password" - } - }, - "required": [ - "name", - "description", - "value", - "secret", - "placeholder", - "required", - "type" - ], - "example": { - "name": "APPWRITE_DATABASE_ID", - "description": "The ID of the Appwrite database that contains the collection to sync.", - "value": "512", - "secret": false, - "placeholder": "64a55...7b912", - "required": false, - "type": "password" - } - }, - "installation": { - "description": "Installation", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Function ID.", - "x-example": "5e5ea5c16897e" + "serviceStatusForMessaging": { + "type": "boolean", + "description": "Messaging service status", + "x-example": true }, - "$createdAt": { - "type": "string", - "description": "Function creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "protocolStatusForRest": { + "type": "boolean", + "description": "REST protocol status", + "x-example": true }, - "$updatedAt": { - "type": "string", - "description": "Function update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "protocolStatusForGraphql": { + "type": "boolean", + "description": "GraphQL protocol status", + "x-example": true }, - "provider": { - "type": "string", - "description": "VCS (Version Control System) provider name.", - "x-example": "github" + "protocolStatusForWebsocket": { + "type": "boolean", + "description": "Websocket protocol status", + "x-example": true }, - "organization": { + "region": { "type": "string", - "description": "VCS (Version Control System) organization name.", - "x-example": "appwrite" + "description": "Project region", + "x-example": "fra" }, - "providerInstallationId": { + "billingLimits": { + "type": "object", + "description": "Billing limits reached", + "x-example": "", + "items": { + "$ref": "#\/components\/schemas\/billingLimits" + } + }, + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "$ref": "#\/components\/schemas\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { "type": "string", - "description": "VCS (Version Control System) installation ID.", - "x-example": "5322" + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "provider", - "organization", - "providerInstallationId" + "name", + "description", + "teamId", + "logo", + "url", + "legalName", + "legalCountry", + "legalState", + "legalCity", + "legalAddress", + "legalTaxId", + "authDuration", + "authLimit", + "authSessionsLimit", + "authPasswordHistory", + "authPasswordDictionary", + "authPersonalDataCheck", + "authDisposableEmails", + "authCanonicalEmails", + "authFreeEmails", + "authMockNumbers", + "authSessionAlerts", + "authMembershipsUserName", + "authMembershipsUserEmail", + "authMembershipsMfa", + "authMembershipsUserId", + "authMembershipsUserPhone", + "authInvalidateSessions", + "oAuthProviders", + "platforms", + "webhooks", + "keys", + "devKeys", + "smtpEnabled", + "smtpSenderName", + "smtpSenderEmail", + "smtpReplyToName", + "smtpReplyToEmail", + "smtpHost", + "smtpPort", + "smtpUsername", + "smtpPassword", + "smtpSecure", + "pingCount", + "pingedAt", + "labels", + "status", + "authEmailPassword", + "authUsersAuthMagicURL", + "authEmailOtp", + "authAnonymous", + "authInvites", + "authJWT", + "authPhone", + "serviceStatusForAccount", + "serviceStatusForAvatars", + "serviceStatusForDatabases", + "serviceStatusForTablesdb", + "serviceStatusForLocale", + "serviceStatusForHealth", + "serviceStatusForProject", + "serviceStatusForStorage", + "serviceStatusForTeams", + "serviceStatusForUsers", + "serviceStatusForVcs", + "serviceStatusForSites", + "serviceStatusForFunctions", + "serviceStatusForProxy", + "serviceStatusForGraphql", + "serviceStatusForMigrations", + "serviceStatusForMessaging", + "protocolStatusForRest", + "protocolStatusForGraphql", + "protocolStatusForWebsocket", + "region", + "billingLimits", + "blocks", + "consoleAccessedAt" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "provider": "github", - "organization": "appwrite", - "providerInstallationId": "5322" + "name": "New Project", + "description": "This is a new project.", + "teamId": "1592981250", + "logo": "5f5c451b403cb", + "url": "5f5c451b403cb", + "legalName": "Company LTD.", + "legalCountry": "US", + "legalState": "New York", + "legalCity": "New York City.", + "legalAddress": "620 Eighth Avenue, New York, NY 10018", + "legalTaxId": "131102020", + "authDuration": 60, + "authLimit": 100, + "authSessionsLimit": 10, + "authPasswordHistory": 5, + "authPasswordDictionary": true, + "authPersonalDataCheck": true, + "authDisposableEmails": true, + "authCanonicalEmails": true, + "authFreeEmails": true, + "authMockNumbers": [ + {} + ], + "authSessionAlerts": true, + "authMembershipsUserName": true, + "authMembershipsUserEmail": true, + "authMembershipsMfa": true, + "authMembershipsUserId": true, + "authMembershipsUserPhone": true, + "authInvalidateSessions": true, + "oAuthProviders": [ + {} + ], + "platforms": {}, + "webhooks": {}, + "keys": {}, + "devKeys": {}, + "smtpEnabled": false, + "smtpSenderName": "John Appwrite", + "smtpSenderEmail": "john@appwrite.io", + "smtpReplyToName": "Support Team", + "smtpReplyToEmail": "support@appwrite.io", + "smtpHost": "mail.appwrite.io", + "smtpPort": 25, + "smtpUsername": "emailuser", + "smtpPassword": "", + "smtpSecure": "tls", + "pingCount": 1, + "pingedAt": "2020-10-15T06:38:00.000+00:00", + "labels": [ + "vip" + ], + "status": "active", + "authEmailPassword": true, + "authUsersAuthMagicURL": true, + "authEmailOtp": true, + "authAnonymous": true, + "authInvites": true, + "authJWT": true, + "authPhone": true, + "serviceStatusForAccount": true, + "serviceStatusForAvatars": true, + "serviceStatusForDatabases": true, + "serviceStatusForTablesdb": true, + "serviceStatusForLocale": true, + "serviceStatusForHealth": true, + "serviceStatusForProject": true, + "serviceStatusForStorage": true, + "serviceStatusForTeams": true, + "serviceStatusForUsers": true, + "serviceStatusForVcs": true, + "serviceStatusForSites": true, + "serviceStatusForFunctions": true, + "serviceStatusForProxy": true, + "serviceStatusForGraphql": true, + "serviceStatusForMigrations": true, + "serviceStatusForMessaging": true, + "protocolStatusForRest": true, + "protocolStatusForGraphql": true, + "protocolStatusForWebsocket": true, + "region": "fra", + "billingLimits": "", + "blocks": "", + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "providerRepository": { - "description": "ProviderRepository", + "webhook": { + "description": "Webhook", "type": "object", "properties": { - "id": { + "$id": { "type": "string", - "description": "VCS (Version Control System) repository ID.", + "description": "Webhook ID.", "x-example": "5e5ea5c16897e" }, - "name": { - "type": "string", - "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" - }, - "organization": { - "type": "string", - "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" - }, - "provider": { + "$createdAt": { "type": "string", - "description": "VCS (Version Control System) provider name.", - "x-example": "github" - }, - "private": { - "type": "boolean", - "description": "Is VCS (Version Control System) repository private?", - "x-example": true + "description": "Webhook creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "defaultBranch": { + "$updatedAt": { "type": "string", - "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "description": "Webhook update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerInstallationId": { + "name": { "type": "string", - "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" - }, - "authorized": { - "type": "boolean", - "description": "Is VCS (Version Control System) repository authorized for the installation?", - "x-example": true + "description": "Webhook name.", + "x-example": "My Webhook" }, - "pushedAt": { + "url": { "type": "string", - "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" + "description": "Webhook URL endpoint.", + "x-example": "https:\/\/example.com\/webhook" }, - "variables": { + "events": { "type": "array", - "description": "Environment variables found in .env files", + "description": "Webhook trigger events.", "items": { "type": "string" }, "x-example": [ - "PORT", - "NODE_ENV" + "databases.tables.update", + "databases.collections.update" ] - } - }, - "required": [ - "id", - "name", - "organization", - "provider", - "private", - "defaultBranch", - "providerInstallationId", - "authorized", - "pushedAt", - "variables" - ], - "example": { - "id": "5e5ea5c16897e", - "name": "appwrite", - "organization": "appwrite", - "provider": "github", - "private": true, - "defaultBranch": "main", - "providerInstallationId": "108104697", - "authorized": true, - "pushedAt": "datetime", - "variables": [ - "PORT", - "NODE_ENV" - ] - } - }, - "providerRepositoryFramework": { - "description": "ProviderRepositoryFramework", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "VCS (Version Control System) repository ID.", - "x-example": "5e5ea5c16897e" - }, - "name": { - "type": "string", - "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" - }, - "organization": { - "type": "string", - "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" - }, - "provider": { - "type": "string", - "description": "VCS (Version Control System) provider name.", - "x-example": "github" }, - "private": { + "tls": { "type": "boolean", - "description": "Is VCS (Version Control System) repository private?", + "description": "Indicates if SSL \/ TLS certificate verification is enabled.", "x-example": true }, - "defaultBranch": { + "authUsername": { "type": "string", - "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "description": "HTTP basic authentication username.", + "x-example": "username" }, - "providerInstallationId": { + "authPassword": { "type": "string", - "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" + "description": "HTTP basic authentication password.", + "x-example": "password" }, - "authorized": { + "secret": { + "type": "string", + "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", + "x-example": "ad3d581ca230e2b7059c545e5a" + }, + "enabled": { "type": "boolean", - "description": "Is VCS (Version Control System) repository authorized for the installation?", + "description": "Indicates if this webhook is enabled.", "x-example": true }, - "pushedAt": { + "logs": { "type": "string", - "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" - }, - "variables": { - "type": "array", - "description": "Environment variables found in .env files", - "items": { - "type": "string" - }, - "x-example": [ - "PORT", - "NODE_ENV" - ] + "description": "Webhook error logs from the most recent failure.", + "x-example": "Failed to connect to remote server." }, - "framework": { - "type": "string", - "description": "Auto-detected framework. Empty if type is not \"framework\".", - "x-example": "nextjs" + "attempts": { + "type": "integer", + "description": "Number of consecutive failed webhook attempts.", + "x-example": 10, + "format": "int32" } }, "required": [ - "id", + "$id", + "$createdAt", + "$updatedAt", "name", - "organization", - "provider", - "private", - "defaultBranch", - "providerInstallationId", - "authorized", - "pushedAt", - "variables", - "framework" + "url", + "events", + "tls", + "authUsername", + "authPassword", + "secret", + "enabled", + "logs", + "attempts" ], "example": { - "id": "5e5ea5c16897e", - "name": "appwrite", - "organization": "appwrite", - "provider": "github", - "private": true, - "defaultBranch": "main", - "providerInstallationId": "108104697", - "authorized": true, - "pushedAt": "datetime", - "variables": [ - "PORT", - "NODE_ENV" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Webhook", + "url": "https:\/\/example.com\/webhook", + "events": [ + "databases.tables.update", + "databases.collections.update" ], - "framework": "nextjs" + "tls": true, + "authUsername": "username", + "authPassword": "password", + "secret": "ad3d581ca230e2b7059c545e5a", + "enabled": true, + "logs": "Failed to connect to remote server.", + "attempts": 10 } - }, - "providerRepositoryRuntime": { - "description": "ProviderRepositoryRuntime", + }, + "key": { + "description": "Key", "type": "object", "properties": { - "id": { + "$id": { "type": "string", - "description": "VCS (Version Control System) repository ID.", + "description": "Key ID.", "x-example": "5e5ea5c16897e" }, - "name": { + "$createdAt": { "type": "string", - "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "organization": { + "$updatedAt": { "type": "string", - "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "provider": { + "name": { "type": "string", - "description": "VCS (Version Control System) provider name.", - "x-example": "github" - }, - "private": { - "type": "boolean", - "description": "Is VCS (Version Control System) repository private?", - "x-example": true + "description": "Key name.", + "x-example": "My API Key" }, - "defaultBranch": { + "expire": { "type": "string", - "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerInstallationId": { - "type": "string", - "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" }, - "authorized": { - "type": "boolean", - "description": "Is VCS (Version Control System) repository authorized for the installation?", - "x-example": true + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "pushedAt": { + "accessedAt": { "type": "string", - "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "variables": { + "sdks": { "type": "array", - "description": "Environment variables found in .env files", + "description": "List of SDK user agents that used this key.", "items": { "type": "string" }, - "x-example": [ - "PORT", - "NODE_ENV" - ] - }, - "runtime": { - "type": "string", - "description": "Auto-detected runtime. Empty if type is not \"runtime\".", - "x-example": "node-22" + "x-example": "appwrite:flutter" } }, "required": [ - "id", + "$id", + "$createdAt", + "$updatedAt", "name", - "organization", - "provider", - "private", - "defaultBranch", - "providerInstallationId", - "authorized", - "pushedAt", - "variables", - "runtime" + "expire", + "scopes", + "secret", + "accessedAt", + "sdks" ], "example": { - "id": "5e5ea5c16897e", - "name": "appwrite", - "organization": "appwrite", - "provider": "github", - "private": true, - "defaultBranch": "main", - "providerInstallationId": "108104697", - "authorized": true, - "pushedAt": "datetime", - "variables": [ - "PORT", - "NODE_ENV" - ], - "runtime": "node-22" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "scopes": "users.read", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" } }, - "detectionFramework": { - "description": "DetectionFramework", + "ephemeralKey": { + "description": "Ephemeral Key", "type": "object", "properties": { - "type": { + "$id": { "type": "string", - "description": "Repository detection type.", - "x-example": "framework", - "enum": [ - "framework" - ] - }, - "variables": { - "type": "array", - "description": "Environment variables found in .env files", - "items": { - "$ref": "#\/components\/schemas\/detectionVariable" - }, - "x-example": {}, - "nullable": true + "description": "Key ID.", + "x-example": "5e5ea5c16897e" }, - "framework": { + "$createdAt": { "type": "string", - "description": "Framework", - "x-example": "nuxt" + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "installCommand": { + "$updatedAt": { "type": "string", - "description": "Site Install Command", - "x-example": "npm install" + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "buildCommand": { + "name": { "type": "string", - "description": "Site Build Command", - "x-example": "npm run build" + "description": "Key name.", + "x-example": "My API Key" }, - "outputDirectory": { - "type": "string", - "description": "Site Output Directory", - "x-example": "dist" - } - }, - "required": [ - "type", - "framework", - "installCommand", - "buildCommand", - "outputDirectory" - ], - "example": { - "type": "framework", - "variables": {}, - "framework": "nuxt", - "installCommand": "npm install", - "buildCommand": "npm run build", - "outputDirectory": "dist" - } - }, - "detectionRuntime": { - "description": "DetectionRuntime", - "type": "object", - "properties": { - "type": { + "expire": { "type": "string", - "description": "Repository detection type.", - "x-example": "runtime", - "enum": [ - "runtime" - ] + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "variables": { + "scopes": { "type": "array", - "description": "Environment variables found in .env files", + "description": "Allowed permission scopes.", "items": { - "$ref": "#\/components\/schemas\/detectionVariable" + "type": "string" }, - "x-example": {}, - "nullable": true + "x-example": "users.read" }, - "runtime": { + "secret": { "type": "string", - "description": "Runtime", - "x-example": "node" + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "entrypoint": { + "accessedAt": { "type": "string", - "description": "Function Entrypoint", - "x-example": "index.js" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "commands": { - "type": "string", - "description": "Function install and build commands", - "x-example": "npm install && npm run build" + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" } }, "required": [ - "type", - "runtime", - "entrypoint", - "commands" + "$id", + "$createdAt", + "$updatedAt", + "name", + "expire", + "scopes", + "secret", + "accessedAt", + "sdks" ], "example": { - "type": "runtime", - "variables": {}, - "runtime": "node", - "entrypoint": "index.js", - "commands": "npm install && npm run build" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "scopes": "users.read", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" } }, - "detectionVariable": { - "description": "DetectionVariable", + "devKey": { + "description": "DevKey", "type": "object", "properties": { + "$id": { + "type": "string", + "description": "Key ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "name": { "type": "string", - "description": "Name of environment variable", - "x-example": "NODE_ENV" + "description": "Key name.", + "x-example": "Dev API Key" }, - "value": { + "expire": { "type": "string", - "description": "Value of environment variable", - "x-example": "production" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + }, + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" } }, "required": [ + "$id", + "$createdAt", + "$updatedAt", "name", - "value" + "expire", + "secret", + "accessedAt", + "sdks" ], "example": { - "name": "NODE_ENV", - "value": "production" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Dev API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" } }, - "vcsContent": { - "description": "VcsContents", + "mockNumber": { + "description": "Mock Number", "type": "object", "properties": { - "size": { - "type": "integer", - "description": "Content size in bytes. Only files have size, and for directories, 0 is returned.", - "x-example": 1523, - "format": "int32", - "nullable": true + "number": { + "type": "string", + "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", + "x-example": "+1612842323" }, - "isDirectory": { - "type": "boolean", - "description": "If a content is a directory. Directories can be used to check nested contents.", - "x-example": true, - "nullable": true + "otp": { + "type": "string", + "description": "Mock OTP for the number. ", + "x-example": "123456" }, - "name": { + "$createdAt": { "type": "string", - "description": "Name of directory or file.", - "x-example": "Main.java" + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "name" + "number", + "otp", + "$createdAt", + "$updatedAt" ], "example": { - "size": 1523, - "isDirectory": true, - "name": "Main.java" + "number": "+1612842323", + "otp": "123456", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "branch": { - "description": "Branch", + "oAuth2Github": { + "description": "OAuth2GitHub", "type": "object", "properties": { - "name": { + "$id": { "type": "string", - "description": "Branch Name.", - "x-example": "main" + "description": "OAuth2 provider ID.", + "x-example": "github" + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "clientId": { + "type": "string", + "description": "GitHub OAuth2 client ID. For GitHub Apps, use the \"App ID\" when both an App ID and client ID are available.", + "x-example": "e4d87900000000540733" + }, + "clientSecret": { + "type": "string", + "description": "GitHub OAuth2 client secret.", + "x-example": "5e07c00000000000000000000000000000198bcc" } }, "required": [ - "name" + "$id", + "enabled", + "clientId", + "clientSecret" ], "example": { - "name": "main" + "$id": "github", + "enabled": false, + "clientId": "e4d87900000000540733", + "clientSecret": "5e07c00000000000000000000000000000198bcc" } }, - "runtime": { - "description": "Runtime", + "oAuth2Discord": { + "description": "OAuth2Discord", "type": "object", "properties": { "$id": { "type": "string", - "description": "Runtime ID.", - "x-example": "python-3.8" - }, - "key": { - "type": "string", - "description": "Parent runtime key.", - "x-example": "python" - }, - "name": { - "type": "string", - "description": "Runtime Name.", - "x-example": "Python" - }, - "version": { - "type": "string", - "description": "Runtime version.", - "x-example": "3.8" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "base": { - "type": "string", - "description": "Base Docker image used to build the runtime.", - "x-example": "python:3.8-alpine" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "image": { + "clientId": { "type": "string", - "description": "Image name of Docker Hub.", - "x-example": "appwrite\\\/runtime-for-python:3.8" + "description": "Discord OAuth2 client ID.", + "x-example": "950722000000343754" }, - "logo": { + "clientSecret": { "type": "string", - "description": "Name of the logo image.", - "x-example": "python.png" - }, - "supports": { - "type": "array", - "description": "List of supported architectures.", - "items": { - "type": "string" - }, - "x-example": "amd64" + "description": "Discord OAuth2 client secret.", + "x-example": "YmPXnM000000000000000000002zFg5D" } }, "required": [ "$id", - "key", - "name", - "version", - "base", - "image", - "logo", - "supports" + "enabled", + "clientId", + "clientSecret" ], "example": { - "$id": "python-3.8", - "key": "python", - "name": "Python", - "version": "3.8", - "base": "python:3.8-alpine", - "image": "appwrite\\\/runtime-for-python:3.8", - "logo": "python.png", - "supports": "amd64" + "$id": "github", + "enabled": false, + "clientId": "950722000000343754", + "clientSecret": "YmPXnM000000000000000000002zFg5D" } }, - "framework": { - "description": "Framework", + "oAuth2Figma": { + "description": "OAuth2Figma", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Framework key.", - "x-example": "sveltekit" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "name": { - "type": "string", - "description": "Framework Name.", - "x-example": "SvelteKit" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "buildRuntime": { + "clientId": { "type": "string", - "description": "Default runtime version.", - "x-example": "node-22" - }, - "runtimes": { - "type": "array", - "description": "List of supported runtime versions.", - "items": { - "type": "string" - }, - "x-example": [ - "static-1", - "node-22" - ] + "description": "Figma OAuth2 client ID.", + "x-example": "byay5H0000000000VtiI40" }, - "adapters": { - "type": "array", - "description": "List of supported adapters.", - "items": { - "$ref": "#\/components\/schemas\/frameworkAdapter" - }, - "x-example": [ - { - "key": "static", - "buildRuntime": "node-22", - "buildCommand": "npm run build", - "installCommand": "npm install", - "outputDirectory": ".\/dist" - } - ] + "clientSecret": { + "type": "string", + "description": "Figma OAuth2 client secret.", + "x-example": "yEpOYn0000000000000000004iIsU5" } }, "required": [ - "key", - "name", - "buildRuntime", - "runtimes", - "adapters" + "$id", + "enabled", + "clientId", + "clientSecret" ], "example": { - "key": "sveltekit", - "name": "SvelteKit", - "buildRuntime": "node-22", - "runtimes": [ - "static-1", - "node-22" - ], - "adapters": [ - { - "key": "static", - "buildRuntime": "node-22", - "buildCommand": "npm run build", - "installCommand": "npm install", - "outputDirectory": ".\/dist" - } - ] + "$id": "github", + "enabled": false, + "clientId": "byay5H0000000000VtiI40", + "clientSecret": "yEpOYn0000000000000000004iIsU5" } }, - "frameworkAdapter": { - "description": "Framework Adapter", + "oAuth2Dropbox": { + "description": "OAuth2Dropbox", "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Adapter key.", - "x-example": "static" - }, - "installCommand": { + "properties": { + "$id": { "type": "string", - "description": "Default command to download dependencies.", - "x-example": "npm install" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "buildCommand": { - "type": "string", - "description": "Default command to build site into output directory.", - "x-example": "npm run build" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "outputDirectory": { + "appKey": { "type": "string", - "description": "Default output directory of build.", - "x-example": ".\/dist" + "description": "Dropbox OAuth2 app key.", + "x-example": "jl000000000009t" }, - "fallbackFile": { + "appSecret": { "type": "string", - "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "description": "Dropbox OAuth2 app secret.", + "x-example": "g200000000000vw" } }, "required": [ - "key", - "installCommand", - "buildCommand", - "outputDirectory", - "fallbackFile" + "$id", + "enabled", + "appKey", + "appSecret" ], "example": { - "key": "static", - "installCommand": "npm install", - "buildCommand": "npm run build", - "outputDirectory": ".\/dist", - "fallbackFile": "index.html" + "$id": "github", + "enabled": false, + "appKey": "jl000000000009t", + "appSecret": "g200000000000vw" } }, - "deployment": { - "description": "Deployment", + "oAuth2Dailymotion": { + "description": "OAuth2Dailymotion", "type": "object", "properties": { "$id": { "type": "string", - "description": "Deployment ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "apiKey": { "type": "string", - "description": "Deployment update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Dailymotion OAuth2 API key.", + "x-example": "07a9000000000000067f" }, - "type": { + "apiSecret": { "type": "string", - "description": "Type of deployment.", - "x-example": "vcs" - }, - "resourceId": { + "description": "Dailymotion OAuth2 API secret.", + "x-example": "a399a90000000000000000000000000000d90639" + } + }, + "required": [ + "$id", + "enabled", + "apiKey", + "apiSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "apiKey": "07a9000000000000067f", + "apiSecret": "a399a90000000000000000000000000000d90639" + } + }, + "oAuth2Bitbucket": { + "description": "OAuth2Bitbucket", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea6g16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "resourceType": { - "type": "string", - "description": "Resource type.", - "x-example": "functions" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "entrypoint": { + "key": { "type": "string", - "description": "The entrypoint file to use to execute the deployment code.", - "x-example": "index.js" - }, - "sourceSize": { - "type": "integer", - "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" - }, - "buildSize": { - "type": "integer", - "description": "The build output size in bytes.", - "x-example": 128, - "format": "int32" - }, - "totalSize": { - "type": "integer", - "description": "The total size in bytes (source and build output).", - "x-example": 128, - "format": "int32" + "description": "Bitbucket OAuth2 key.", + "x-example": "Knt70000000000ByRc" }, - "buildId": { + "secret": { "type": "string", - "description": "The current build ID.", - "x-example": "5e5ea5c16897e" + "description": "Bitbucket OAuth2 secret.", + "x-example": "NMfLZJ00000000000000000000TLQdDx" + } + }, + "required": [ + "$id", + "enabled", + "key", + "secret" + ], + "example": { + "$id": "github", + "enabled": false, + "key": "Knt70000000000ByRc", + "secret": "NMfLZJ00000000000000000000TLQdDx" + } + }, + "oAuth2Bitly": { + "description": "OAuth2Bitly", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "activate": { + "enabled": { "type": "boolean", - "description": "Whether the deployment should be automatically activated.", - "x-example": true - }, - "screenshotLight": { - "type": "string", - "description": "Screenshot with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "screenshotDark": { + "clientId": { "type": "string", - "description": "Screenshot with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "description": "Bitly OAuth2 client ID.", + "x-example": "d95151000000000000000000000000000067af9b" }, - "status": { + "clientSecret": { "type": "string", - "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", - "x-example": "ready", - "enum": [ - "waiting", - "processing", - "building", - "ready", - "canceled", - "failed" - ] - }, - "buildLogs": { + "description": "Bitly OAuth2 client secret.", + "x-example": "a13e250000000000000000000000000000d73095" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "d95151000000000000000000000000000067af9b", + "clientSecret": "a13e250000000000000000000000000000d73095" + } + }, + "oAuth2Box": { + "description": "OAuth2Box", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The build logs.", - "x-example": "Compiling source files..." + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "buildDuration": { - "type": "integer", - "description": "The current build time in seconds.", - "x-example": 128, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerRepositoryName": { + "clientId": { "type": "string", - "description": "The name of the vcs provider repository", - "x-example": "database" + "description": "Box OAuth2 client ID.", + "x-example": "deglcs00000000000000000000x2og6y" }, - "providerRepositoryOwner": { + "clientSecret": { "type": "string", - "description": "The name of the vcs provider repository owner", - "x-example": "utopia" - }, - "providerRepositoryUrl": { + "description": "Box OAuth2 client secret.", + "x-example": "OKM1f100000000000000000000eshEif" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "deglcs00000000000000000000x2og6y", + "clientSecret": "OKM1f100000000000000000000eshEif" + } + }, + "oAuth2Autodesk": { + "description": "OAuth2Autodesk", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The url of the vcs provider repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "providerCommitHash": { - "type": "string", - "description": "The commit hash of the vcs commit", - "x-example": "7c3f25d" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerCommitAuthorUrl": { + "clientId": { "type": "string", - "description": "The url of vcs commit author", - "x-example": "https:\/\/github.com\/vermakhushboo" + "description": "Autodesk OAuth2 client ID.", + "x-example": "5zw90v00000000000000000000kVYXN7" }, - "providerCommitAuthor": { + "clientSecret": { "type": "string", - "description": "The name of vcs commit author", - "x-example": "Khushboo Verma" - }, - "providerCommitMessage": { + "description": "Autodesk OAuth2 client secret.", + "x-example": "7I000000000000MW" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "5zw90v00000000000000000000kVYXN7", + "clientSecret": "7I000000000000MW" + } + }, + "oAuth2Google": { + "description": "OAuth2Google", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The commit message", - "x-example": "Update index.js" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "providerCommitUrl": { - "type": "string", - "description": "The url of the vcs commit", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerBranch": { + "clientId": { "type": "string", - "description": "The branch of the vcs repository", - "x-example": "0.7.x" + "description": "Google OAuth2 client ID.", + "x-example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" }, - "providerBranchUrl": { + "clientSecret": { "type": "string", - "description": "The branch of the vcs repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "description": "Google OAuth2 client secret.", + "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "type", - "resourceId", - "resourceType", - "entrypoint", - "sourceSize", - "buildSize", - "totalSize", - "buildId", - "activate", - "screenshotLight", - "screenshotDark", - "status", - "buildLogs", - "buildDuration", - "providerRepositoryName", - "providerRepositoryOwner", - "providerRepositoryUrl", - "providerCommitHash", - "providerCommitAuthorUrl", - "providerCommitAuthor", - "providerCommitMessage", - "providerCommitUrl", - "providerBranch", - "providerBranchUrl" + "enabled", + "clientId", + "clientSecret" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "type": "vcs", - "resourceId": "5e5ea6g16897e", - "resourceType": "functions", - "entrypoint": "index.js", - "sourceSize": 128, - "buildSize": 128, - "totalSize": 128, - "buildId": "5e5ea5c16897e", - "activate": true, - "screenshotLight": "5e5ea5c16897e", - "screenshotDark": "5e5ea5c16897e", - "status": "ready", - "buildLogs": "Compiling source files...", - "buildDuration": 128, - "providerRepositoryName": "database", - "providerRepositoryOwner": "utopia", - "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function", - "providerCommitHash": "7c3f25d", - "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo", - "providerCommitAuthor": "Khushboo Verma", - "providerCommitMessage": "Update index.js", - "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", - "providerBranch": "0.7.x", - "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "$id": "github", + "enabled": false, + "clientId": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", + "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj" } }, - "execution": { - "description": "Execution", + "oAuth2Zoom": { + "description": "OAuth2Zoom", "type": "object", "properties": { "$id": { "type": "string", - "description": "Execution ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Execution creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Execution update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Execution roles.", - "items": { - "type": "string" - }, - "x-example": [ - "any" - ] + "description": "Zoom OAuth2 client ID.", + "x-example": "QMAC00000000000000w0AQ" }, - "functionId": { + "clientSecret": { "type": "string", - "description": "Function ID.", - "x-example": "5e5ea6g16897e" - }, - "deploymentId": { + "description": "Zoom OAuth2 client secret.", + "x-example": "GAWsG4000000000000000000007U01ON" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "QMAC00000000000000w0AQ", + "clientSecret": "GAWsG4000000000000000000007U01ON" + } + }, + "oAuth2Zoho": { + "description": "OAuth2Zoho", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Function's deployment ID used to create the execution.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "trigger": { - "type": "string", - "description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.", - "x-example": "http", - "enum": [ - "http", - "schedule", - "event" - ] + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "status": { + "clientId": { "type": "string", - "description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", - "x-example": "processing", - "enum": [ - "waiting", - "processing", - "completed", - "failed", - "scheduled" - ] + "description": "Zoho OAuth2 client ID.", + "x-example": "1000.83C178000000000000000000RPNX0B" }, - "requestMethod": { + "clientSecret": { "type": "string", - "description": "HTTP request method type.", - "x-example": "GET" - }, - "requestPath": { + "description": "Zoho OAuth2 client secret.", + "x-example": "fb5cac000000000000000000000000000000a68f6e" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "1000.83C178000000000000000000RPNX0B", + "clientSecret": "fb5cac000000000000000000000000000000a68f6e" + } + }, + "oAuth2Yandex": { + "description": "OAuth2Yandex", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "HTTP request path and query.", - "x-example": "\/articles?id=5" - }, - "requestHeaders": { - "type": "array", - "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", - "items": { - "$ref": "#\/components\/schemas\/headers" - }, - "x-example": [ - { - "Content-Type": "application\/json" - } - ] + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "responseStatusCode": { - "type": "integer", - "description": "HTTP response status code.", - "x-example": 200, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "responseBody": { + "clientId": { "type": "string", - "description": "HTTP response body. This will return empty unless execution is created as synchronous.", - "x-example": "" - }, - "responseHeaders": { - "type": "array", - "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", - "items": { - "$ref": "#\/components\/schemas\/headers" - }, - "x-example": [ - { - "Content-Type": "application\/json" - } - ] + "description": "Yandex OAuth2 client ID.", + "x-example": "6a8a6a0000000000000000000091483c" }, - "logs": { + "clientSecret": { "type": "string", - "description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" - }, - "errors": { + "description": "Yandex OAuth2 client secret.", + "x-example": "bbf98500000000000000000000c75a63" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "6a8a6a0000000000000000000091483c", + "clientSecret": "bbf98500000000000000000000c75a63" + } + }, + "oAuth2X": { + "description": "OAuth2X", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "duration": { - "type": "number", - "description": "Resource(function\/site) execution duration in seconds.", - "x-example": 0.4, - "format": "double" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "scheduledAt": { + "customerKey": { "type": "string", - "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "nullable": true + "description": "X OAuth2 customer key.", + "x-example": "slzZV0000000000000NFLaWT" + }, + "secretKey": { + "type": "string", + "description": "X OAuth2 secret key.", + "x-example": "tkEPkp00000000000000000000000000000000000000FTxbI9" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "$permissions", - "functionId", - "deploymentId", - "trigger", - "status", - "requestMethod", - "requestPath", - "requestHeaders", - "responseStatusCode", - "responseBody", - "responseHeaders", - "logs", - "errors", - "duration" + "enabled", + "customerKey", + "secretKey" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "any" - ], - "functionId": "5e5ea6g16897e", - "deploymentId": "5e5ea5c16897e", - "trigger": "http", - "status": "processing", - "requestMethod": "GET", - "requestPath": "\/articles?id=5", - "requestHeaders": [ - { - "Content-Type": "application\/json" - } - ], - "responseStatusCode": 200, - "responseBody": "", - "responseHeaders": [ - { - "Content-Type": "application\/json" - } - ], - "logs": "", - "errors": "", - "duration": 0.4, - "scheduledAt": "2020-10-15T06:38:00.000+00:00" + "$id": "github", + "enabled": false, + "customerKey": "slzZV0000000000000NFLaWT", + "secretKey": "tkEPkp00000000000000000000000000000000000000FTxbI9" + } + }, + "oAuth2WordPress": { + "description": "OAuth2WordPress", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "clientId": { + "type": "string", + "description": "WordPress OAuth2 client ID.", + "x-example": "130005" + }, + "clientSecret": { + "type": "string", + "description": "WordPress OAuth2 client secret.", + "x-example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "130005", + "clientSecret": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" } }, - "project": { - "description": "Project", + "oAuth2Twitch": { + "description": "OAuth2Twitch", "type": "object", "properties": { "$id": { "type": "string", - "description": "Project ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Project creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$updatedAt": { - "type": "string", - "description": "Project update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "name": { + "clientId": { "type": "string", - "description": "Project name.", - "x-example": "New Project" + "description": "Twitch OAuth2 client ID.", + "x-example": "vvi0in000000000000000000ikmt9p" }, - "description": { + "clientSecret": { "type": "string", - "description": "Project description.", - "x-example": "This is a new project." - }, - "teamId": { + "description": "Twitch OAuth2 client secret.", + "x-example": "pmapue000000000000000000zylw3v" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "vvi0in000000000000000000ikmt9p", + "clientSecret": "pmapue000000000000000000zylw3v" + } + }, + "oAuth2Stripe": { + "description": "OAuth2Stripe", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Project team ID.", - "x-example": "1592981250" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "logo": { - "type": "string", - "description": "Project logo file ID.", - "x-example": "5f5c451b403cb" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "url": { + "clientId": { "type": "string", - "description": "Project website URL.", - "x-example": "5f5c451b403cb" + "description": "Stripe OAuth2 client ID.", + "x-example": "ca_UKibXX0000000000000000000006byvR" }, - "legalName": { + "apiSecretKey": { "type": "string", - "description": "Company legal name.", - "x-example": "Company LTD." - }, - "legalCountry": { + "description": "Stripe OAuth2 API secret key.", + "x-example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "apiSecretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "ca_UKibXX0000000000000000000006byvR", + "apiSecretKey": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + } + }, + "oAuth2Spotify": { + "description": "OAuth2Spotify", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", - "x-example": "US" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "legalState": { - "type": "string", - "description": "State name.", - "x-example": "New York" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "legalCity": { + "clientId": { "type": "string", - "description": "City name.", - "x-example": "New York City." + "description": "Spotify OAuth2 client ID.", + "x-example": "6ec271000000000000000000009beace" }, - "legalAddress": { + "clientSecret": { "type": "string", - "description": "Company Address.", - "x-example": "620 Eighth Avenue, New York, NY 10018" - }, - "legalTaxId": { + "description": "Spotify OAuth2 client secret.", + "x-example": "db068a000000000000000000008b5b9f" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "6ec271000000000000000000009beace", + "clientSecret": "db068a000000000000000000008b5b9f" + } + }, + "oAuth2Slack": { + "description": "OAuth2Slack", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Company Tax ID.", - "x-example": "131102020" - }, - "authDuration": { - "type": "integer", - "description": "Session duration in seconds.", - "x-example": 60, - "format": "int32" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authLimit": { - "type": "integer", - "description": "Max users allowed. 0 is unlimited.", - "x-example": 100, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authSessionsLimit": { - "type": "integer", - "description": "Max sessions allowed per user. 100 maximum.", - "x-example": 10, - "format": "int32" + "clientId": { + "type": "string", + "description": "Slack OAuth2 client ID.", + "x-example": "23000000089.15000000000023" }, - "authPasswordHistory": { - "type": "integer", - "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", - "x-example": 5, - "format": "int32" + "clientSecret": { + "type": "string", + "description": "Slack OAuth2 client secret.", + "x-example": "81656000000000000000000000f3d2fd" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "23000000089.15000000000023", + "clientSecret": "81656000000000000000000000f3d2fd" + } + }, + "oAuth2Podio": { + "description": "OAuth2Podio", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authPasswordDictionary": { + "enabled": { "type": "boolean", - "description": "Whether or not to check user's password against most commonly used passwords.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authPersonalDataCheck": { - "type": "boolean", - "description": "Whether or not to check the user password for similarity with their personal data.", - "x-example": true + "clientId": { + "type": "string", + "description": "Podio OAuth2 client ID.", + "x-example": "appwrite-oauth-test-app" }, - "authDisposableEmails": { - "type": "boolean", - "description": "Whether or not to disallow disposable email addresses during signup and email updates.", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Podio OAuth2 client secret.", + "x-example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "appwrite-oauth-test-app", + "clientSecret": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + } + }, + "oAuth2Notion": { + "description": "OAuth2Notion", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authCanonicalEmails": { + "enabled": { "type": "boolean", - "description": "Whether or not to require canonical email addresses during signup and email updates.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authFreeEmails": { - "type": "boolean", - "description": "Whether or not to disallow free email addresses during signup and email updates.", - "x-example": true + "oauthClientId": { + "type": "string", + "description": "Notion OAuth2 client ID.", + "x-example": "341d8700-0000-0000-0000-000000446ee3" }, - "authMockNumbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs).", - "items": { - "$ref": "#\/components\/schemas\/mockNumber" - }, - "x-example": [ - {} - ] + "oauthClientSecret": { + "type": "string", + "description": "Notion OAuth2 client secret.", + "x-example": "secret_dLUr4b000000000000000000000000000000lFHAa9" + } + }, + "required": [ + "$id", + "enabled", + "oauthClientId", + "oauthClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "oauthClientId": "341d8700-0000-0000-0000-000000446ee3", + "oauthClientSecret": "secret_dLUr4b000000000000000000000000000000lFHAa9" + } + }, + "oAuth2Salesforce": { + "description": "OAuth2Salesforce", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authSessionAlerts": { + "enabled": { "type": "boolean", - "description": "Whether or not to send session alert emails to users.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authMembershipsUserName": { - "type": "boolean", - "description": "Whether or not to show user names in the teams membership response.", - "x-example": true + "customerKey": { + "type": "string", + "description": "Salesforce OAuth2 consumer key.", + "x-example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" }, - "authMembershipsUserEmail": { - "type": "boolean", - "description": "Whether or not to show user emails in the teams membership response.", - "x-example": true + "customerSecret": { + "type": "string", + "description": "Salesforce OAuth2 consumer secret.", + "x-example": "3w000000000000e2" + } + }, + "required": [ + "$id", + "enabled", + "customerKey", + "customerSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "customerKey": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", + "customerSecret": "3w000000000000e2" + } + }, + "oAuth2Yahoo": { + "description": "OAuth2Yahoo", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authMembershipsMfa": { + "enabled": { "type": "boolean", - "description": "Whether or not to show user MFA status in the teams membership response.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authMembershipsUserId": { - "type": "boolean", - "description": "Whether or not to show user IDs in the teams membership response.", - "x-example": true + "clientId": { + "type": "string", + "description": "Yahoo OAuth2 client ID.", + "x-example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" }, - "authMembershipsUserPhone": { - "type": "boolean", - "description": "Whether or not to show user phone numbers in the teams membership response.", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Yahoo OAuth2 client secret.", + "x-example": "cf978f0000000000000000000000000000c5e2e9" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", + "clientSecret": "cf978f0000000000000000000000000000c5e2e9" + } + }, + "oAuth2Linkedin": { + "description": "OAuth2Linkedin", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authInvalidateSessions": { + "enabled": { "type": "boolean", - "description": "Whether or not all existing sessions should be invalidated on password change", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "oAuthProviders": { - "type": "array", - "description": "List of Auth Providers.", - "items": { - "$ref": "#\/components\/schemas\/authProvider" - }, - "x-example": [ - {} - ] + "clientId": { + "type": "string", + "description": "LinkedIn OAuth2 client ID.", + "x-example": "770000000000dv" }, - "platforms": { - "type": "array", - "description": "List of Platforms.", - "items": { - "anyOf": [ - { - "$ref": "#\/components\/schemas\/platformWeb" - }, - { - "$ref": "#\/components\/schemas\/platformApple" - }, - { - "$ref": "#\/components\/schemas\/platformAndroid" - }, - { - "$ref": "#\/components\/schemas\/platformWindows" - }, - { - "$ref": "#\/components\/schemas\/platformLinux" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/components\/schemas\/platformWeb", - "apple": "#\/components\/schemas\/platformApple", - "android": "#\/components\/schemas\/platformAndroid", - "windows": "#\/components\/schemas\/platformWindows", - "linux": "#\/components\/schemas\/platformLinux" - } - } - }, - "x-example": {} + "primaryClientSecret": { + "type": "string", + "description": "LinkedIn OAuth2 primary client secret.", + "x-example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "primaryClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "770000000000dv", + "primaryClientSecret": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + } + }, + "oAuth2Disqus": { + "description": "OAuth2Disqus", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "webhooks": { - "type": "array", - "description": "List of Webhooks.", - "items": { - "$ref": "#\/components\/schemas\/webhook" - }, - "x-example": {} + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "keys": { - "type": "array", - "description": "List of API Keys.", - "items": { - "$ref": "#\/components\/schemas\/key" - }, - "x-example": {} + "publicKey": { + "type": "string", + "description": "Disqus OAuth2 public key.", + "x-example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" }, - "devKeys": { - "type": "array", - "description": "List of dev keys.", - "items": { - "$ref": "#\/components\/schemas\/devKey" - }, - "x-example": {} + "secretKey": { + "type": "string", + "description": "Disqus OAuth2 secret key.", + "x-example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + } + }, + "required": [ + "$id", + "enabled", + "publicKey", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "publicKey": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", + "secretKey": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + } + }, + "oAuth2Amazon": { + "description": "OAuth2Amazon", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpEnabled": { + "enabled": { "type": "boolean", - "description": "Status for custom SMTP", + "description": "OAuth2 provider is active and can be used to create sessions.", "x-example": false }, - "smtpSenderName": { + "clientId": { "type": "string", - "description": "SMTP sender name", - "x-example": "John Appwrite" + "description": "Amazon OAuth2 client ID.", + "x-example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" }, - "smtpSenderEmail": { + "clientSecret": { "type": "string", - "description": "SMTP sender email", - "x-example": "john@appwrite.io" - }, - "smtpReplyToName": { + "description": "Amazon OAuth2 client secret.", + "x-example": "79ffe4000000000000000000000000000000000000000000000000000002de55" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2", + "clientSecret": "79ffe4000000000000000000000000000000000000000000000000000002de55" + } + }, + "oAuth2Etsy": { + "description": "OAuth2Etsy", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "SMTP reply to name", - "x-example": "Support Team" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpReplyToEmail": { + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "keyString": { "type": "string", - "description": "SMTP reply to email", - "x-example": "support@appwrite.io" + "description": "Etsy OAuth2 keystring.", + "x-example": "nsgzxh0000000000008j85a2" }, - "smtpHost": { + "sharedSecret": { "type": "string", - "description": "SMTP server host name", - "x-example": "mail.appwrite.io" + "description": "Etsy OAuth2 shared secret.", + "x-example": "tp000000ru" + } + }, + "required": [ + "$id", + "enabled", + "keyString", + "sharedSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "keyString": "nsgzxh0000000000008j85a2", + "sharedSecret": "tp000000ru" + } + }, + "oAuth2Facebook": { + "description": "OAuth2Facebook", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpPort": { - "type": "integer", - "description": "SMTP server port", - "x-example": 25, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "smtpUsername": { + "appId": { "type": "string", - "description": "SMTP server username", - "x-example": "emailuser" + "description": "Facebook OAuth2 app ID.", + "x-example": "260600000007694" }, - "smtpPassword": { + "appSecret": { "type": "string", - "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "" - }, - "smtpSecure": { + "description": "Facebook OAuth2 app secret.", + "x-example": "2d0b2800000000000000000000d38af4" + } + }, + "required": [ + "$id", + "enabled", + "appId", + "appSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "appId": "260600000007694", + "appSecret": "2d0b2800000000000000000000d38af4" + } + }, + "oAuth2Tradeshift": { + "description": "OAuth2Tradeshift", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "SMTP server secure protocol", - "x-example": "tls" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "pingCount": { - "type": "integer", - "description": "Number of times the ping was received for this project.", - "x-example": 1, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "pingedAt": { + "oauth2ClientId": { "type": "string", - "description": "Last ping datetime in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "labels": { - "type": "array", - "description": "Labels for the project.", - "items": { - "type": "string" - }, - "x-example": [ - "vip" - ] + "description": "Tradeshift OAuth2 client ID.", + "x-example": "appwrite-test-org.appwrite-test-app" }, - "status": { + "oauth2ClientSecret": { + "type": "string", + "description": "Tradeshift OAuth2 client secret.", + "x-example": "7cb52700-0000-0000-0000-000000ca5b83" + } + }, + "required": [ + "$id", + "enabled", + "oauth2ClientId", + "oauth2ClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "oauth2ClientId": "appwrite-test-org.appwrite-test-app", + "oauth2ClientSecret": "7cb52700-0000-0000-0000-000000ca5b83" + } + }, + "oAuth2Paypal": { + "description": "OAuth2Paypal", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Project status", - "x-example": "active" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authEmailPassword": { + "enabled": { "type": "boolean", - "description": "Email\/Password auth method status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authUsersAuthMagicURL": { - "type": "boolean", - "description": "Magic URL auth method status", - "x-example": true + "clientId": { + "type": "string", + "description": "PayPal OAuth2 client ID.", + "x-example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" }, - "authEmailOtp": { - "type": "boolean", - "description": "Email (OTP) auth method status", - "x-example": true + "secretKey": { + "type": "string", + "description": "PayPal OAuth2 secret key.", + "x-example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "secretKey": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + } + }, + "oAuth2Gitlab": { + "description": "OAuth2Gitlab", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authAnonymous": { + "enabled": { "type": "boolean", - "description": "Anonymous auth method status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authInvites": { - "type": "boolean", - "description": "Invites auth method status", - "x-example": true + "applicationId": { + "type": "string", + "description": "GitLab OAuth2 application ID.", + "x-example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" }, - "authJWT": { - "type": "boolean", - "description": "JWT auth method status", - "x-example": true + "secret": { + "type": "string", + "description": "GitLab OAuth2 secret.", + "x-example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" }, - "authPhone": { - "type": "boolean", - "description": "Phone auth method status", - "x-example": true + "endpoint": { + "type": "string", + "description": "GitLab OAuth2 endpoint URL. Defaults to https:\/\/gitlab.com for self-hosted instances.", + "x-example": "https:\/\/gitlab.com" + } + }, + "required": [ + "$id", + "enabled", + "applicationId", + "secret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "applicationId": "d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "secret": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "endpoint": "https:\/\/gitlab.com" + } + }, + "oAuth2Authentik": { + "description": "OAuth2Authentik", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForAccount": { + "enabled": { "type": "boolean", - "description": "Account service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForAvatars": { - "type": "boolean", - "description": "Avatars service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Authentik OAuth2 client ID.", + "x-example": "dTKOPa0000000000000000000000000000e7G8hv" }, - "serviceStatusForDatabases": { - "type": "boolean", - "description": "Databases (legacy) service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Authentik OAuth2 client secret.", + "x-example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" }, - "serviceStatusForTablesdb": { - "type": "boolean", - "description": "TablesDB service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Authentik OAuth2 endpoint domain.", + "x-example": "example.authentik.com" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "dTKOPa0000000000000000000000000000e7G8hv", + "clientSecret": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", + "endpoint": "example.authentik.com" + } + }, + "oAuth2Auth0": { + "description": "OAuth2Auth0", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForLocale": { + "enabled": { "type": "boolean", - "description": "Locale service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForHealth": { - "type": "boolean", - "description": "Health service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Auth0 OAuth2 client ID.", + "x-example": "OaOkIA000000000000000000005KLSYq" }, - "serviceStatusForProject": { - "type": "boolean", - "description": "Project service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Auth0 OAuth2 client secret.", + "x-example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" }, - "serviceStatusForStorage": { - "type": "boolean", - "description": "Storage service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Auth0 OAuth2 endpoint domain.", + "x-example": "example.us.auth0.com" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "OaOkIA000000000000000000005KLSYq", + "clientSecret": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", + "endpoint": "example.us.auth0.com" + } + }, + "oAuth2FusionAuth": { + "description": "OAuth2FusionAuth", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForTeams": { + "enabled": { "type": "boolean", - "description": "Teams service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForUsers": { - "type": "boolean", - "description": "Users service status", - "x-example": true + "clientId": { + "type": "string", + "description": "FusionAuth OAuth2 client ID.", + "x-example": "b2222c00-0000-0000-0000-000000862097" }, - "serviceStatusForVcs": { - "type": "boolean", - "description": "VCS service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "FusionAuth OAuth2 client secret.", + "x-example": "Jx4s0C0000000000000000000000000000000wGqLsc" }, - "serviceStatusForSites": { - "type": "boolean", - "description": "Sites service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "FusionAuth OAuth2 endpoint domain.", + "x-example": "example.fusionauth.io" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "b2222c00-0000-0000-0000-000000862097", + "clientSecret": "Jx4s0C0000000000000000000000000000000wGqLsc", + "endpoint": "example.fusionauth.io" + } + }, + "oAuth2Keycloak": { + "description": "OAuth2Keycloak", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForFunctions": { + "enabled": { "type": "boolean", - "description": "Functions service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForProxy": { - "type": "boolean", - "description": "Proxy service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Keycloak OAuth2 client ID.", + "x-example": "appwrite-o0000000st-app" }, - "serviceStatusForGraphql": { - "type": "boolean", - "description": "GraphQL service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Keycloak OAuth2 client secret.", + "x-example": "jdjrJd00000000000000000000HUsaZO" }, - "serviceStatusForMigrations": { - "type": "boolean", - "description": "Migrations service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Keycloak OAuth2 endpoint domain.", + "x-example": "keycloak.example.com" }, - "serviceStatusForMessaging": { - "type": "boolean", - "description": "Messaging service status", - "x-example": true + "realmName": { + "type": "string", + "description": "Keycloak OAuth2 realm name.", + "x-example": "appwrite-realm" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint", + "realmName" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "appwrite-o0000000st-app", + "clientSecret": "jdjrJd00000000000000000000HUsaZO", + "endpoint": "keycloak.example.com", + "realmName": "appwrite-realm" + } + }, + "oAuth2Oidc": { + "description": "OAuth2Oidc", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "protocolStatusForRest": { + "enabled": { "type": "boolean", - "description": "REST protocol status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "protocolStatusForGraphql": { - "type": "boolean", - "description": "GraphQL protocol status", - "x-example": true + "clientId": { + "type": "string", + "description": "OpenID Connect OAuth2 client ID.", + "x-example": "qibI2x0000000000000000000000000006L2YFoG" }, - "protocolStatusForWebsocket": { - "type": "boolean", - "description": "Websocket protocol status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "OpenID Connect OAuth2 client secret.", + "x-example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" }, - "region": { + "wellKnownURL": { "type": "string", - "description": "Project region", - "x-example": "fra" + "description": "OpenID Connect well-known configuration URL. When set, authorization, token, and user info endpoints can be discovered automatically.", + "x-example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" }, - "billingLimits": { - "type": "object", - "description": "Billing limits reached", - "x-example": "", - "items": { - "$ref": "#\/components\/schemas\/billingLimits" - } + "authorizationURL": { + "type": "string", + "description": "OpenID Connect authorization endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" }, - "blocks": { - "type": "array", - "description": "Project blocks information", - "items": { - "$ref": "#\/components\/schemas\/block" - }, - "x-example": "" + "tokenUrl": { + "type": "string", + "description": "OpenID Connect token endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/token" }, - "consoleAccessedAt": { + "userInfoUrl": { "type": "string", - "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "OpenID Connect user info endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "description", - "teamId", - "logo", - "url", - "legalName", - "legalCountry", - "legalState", - "legalCity", - "legalAddress", - "legalTaxId", - "authDuration", - "authLimit", - "authSessionsLimit", - "authPasswordHistory", - "authPasswordDictionary", - "authPersonalDataCheck", - "authDisposableEmails", - "authCanonicalEmails", - "authFreeEmails", - "authMockNumbers", - "authSessionAlerts", - "authMembershipsUserName", - "authMembershipsUserEmail", - "authMembershipsMfa", - "authMembershipsUserId", - "authMembershipsUserPhone", - "authInvalidateSessions", - "oAuthProviders", - "platforms", - "webhooks", - "keys", - "devKeys", - "smtpEnabled", - "smtpSenderName", - "smtpSenderEmail", - "smtpReplyToName", - "smtpReplyToEmail", - "smtpHost", - "smtpPort", - "smtpUsername", - "smtpPassword", - "smtpSecure", - "pingCount", - "pingedAt", - "labels", - "status", - "authEmailPassword", - "authUsersAuthMagicURL", - "authEmailOtp", - "authAnonymous", - "authInvites", - "authJWT", - "authPhone", - "serviceStatusForAccount", - "serviceStatusForAvatars", - "serviceStatusForDatabases", - "serviceStatusForTablesdb", - "serviceStatusForLocale", - "serviceStatusForHealth", - "serviceStatusForProject", - "serviceStatusForStorage", - "serviceStatusForTeams", - "serviceStatusForUsers", - "serviceStatusForVcs", - "serviceStatusForSites", - "serviceStatusForFunctions", - "serviceStatusForProxy", - "serviceStatusForGraphql", - "serviceStatusForMigrations", - "serviceStatusForMessaging", - "protocolStatusForRest", - "protocolStatusForGraphql", - "protocolStatusForWebsocket", - "region", - "billingLimits", - "blocks", - "consoleAccessedAt" + "enabled", + "clientId", + "clientSecret", + "wellKnownURL", + "authorizationURL", + "tokenUrl", + "userInfoUrl" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "New Project", - "description": "This is a new project.", - "teamId": "1592981250", - "logo": "5f5c451b403cb", - "url": "5f5c451b403cb", - "legalName": "Company LTD.", - "legalCountry": "US", - "legalState": "New York", - "legalCity": "New York City.", - "legalAddress": "620 Eighth Avenue, New York, NY 10018", - "legalTaxId": "131102020", - "authDuration": 60, - "authLimit": 100, - "authSessionsLimit": 10, - "authPasswordHistory": 5, - "authPasswordDictionary": true, - "authPersonalDataCheck": true, - "authDisposableEmails": true, - "authCanonicalEmails": true, - "authFreeEmails": true, - "authMockNumbers": [ - {} - ], - "authSessionAlerts": true, - "authMembershipsUserName": true, - "authMembershipsUserEmail": true, - "authMembershipsMfa": true, - "authMembershipsUserId": true, - "authMembershipsUserPhone": true, - "authInvalidateSessions": true, - "oAuthProviders": [ - {} - ], - "platforms": {}, - "webhooks": {}, - "keys": {}, - "devKeys": {}, - "smtpEnabled": false, - "smtpSenderName": "John Appwrite", - "smtpSenderEmail": "john@appwrite.io", - "smtpReplyToName": "Support Team", - "smtpReplyToEmail": "support@appwrite.io", - "smtpHost": "mail.appwrite.io", - "smtpPort": 25, - "smtpUsername": "emailuser", - "smtpPassword": "", - "smtpSecure": "tls", - "pingCount": 1, - "pingedAt": "2020-10-15T06:38:00.000+00:00", - "labels": [ - "vip" - ], - "status": "active", - "authEmailPassword": true, - "authUsersAuthMagicURL": true, - "authEmailOtp": true, - "authAnonymous": true, - "authInvites": true, - "authJWT": true, - "authPhone": true, - "serviceStatusForAccount": true, - "serviceStatusForAvatars": true, - "serviceStatusForDatabases": true, - "serviceStatusForTablesdb": true, - "serviceStatusForLocale": true, - "serviceStatusForHealth": true, - "serviceStatusForProject": true, - "serviceStatusForStorage": true, - "serviceStatusForTeams": true, - "serviceStatusForUsers": true, - "serviceStatusForVcs": true, - "serviceStatusForSites": true, - "serviceStatusForFunctions": true, - "serviceStatusForProxy": true, - "serviceStatusForGraphql": true, - "serviceStatusForMigrations": true, - "serviceStatusForMessaging": true, - "protocolStatusForRest": true, - "protocolStatusForGraphql": true, - "protocolStatusForWebsocket": true, - "region": "fra", - "billingLimits": "", - "blocks": "", - "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + "$id": "github", + "enabled": false, + "clientId": "qibI2x0000000000000000000000000006L2YFoG", + "clientSecret": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", + "wellKnownURL": "https:\/\/myoauth.com\/.well-known\/openid-configuration", + "authorizationURL": "https:\/\/myoauth.com\/oauth2\/authorize", + "tokenUrl": "https:\/\/myoauth.com\/oauth2\/token", + "userInfoUrl": "https:\/\/myoauth.com\/oauth2\/userinfo" } }, - "webhook": { - "description": "Webhook", + "oAuth2Okta": { + "description": "OAuth2Okta", "type": "object", "properties": { "$id": { "type": "string", - "description": "Webhook ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Webhook creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Webhook update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Okta OAuth2 client ID.", + "x-example": "0oa00000000000000698" }, - "name": { + "clientSecret": { "type": "string", - "description": "Webhook name.", - "x-example": "My Webhook" + "description": "Okta OAuth2 client secret.", + "x-example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" }, - "url": { + "domain": { "type": "string", - "description": "Webhook URL endpoint.", - "x-example": "https:\/\/example.com\/webhook" + "description": "Okta OAuth2 domain.", + "x-example": "trial-6400025.okta.com" }, - "events": { - "type": "array", - "description": "Webhook trigger events.", - "items": { - "type": "string" - }, - "x-example": [ - "databases.tables.update", - "databases.collections.update" - ] + "authorizationServerId": { + "type": "string", + "description": "Okta OAuth2 authorization server ID.", + "x-example": "aus000000000000000h7z" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "domain", + "authorizationServerId" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "0oa00000000000000698", + "clientSecret": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "domain": "trial-6400025.okta.com", + "authorizationServerId": "aus000000000000000h7z" + } + }, + "oAuth2Kick": { + "description": "OAuth2Kick", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "tls": { + "enabled": { "type": "boolean", - "description": "Indicates if SSL \/ TLS certificate verification is enabled.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authUsername": { + "clientId": { "type": "string", - "description": "HTTP basic authentication username.", - "x-example": "username" + "description": "Kick OAuth2 client ID.", + "x-example": "01KQ7C00000000000001MFHS32" }, - "authPassword": { + "clientSecret": { "type": "string", - "description": "HTTP basic authentication password.", - "x-example": "password" - }, - "secret": { + "description": "Kick OAuth2 client secret.", + "x-example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "01KQ7C00000000000001MFHS32", + "clientSecret": "34ac5600000000000000000000000000000000000000000000000000e830c8b" + } + }, + "oAuth2Apple": { + "description": "OAuth2Apple", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", - "x-example": "ad3d581ca230e2b7059c545e5a" + "description": "OAuth2 provider ID.", + "x-example": "apple" }, "enabled": { "type": "boolean", - "description": "Indicates if this webhook is enabled.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "logs": { + "serviceId": { "type": "string", - "description": "Webhook error logs from the most recent failure.", - "x-example": "Failed to connect to remote server." + "description": "Apple OAuth2 service ID.", + "x-example": "ip.appwrite.app.web" }, - "attempts": { - "type": "integer", - "description": "Number of consecutive failed webhook attempts.", - "x-example": 10, - "format": "int32" + "keyId": { + "type": "string", + "description": "Apple OAuth2 key ID.", + "x-example": "P4000000N8" + }, + "teamId": { + "type": "string", + "description": "Apple OAuth2 team ID.", + "x-example": "D4000000R6" + }, + "p8File": { + "type": "string", + "description": "Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.", + "x-example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "url", - "events", - "tls", - "authUsername", - "authPassword", - "secret", "enabled", - "logs", - "attempts" + "serviceId", + "keyId", + "teamId", + "p8File" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My Webhook", - "url": "https:\/\/example.com\/webhook", - "events": [ - "databases.tables.update", - "databases.collections.update" - ], - "tls": true, - "authUsername": "username", - "authPassword": "password", - "secret": "ad3d581ca230e2b7059c545e5a", - "enabled": true, - "logs": "Failed to connect to remote server.", - "attempts": 10 + "$id": "apple", + "enabled": false, + "serviceId": "ip.appwrite.app.web", + "keyId": "P4000000N8", + "teamId": "D4000000R6", + "p8File": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" } }, - "key": { - "description": "Key", + "oAuth2Microsoft": { + "description": "OAuth2Microsoft", "type": "object", "properties": { "$id": { "type": "string", - "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "applicationId": { "type": "string", - "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Microsoft OAuth2 application ID.", + "x-example": "00001111-aaaa-2222-bbbb-3333cccc4444" }, - "name": { + "applicationSecret": { "type": "string", - "description": "Key name.", - "x-example": "My API Key" + "description": "Microsoft OAuth2 application secret.", + "x-example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" }, - "expire": { + "tenant": { "type": "string", - "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID.", + "x-example": "common" + } + }, + "required": [ + "$id", + "enabled", + "applicationId", + "applicationSecret", + "tenant" + ], + "example": { + "$id": "github", + "enabled": false, + "applicationId": "00001111-aaaa-2222-bbbb-3333cccc4444", + "applicationSecret": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", + "tenant": "common" + } + }, + "oAuth2ProviderList": { + "description": "OAuth2 Providers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of OAuth2 providers in the given project.", + "x-example": 5, + "format": "int32" }, - "scopes": { + "providers": { "type": "array", - "description": "Allowed permission scopes.", + "description": "List of OAuth2 providers.", "items": { - "type": "string" + "anyOf": [ + { + "$ref": "#\/components\/schemas\/oAuth2Github" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Discord" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Figma" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Dropbox" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Dailymotion" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Bitbucket" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Bitly" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Box" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Autodesk" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Google" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Zoom" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Zoho" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Yandex" + }, + { + "$ref": "#\/components\/schemas\/oAuth2X" + }, + { + "$ref": "#\/components\/schemas\/oAuth2WordPress" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Twitch" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Stripe" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Spotify" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Slack" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Podio" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Notion" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Salesforce" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Yahoo" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Linkedin" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Disqus" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Amazon" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Etsy" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Facebook" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Tradeshift" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Paypal" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Gitlab" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Authentik" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Auth0" + }, + { + "$ref": "#\/components\/schemas\/oAuth2FusionAuth" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Keycloak" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Oidc" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Apple" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Okta" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Kick" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Microsoft" + } + ], + "discriminator": { + "propertyName": "$id", + "mapping": { + "github": "#\/components\/schemas\/oAuth2Github", + "discord": "#\/components\/schemas\/oAuth2Discord", + "figma": "#\/components\/schemas\/oAuth2Figma", + "dropbox": "#\/components\/schemas\/oAuth2Dropbox", + "dailymotion": "#\/components\/schemas\/oAuth2Dailymotion", + "bitbucket": "#\/components\/schemas\/oAuth2Bitbucket", + "bitly": "#\/components\/schemas\/oAuth2Bitly", + "box": "#\/components\/schemas\/oAuth2Box", + "autodesk": "#\/components\/schemas\/oAuth2Autodesk", + "google": "#\/components\/schemas\/oAuth2Google", + "zoom": "#\/components\/schemas\/oAuth2Zoom", + "zoho": "#\/components\/schemas\/oAuth2Zoho", + "yandex": "#\/components\/schemas\/oAuth2Yandex", + "x": "#\/components\/schemas\/oAuth2X", + "wordpress": "#\/components\/schemas\/oAuth2WordPress", + "twitch": "#\/components\/schemas\/oAuth2Twitch", + "stripe": "#\/components\/schemas\/oAuth2Stripe", + "spotify": "#\/components\/schemas\/oAuth2Spotify", + "slack": "#\/components\/schemas\/oAuth2Slack", + "podio": "#\/components\/schemas\/oAuth2Podio", + "notion": "#\/components\/schemas\/oAuth2Notion", + "salesforce": "#\/components\/schemas\/oAuth2Salesforce", + "yahoo": "#\/components\/schemas\/oAuth2Yahoo", + "linkedin": "#\/components\/schemas\/oAuth2Linkedin", + "disqus": "#\/components\/schemas\/oAuth2Disqus", + "amazon": "#\/components\/schemas\/oAuth2Amazon", + "etsy": "#\/components\/schemas\/oAuth2Etsy", + "facebook": "#\/components\/schemas\/oAuth2Facebook", + "tradeshift": "#\/components\/schemas\/oAuth2Tradeshift", + "tradeshiftBox": "#\/components\/schemas\/oAuth2Tradeshift", + "paypal": "#\/components\/schemas\/oAuth2Paypal", + "paypalSandbox": "#\/components\/schemas\/oAuth2Paypal", + "gitlab": "#\/components\/schemas\/oAuth2Gitlab", + "authentik": "#\/components\/schemas\/oAuth2Authentik", + "auth0": "#\/components\/schemas\/oAuth2Auth0", + "fusionauth": "#\/components\/schemas\/oAuth2FusionAuth", + "keycloak": "#\/components\/schemas\/oAuth2Keycloak", + "oidc": "#\/components\/schemas\/oAuth2Oidc", + "apple": "#\/components\/schemas\/oAuth2Apple", + "okta": "#\/components\/schemas\/oAuth2Okta", + "kick": "#\/components\/schemas\/oAuth2Kick", + "microsoft": "#\/components\/schemas\/oAuth2Microsoft" + } + } }, - "x-example": "users.read" - }, - "secret": { - "type": "string", - "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" - }, - "accessedAt": { + "x-example": "" + } + }, + "required": [ + "total", + "providers" + ], + "example": { + "total": 5, + "providers": "" + } + }, + "policyPasswordDictionary": { + "description": "Policy Password Dictionary", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "sdks": { - "type": "array", - "description": "List of SDK user agents that used this key.", - "items": { - "type": "string" - }, - "x-example": "appwrite:flutter" + "enabled": { + "type": "boolean", + "description": "Whether password dictionary policy is enabled.", + "x-example": true } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "expire", - "scopes", - "secret", - "accessedAt", - "sdks" + "enabled" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My API Key", - "expire": "2020-10-15T06:38:00.000+00:00", - "scopes": "users.read", - "secret": "919c2d18fb5d4...a2ae413da83346ad2", - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "sdks": "appwrite:flutter" + "$id": "password-dictionary", + "enabled": true } }, - "devKey": { - "description": "DevKey", + "policyPasswordHistory": { + "description": "Policy Password History", "type": "object", "properties": { "$id": { "type": "string", - "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "$createdAt": { + "total": { + "type": "integer", + "description": "Password history length. A value of 0 means the policy is disabled.", + "x-example": 5, + "format": "int32" + } + }, + "required": [ + "$id", + "total" + ], + "example": { + "$id": "password-dictionary", + "total": 5 + } + }, + "policyPasswordPersonalData": { + "description": "Policy Password Personal Data", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "$updatedAt": { + "enabled": { + "type": "boolean", + "description": "Whether password personal data policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionAlert": { + "description": "Policy Session Alert", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "name": { + "enabled": { + "type": "boolean", + "description": "Whether session alert policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionDuration": { + "description": "Policy Session Duration", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key name.", - "x-example": "Dev API Key" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "expire": { + "duration": { + "type": "integer", + "description": "Session duration in seconds.", + "x-example": 3600, + "format": "int32" + } + }, + "required": [ + "$id", + "duration" + ], + "example": { + "$id": "password-dictionary", + "duration": 3600 + } + }, + "policySessionInvalidation": { + "description": "Policy Session Invalidation", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "secret": { + "enabled": { + "type": "boolean", + "description": "Whether session invalidation policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionLimit": { + "description": "Policy Session Limit", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "accessedAt": { + "total": { + "type": "integer", + "description": "Maximum number of sessions allowed per user. A value of 0 means the policy is disabled.", + "x-example": 10, + "format": "int32" + } + }, + "required": [ + "$id", + "total" + ], + "example": { + "$id": "password-dictionary", + "total": 10 + } + }, + "policyUserLimit": { + "description": "Policy User Limit", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "sdks": { - "type": "array", - "description": "List of SDK user agents that used this key.", - "items": { - "type": "string" - }, - "x-example": "appwrite:flutter" + "total": { + "type": "integer", + "description": "Maximum number of users allowed in the project. A value of 0 means the policy is disabled.", + "x-example": 100, + "format": "int32" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "expire", - "secret", - "accessedAt", - "sdks" + "total" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "Dev API Key", - "expire": "2020-10-15T06:38:00.000+00:00", - "secret": "919c2d18fb5d4...a2ae413da83346ad2", - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "sdks": "appwrite:flutter" + "$id": "password-dictionary", + "total": 100 } }, - "mockNumber": { - "description": "Mock Number", + "policyMembershipPrivacy": { + "description": "Policy Membership Privacy", "type": "object", "properties": { - "phone": { + "$id": { "type": "string", - "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", - "x-example": "+1612842323" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "otp": { - "type": "string", - "description": "Mock OTP for the number. ", - "x-example": "123456" + "userId": { + "type": "boolean", + "description": "Whether user ID is visible in memberships.", + "x-example": true + }, + "userEmail": { + "type": "boolean", + "description": "Whether user email is visible in memberships.", + "x-example": true + }, + "userPhone": { + "type": "boolean", + "description": "Whether user phone is visible in memberships.", + "x-example": true + }, + "userName": { + "type": "boolean", + "description": "Whether user name is visible in memberships.", + "x-example": true + }, + "userMFA": { + "type": "boolean", + "description": "Whether user MFA status is visible in memberships.", + "x-example": true } }, "required": [ - "phone", - "otp" + "$id", + "userId", + "userEmail", + "userPhone", + "userName", + "userMFA" ], "example": { - "phone": "+1612842323", - "otp": "123456" + "$id": "password-dictionary", + "userId": true, + "userEmail": true, + "userPhone": true, + "userName": true, + "userMFA": true } }, "authProvider": { @@ -80447,8 +87429,8 @@ }, "secret": { "type": "string", - "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.", - "x-example": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ" + "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.", + "x-example": "" }, "enabled": { "type": "boolean", @@ -80467,7 +87449,7 @@ "key": "github", "name": "GitHub", "appId": "259125845563242502", - "secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ", + "secret": "", "enabled": "" } }, @@ -84127,6 +91109,165 @@ "_APP_CONSOLE_EMAIL_VERIFICATION": "true" } }, + "consoleOAuth2ProviderParameter": { + "description": "Console OAuth2 Provider Parameter", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Parameter ID. Maps to the request body field used by the project OAuth2 update endpoint (e.g. `clientId`, `appKey`, `tenant`).", + "x-example": "clientId" + }, + "name": { + "type": "string", + "description": "Verbose, user-facing parameter name as shown in the provider's own dashboard. Includes alternate names when the provider exposes more than one.", + "x-example": "Client ID or App ID" + }, + "example": { + "type": "string", + "description": "Example value for this parameter.", + "x-example": "e4d87900000000540733" + }, + "hint": { + "type": "string", + "description": "Optional hint for this parameter, typically calling out a common wrong value. Empty string when no hint is set.", + "x-example": "Example of wrong value: 370006" + } + }, + "required": [ + "$id", + "name", + "example", + "hint" + ], + "example": { + "$id": "clientId", + "name": "Client ID or App ID", + "example": "e4d87900000000540733", + "hint": "Example of wrong value: 370006" + } + }, + "consoleOAuth2Provider": { + "description": "Console OAuth2 Provider", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" + }, + "parameters": { + "type": "array", + "description": "List of parameters required to configure this OAuth2 provider.", + "items": { + "$ref": "#\/components\/schemas\/consoleOAuth2ProviderParameter" + }, + "x-example": "" + } + }, + "required": [ + "$id", + "parameters" + ], + "example": { + "$id": "github", + "parameters": "" + } + }, + "consoleOAuth2ProviderList": { + "description": "Console OAuth2 Providers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of OAuth2 providers exposed by the server.", + "x-example": 5, + "format": "int32" + }, + "oAuth2Providers": { + "type": "array", + "description": "List of OAuth2 providers, each with the parameters required to configure it.", + "items": { + "$ref": "#\/components\/schemas\/consoleOAuth2Provider" + }, + "x-example": "" + } + }, + "required": [ + "total", + "oAuth2Providers" + ], + "example": { + "total": 5, + "oAuth2Providers": "" + } + }, + "consoleKeyScope": { + "description": "Console Key Scope", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Scope ID.", + "x-example": "users.read" + }, + "description": { + "type": "string", + "description": "Scope description.", + "x-example": "Access to read your project's users" + }, + "category": { + "type": "string", + "description": "Scope category.", + "x-example": "Auth" + }, + "deprecated": { + "type": "boolean", + "description": "Scope is deprecated.", + "x-example": true + } + }, + "required": [ + "$id", + "description", + "category", + "deprecated" + ], + "example": { + "$id": "users.read", + "description": "Access to read your project's users", + "category": "Auth", + "deprecated": true + } + }, + "consoleKeyScopeList": { + "description": "Console Key Scopes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of key scopes exposed by the server.", + "x-example": 5, + "format": "int32" + }, + "scopes": { + "type": "array", + "description": "List of key scopes, each with its ID and description.", + "items": { + "$ref": "#\/components\/schemas\/consoleKeyScope" + }, + "x-example": "" + } + }, + "required": [ + "total", + "scopes" + ], + "example": { + "total": 5, + "scopes": "" + } + }, "mfaChallenge": { "description": "MFA Challenge", "type": "object", @@ -86503,19 +93644,82 @@ "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", "x-example": "2020-10-15T06:38:00.000+00:00", "nullable": true + }, + "projectName": { + "type": "string", + "description": "Name of the project this block applies to.", + "x-example": "My Project" + }, + "region": { + "type": "string", + "description": "Region of the project this block applies to.", + "x-example": "fra" + }, + "organizationName": { + "type": "string", + "description": "Name of the organization that owns the project.", + "x-example": "Acme Inc." + }, + "organizationId": { + "type": "string", + "description": "ID of the organization that owns the project.", + "x-example": "5e5ea5c16897e" + }, + "billingPlan": { + "type": "string", + "description": "Billing plan of the organization that owns the project.", + "x-example": "pro" } }, "required": [ "$createdAt", "resourceType", - "resourceId" + "resourceId", + "projectName", + "region", + "organizationName", + "organizationId", + "billingPlan" ], "example": { "$createdAt": "2020-10-15T06:38:00.000+00:00", "resourceType": "project", "resourceId": "5e5ea5c16897e", "reason": "Payment overdue", - "expiredAt": "2020-10-15T06:38:00.000+00:00" + "expiredAt": "2020-10-15T06:38:00.000+00:00", + "projectName": "My Project", + "region": "fra", + "organizationName": "Acme Inc.", + "organizationId": "5e5ea5c16897e", + "billingPlan": "pro" + } + }, + "blockDelete": { + "description": "BlockDelete", + "type": "object", + "properties": { + "deleted": { + "type": "integer", + "description": "Number of blocks deleted", + "x-example": 1, + "format": "int32" + }, + "blocks": { + "type": "array", + "description": "List of deleted blocks", + "items": { + "$ref": "#\/components\/schemas\/block" + }, + "x-example": [] + } + }, + "required": [ + "deleted", + "blocks" + ], + "example": { + "deleted": 1, + "blocks": [] } }, "campaign": { @@ -87095,6 +94299,11 @@ "description": "Invoice status", "x-example": "succeeded" }, + "type": { + "type": "string", + "description": "Invoice type. Can be one of `subscription`, `domain_purchase`, `domain_renewal`, `domain_transfer`, or `addon_*`.", + "x-example": "subscription" + }, "lastError": { "type": "string", "description": "Last payment error associated with the invoice", @@ -87135,6 +94344,7 @@ "currency", "clientSecret", "status", + "type", "lastError", "dueAt", "from", @@ -87161,6 +94371,7 @@ "currency": "USD", "clientSecret": "pi_daslfasdfkla_asdkfl", "status": "succeeded", + "type": "subscription", "lastError": "Your card has insufficient balance.", "dueAt": "2020-10-15T06:38:00.000+00:00", "from": "2020-10-15T06:38:00.000+00:00", @@ -89082,6 +96293,329 @@ "organizationCredits": 0 } }, + "estimationPlanChange": { + "description": "EstimationPlanChange", + "type": "object", + "properties": { + "currentBillingPlanId": { + "type": "string", + "description": "Current billing plan ID", + "x-example": "tier-2" + }, + "targetBillingPlanId": { + "type": "string", + "description": "Target billing plan ID", + "x-example": "tier-0" + }, + "direction": { + "type": "string", + "description": "Direction of plan change: upgrade, downgrade, or same", + "x-example": "downgrade" + }, + "estimation": { + "type": "object", + "description": "Cost estimation details", + "x-example": null, + "items": { + "$ref": "#\/components\/schemas\/planChangeEstimationDetails" + } + }, + "limits": { + "type": "object", + "description": "Plan limits and compliance information", + "x-example": null, + "items": { + "$ref": "#\/components\/schemas\/planChangeLimits" + } + } + }, + "required": [ + "currentBillingPlanId", + "targetBillingPlanId", + "direction", + "estimation", + "limits" + ], + "example": { + "currentBillingPlanId": "tier-2", + "targetBillingPlanId": "tier-0", + "direction": "downgrade", + "estimation": null, + "limits": null + } + }, + "planChangeEstimationDetails": { + "description": "PlanChangeEstimationDetails", + "type": "object", + "properties": { + "currency": { + "type": "string", + "description": "Currency code", + "x-example": "USD" + }, + "grossAmount": { + "type": "number", + "description": "Gross amount after all discounts and credits", + "x-example": 15, + "format": "double" + }, + "credits": { + "type": "number", + "description": "Credits applied from coupon", + "x-example": 0, + "format": "double" + }, + "organizationCredits": { + "type": "number", + "description": "Organization's existing credits applied", + "x-example": 5, + "format": "double" + }, + "discount": { + "type": "number", + "description": "Discount amount from prorated invoices", + "x-example": 0, + "format": "double" + }, + "amount": { + "type": "number", + "description": "Total amount before discounts and credits", + "x-example": 20, + "format": "double" + }, + "nextInvoiceDate": { + "type": "string", + "description": "Next invoice date", + "x-example": "2025-12-01T00:00:00.000Z" + }, + "items": { + "type": "array", + "description": "Line items breakdown", + "items": { + "type": "object" + }, + "x-example": [ + { + "label": "Starter plan", + "value": 0 + }, + { + "label": "Additional seats", + "value": 10 + } + ] + }, + "discounts": { + "type": "array", + "description": "Applied discounts breakdown", + "items": { + "type": "object" + }, + "x-example": [ + { + "label": "Organization credits", + "value": 5 + } + ] + } + }, + "required": [ + "currency", + "grossAmount", + "credits", + "organizationCredits", + "discount", + "amount", + "nextInvoiceDate", + "items", + "discounts" + ], + "example": { + "currency": "USD", + "grossAmount": 15, + "credits": 0, + "organizationCredits": 5, + "discount": 0, + "amount": 20, + "nextInvoiceDate": "2025-12-01T00:00:00.000Z", + "items": [ + { + "label": "Starter plan", + "value": 0 + }, + { + "label": "Additional seats", + "value": 10 + } + ], + "discounts": [ + { + "label": "Organization credits", + "value": 5 + } + ] + } + }, + "planChangeLimits": { + "description": "PlanChangeLimits", + "type": "object", + "properties": { + "totalProjects": { + "type": "integer", + "description": "Total number of projects in the organization", + "x-example": 5, + "format": "int32" + }, + "nonCompliantProjects": { + "type": "integer", + "description": "Number of projects exceeding target plan limits", + "x-example": 2, + "format": "int32" + }, + "canChangePlan": { + "type": "boolean", + "description": "Whether the plan change is allowed", + "x-example": false + }, + "projects": { + "type": "array", + "description": "Project compliance details", + "items": { + "$ref": "#\/components\/schemas\/planChangeProjectCompliance" + }, + "x-example": [] + }, + "unsupportedAddons": { + "type": "array", + "description": "Active addon keys that the target plan does not support. When non-empty, `canChangePlan` is false.", + "items": { + "type": "string" + }, + "x-example": [ + "baa" + ] + } + }, + "required": [ + "totalProjects", + "nonCompliantProjects", + "canChangePlan", + "projects", + "unsupportedAddons" + ], + "example": { + "totalProjects": 5, + "nonCompliantProjects": 2, + "canChangePlan": false, + "projects": [], + "unsupportedAddons": [ + "baa" + ] + } + }, + "planChangeProjectCompliance": { + "description": "PlanChangeProjectCompliance", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Project ID", + "x-example": "proj_a" + }, + "name": { + "type": "string", + "description": "Project name", + "x-example": "Marketing Site" + }, + "isCompliant": { + "type": "boolean", + "description": "Whether the project complies with target plan limits", + "x-example": false + }, + "resources": { + "type": "array", + "description": "Resource compliance details", + "items": { + "$ref": "#\/components\/schemas\/planChangeResourceCompliance" + }, + "x-example": [] + }, + "error": { + "type": "string", + "description": "Failure reason when compliance could not be evaluated. Present only when the project DB or Regions API was unreachable; in that case `isCompliant` is false (fail closed) and `resources` is empty.", + "x-example": "Failed to get project compliance from Regions API. Status: 500", + "nullable": true + } + }, + "required": [ + "$id", + "name", + "isCompliant", + "resources" + ], + "example": { + "$id": "proj_a", + "name": "Marketing Site", + "isCompliant": false, + "resources": [], + "error": "Failed to get project compliance from Regions API. Status: 500" + } + }, + "planChangeResourceCompliance": { + "description": "PlanChangeResourceCompliance", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Resource type", + "x-example": "databases" + }, + "currentUsage": { + "type": "integer", + "description": "Current usage count", + "x-example": 3, + "format": "int32" + }, + "limit": { + "type": "integer", + "description": "Allowed limit in target plan", + "x-example": 1, + "format": "int32" + }, + "status": { + "type": "string", + "description": "Compliance status", + "x-example": "over_limit" + }, + "excess": { + "type": "integer", + "description": "Number of resources exceeding the limit", + "x-example": 2, + "format": "int32" + }, + "resolutionHint": { + "type": "string", + "description": "Suggestion for resolving the compliance issue", + "x-example": "Delete or migrate 2 databases." + } + }, + "required": [ + "type", + "currentUsage", + "limit", + "status", + "excess", + "resolutionHint" + ], + "example": { + "type": "databases", + "currentUsage": 3, + "limit": 1, + "status": "over_limit", + "excess": 2, + "resolutionHint": "Delete or migrate 2 databases." + } + }, "estimationDeleteOrganization": { "description": "EstimationDeleteOrganization", "type": "object", @@ -89746,6 +97280,34 @@ "paymentMethods": "" } }, + "blockList": { + "description": "Blocks list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of blocks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "blocks": { + "type": "array", + "description": "List of blocks.", + "items": { + "$ref": "#\/components\/schemas\/block" + }, + "x-example": "" + } + }, + "required": [ + "total", + "blocks" + ], + "example": { + "total": 5, + "blocks": "" + } + }, "consoleRegionList": { "description": "Regions list", "type": "object", diff --git a/specs/1.9.x/open-api3-1.9.x-server.json b/specs/1.9.x/open-api3-1.9.x-server.json index cc7b4b093..4bfac7264 100644 --- a/specs/1.9.x/open-api3-1.9.x-server.json +++ b/specs/1.9.x/open-api3-1.9.x-server.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "version": "1.9.2", + "version": "1.9.3", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -562,7 +562,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 187, + "weight": 166, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -635,7 +635,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 189, + "weight": 168, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -762,7 +762,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 190, + "weight": 169, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -905,7 +905,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 191, + "weight": 170, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1032,7 +1032,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 195, + "weight": 174, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1169,7 +1169,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 196, + "weight": 175, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1310,7 +1310,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 188, + "weight": 167, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1414,7 +1414,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 194, + "weight": 173, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1516,7 +1516,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 192, + "weight": 171, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1618,7 +1618,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 193, + "weight": 172, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -3173,7 +3173,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "schema": { "type": "string", @@ -3194,9 +3194,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -3769,7 +3772,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 1071, + "weight": 1184, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -3833,7 +3836,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 1072, + "weight": 1185, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -3890,7 +3893,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 198, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4020,7 +4023,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 197, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4156,7 +4159,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 201, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4218,7 +4221,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 199, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4710,7 +4713,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 200, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4796,7 +4799,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 203, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -4892,7 +4895,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 202, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -4988,7 +4991,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 204, + "weight": 183, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5743,7 +5746,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 997, + "weight": 1055, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -5808,7 +5811,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 998, + "weight": 1056, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -5898,7 +5901,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 996, + "weight": 1054, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -5953,7 +5956,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 999, + "weight": 1057, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -6017,7 +6020,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 992, + "weight": 1050, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -6082,7 +6085,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 993, + "weight": 1051, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -6201,7 +6204,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 991, + "weight": 1049, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -6263,7 +6266,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 994, + "weight": 1052, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -6353,7 +6356,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 995, + "weight": 1053, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -6417,7 +6420,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 1002, + "weight": 1060, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -6517,7 +6520,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 1001, + "weight": 1059, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -6584,7 +6587,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 1000, + "weight": 1058, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -6648,7 +6651,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 635, + "weight": 687, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6769,7 +6772,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 631, + "weight": 683, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -6888,7 +6891,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 703, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6957,7 +6960,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 699, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -7030,7 +7033,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 700, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -7096,7 +7099,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 701, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -7176,7 +7179,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 702, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -7244,7 +7247,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 704, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -7331,7 +7334,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 632, + "weight": 684, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7427,7 +7430,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 633, + "weight": 685, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7539,7 +7542,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 634, + "weight": 686, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7636,7 +7639,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 643, + "weight": 695, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7737,7 +7740,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 639, + "weight": 691, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -7865,7 +7868,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 640, + "weight": 692, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -7941,7 +7944,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 641, + "weight": 693, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -8050,7 +8053,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 642, + "weight": 694, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -8128,7 +8131,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 660, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -8230,7 +8233,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 661, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -8344,7 +8347,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 662, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -8463,7 +8466,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 663, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -8578,7 +8581,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 664, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -8698,7 +8701,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 665, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -8813,7 +8816,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 666, + "weight": 718, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -8933,7 +8936,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 667, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -9056,7 +9059,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 668, + "weight": 720, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -9184,7 +9187,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 669, + "weight": 721, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -9313,7 +9316,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 670, + "weight": 722, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9447,7 +9450,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 671, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9576,7 +9579,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 672, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9710,7 +9713,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 673, + "weight": 725, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9824,7 +9827,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 674, + "weight": 726, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -9943,7 +9946,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 675, + "weight": 727, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -10059,7 +10062,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 676, + "weight": 728, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -10184,7 +10187,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 693, + "weight": 745, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -10299,7 +10302,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 694, + "weight": 746, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -10414,7 +10417,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 691, + "weight": 743, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -10529,7 +10532,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 692, + "weight": 744, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -10644,7 +10647,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 677, + "weight": 729, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -10760,7 +10763,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 678, + "weight": 730, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -10885,7 +10888,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 679, + "weight": 731, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -11001,7 +11004,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 680, + "weight": 732, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -11126,7 +11129,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 681, + "weight": 733, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -11266,7 +11269,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 682, + "weight": 734, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -11382,7 +11385,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 683, + "weight": 735, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -11508,7 +11511,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 684, + "weight": 736, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -11634,7 +11637,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 689, + "weight": 741, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -11749,7 +11752,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 690, + "weight": 742, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -11864,7 +11867,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 685, + "weight": 737, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -11979,7 +11982,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 686, + "weight": 738, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -12099,7 +12102,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 687, + "weight": 739, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -12221,7 +12224,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 688, + "weight": 740, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -12425,7 +12428,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 658, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -12503,7 +12506,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 659, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -12590,7 +12593,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 654, + "weight": 897, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -12716,7 +12719,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 646, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -12911,7 +12914,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 651, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -13050,7 +13053,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 649, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -13156,7 +13159,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 653, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -13259,7 +13262,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 647, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -13372,7 +13375,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 650, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -13530,7 +13533,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 648, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -13644,7 +13647,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 652, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -13753,7 +13756,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 657, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -13884,7 +13887,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 656, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -14015,7 +14018,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 698, + "weight": 750, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -14115,7 +14118,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 695, + "weight": 747, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -14257,7 +14260,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 696, + "weight": 748, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -14335,7 +14338,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 697, + "weight": 749, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -14422,7 +14425,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 782, + "weight": 834, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -14509,7 +14512,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 778, + "weight": 830, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -14591,7 +14594,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 810, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -14660,7 +14663,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 806, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -14733,7 +14736,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 807, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -14799,7 +14802,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 808, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -14879,7 +14882,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 809, + "weight": 861, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -14947,7 +14950,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 811, + "weight": 863, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -15033,7 +15036,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 779, + "weight": 831, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -15095,7 +15098,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 780, + "weight": 832, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -15174,7 +15177,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 781, + "weight": 833, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -15238,7 +15241,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 789, + "weight": 841, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -15335,7 +15338,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 785, + "weight": 837, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -15459,7 +15462,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 786, + "weight": 838, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -15531,7 +15534,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 787, + "weight": 839, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -15638,7 +15641,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 788, + "weight": 840, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -15712,7 +15715,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 803, + "weight": 898, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -15834,7 +15837,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 795, + "weight": 847, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -16013,7 +16016,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 800, + "weight": 852, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -16143,7 +16146,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 798, + "weight": 850, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -16244,7 +16247,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 802, + "weight": 854, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -16342,7 +16345,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 796, + "weight": 848, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -16451,7 +16454,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 799, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -16599,7 +16602,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 797, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -16707,7 +16710,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 801, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -16811,7 +16814,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 805, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -16936,7 +16939,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 804, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -17061,7 +17064,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 794, + "weight": 846, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -17157,7 +17160,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 791, + "weight": 843, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -17294,7 +17297,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 792, + "weight": 844, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -17368,7 +17371,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 793, + "weight": 845, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -17451,7 +17454,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 437, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -17537,7 +17540,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 845, + "weight": 900, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -17666,6 +17669,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -17732,75 +17736,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -17890,7 +17901,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 439, + "weight": 418, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -17941,7 +17952,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 440, + "weight": 419, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -17992,7 +18003,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 435, + "weight": 414, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -18053,7 +18064,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 846, + "weight": 901, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -18189,6 +18200,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -18255,75 +18267,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -18403,7 +18422,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 438, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -18466,7 +18485,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 443, + "weight": 422, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -18548,7 +18567,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 444, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -18644,7 +18663,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 441, + "weight": 420, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -18745,7 +18764,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 449, + "weight": 428, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -18832,7 +18851,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 446, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -18950,7 +18969,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 447, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -19049,7 +19068,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 442, + "weight": 421, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -19113,7 +19132,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 445, + "weight": 424, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -19179,7 +19198,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 448, + "weight": 427, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -19271,7 +19290,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 450, + "weight": 429, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -19344,14 +19363,17 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 453, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-executions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -19433,14 +19455,17 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 451, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/create-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "client", @@ -19553,14 +19578,17 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 452, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/get-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -19621,14 +19649,17 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 454, + "weight": 433, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "server" @@ -19694,7 +19725,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 459, + "weight": 438, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -19755,7 +19786,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 847, + "weight": 902, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -19848,7 +19879,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 458, + "weight": 437, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -19919,7 +19950,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 460, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -20014,7 +20045,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 461, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -20087,7 +20118,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 122, + "weight": 117, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -20143,7 +20174,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 121, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -20199,7 +20230,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 464, + "weight": 443, "cookies": false, "type": "", "demo": "health\/get.md", @@ -20251,7 +20282,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 473, + "weight": 452, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -20303,7 +20334,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 467, + "weight": 446, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -20355,7 +20386,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 470, + "weight": 449, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -20418,7 +20449,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 985, + "weight": 1043, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -20494,7 +20525,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 466, + "weight": 445, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -20546,7 +20577,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 468, + "weight": 447, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -20598,7 +20629,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 474, + "weight": 453, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -20663,7 +20694,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 981, + "weight": 1039, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -20728,7 +20759,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 980, + "weight": 1038, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -20793,7 +20824,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 478, + "weight": 457, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -20858,7 +20889,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 982, + "weight": 1040, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -20923,7 +20954,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 477, + "weight": 456, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -20988,7 +21019,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 479, + "weight": 458, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -21064,7 +21095,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 480, + "weight": 459, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -21129,7 +21160,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 487, + "weight": 466, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -21221,7 +21252,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 484, + "weight": 463, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -21286,7 +21317,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 476, + "weight": 455, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -21351,7 +21382,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 481, + "weight": 460, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -21416,7 +21447,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 482, + "weight": 461, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -21481,7 +21512,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 483, + "weight": 462, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -21546,7 +21577,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 983, + "weight": 1041, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -21611,7 +21642,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 485, + "weight": 464, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -21676,7 +21707,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 486, + "weight": 465, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -21741,7 +21772,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 984, + "weight": 1042, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -21806,7 +21837,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 475, + "weight": 454, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -21871,7 +21902,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 472, + "weight": 451, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -21923,7 +21954,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 471, + "weight": 450, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -21975,7 +22006,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 469, + "weight": 448, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -22475,7 +22506,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 179, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -22564,7 +22595,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 176, + "weight": 155, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -22712,7 +22743,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 183, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -22872,7 +22903,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 178, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -23052,7 +23083,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 185, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -23252,7 +23283,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 177, + "weight": 156, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -23437,7 +23468,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 184, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -23628,7 +23659,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 182, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -23683,7 +23714,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 186, + "weight": 165, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -23747,7 +23778,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 180, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -23835,7 +23866,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 181, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -23923,7 +23954,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 150, + "weight": 129, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -24012,7 +24043,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 149, + "weight": 128, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -24194,7 +24225,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 163, + "weight": 142, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -24378,7 +24409,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 148, + "weight": 127, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -24533,7 +24564,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 162, + "weight": 141, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -24689,7 +24720,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 139, + "weight": 118, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -24810,7 +24841,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 153, + "weight": 132, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -24933,7 +24964,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 143, + "weight": 122, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -25031,7 +25062,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 157, + "weight": 136, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -25132,7 +25163,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 141, + "weight": 120, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -25242,7 +25273,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 155, + "weight": 134, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -25354,7 +25385,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 140, + "weight": 119, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -25464,7 +25495,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 154, + "weight": 133, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -25576,7 +25607,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 142, + "weight": 121, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -25813,7 +25844,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 156, + "weight": 135, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -26049,7 +26080,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 144, + "weight": 123, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -26148,7 +26179,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 158, + "weight": 137, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -26249,7 +26280,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 145, + "weight": 124, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -26348,7 +26379,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 159, + "weight": 138, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -26449,7 +26480,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 146, + "weight": 125, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -26548,7 +26579,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 160, + "weight": 139, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -26649,7 +26680,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 147, + "weight": 126, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -26748,7 +26779,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 161, + "weight": 140, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -26849,7 +26880,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 152, + "weight": 131, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -26904,7 +26935,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 164, + "weight": 143, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -26968,7 +26999,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 151, + "weight": 130, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -27056,7 +27087,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 173, + "weight": 152, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -27144,7 +27175,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 166, + "weight": 145, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -27231,7 +27262,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 165, + "weight": 144, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -27316,7 +27347,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 168, + "weight": 147, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -27378,7 +27409,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 169, + "weight": 148, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -27459,7 +27490,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 170, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -27523,7 +27554,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 167, + "weight": 146, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -27611,7 +27642,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 172, + "weight": 151, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -27708,7 +27739,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 171, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -27801,7 +27832,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 174, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -27866,7 +27897,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 175, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -27920,6 +27951,143 @@ ] } }, + "\/project": { + "delete": { + "summary": "Delete project", + "operationId": "projectDelete", + "tags": [ + "project" + ], + "description": "Delete a project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 1087, + "cookies": false, + "type": "", + "demo": "project\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, + "\/project\/auth-methods\/{methodId}": { + "patch": { + "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", + "operationId": "projectUpdateAuthMethod", + "tags": [ + "project" + ], + "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAuthMethod", + "group": null, + "weight": 1136, + "cookies": false, + "type": "", + "demo": "project\/update-auth-method.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "methodId", + "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "required": true, + "schema": { + "type": "string", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Auth method status.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, "\/project\/auth\/canonical-emails": { "patch": { "summary": "Update project auth canonical emails", @@ -27944,7 +28112,7 @@ "x-appwrite": { "method": "updateCanonicalEmails", "group": "auth", - "weight": 1068, + "weight": 1181, "cookies": false, "type": "", "demo": "project\/update-canonical-emails.md", @@ -28014,7 +28182,7 @@ "x-appwrite": { "method": "updateDisposableEmails", "group": "auth", - "weight": 1069, + "weight": 1182, "cookies": false, "type": "", "demo": "project\/update-disposable-emails.md", @@ -28084,7 +28252,7 @@ "x-appwrite": { "method": "updateFreeEmails", "group": "auth", - "weight": 1070, + "weight": 1183, "cookies": false, "type": "", "demo": "project\/update-free-emails.md", @@ -28154,7 +28322,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1042, + "weight": 1103, "cookies": false, "type": "", "demo": "project\/list-keys.md", @@ -28212,7 +28380,7 @@ "tags": [ "project" ], - "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", + "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create an ephemeral API key if you need a short-lived key instead.", "responses": { "201": { "description": "Key", @@ -28229,7 +28397,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1041, + "weight": 1101, "cookies": false, "type": "", "demo": "project\/create-key.md", @@ -28277,75 +28445,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -28377,6 +28552,173 @@ } } }, + "\/project\/keys\/ephemeral": { + "post": { + "summary": "Create ephemeral project key", + "operationId": "projectCreateEphemeralKey", + "tags": [ + "project" + ], + "description": "Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create a standard API key if you need a longer-lived key instead.", + "responses": { + "201": { + "description": "Ephemeral Key", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/ephemeralKey" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createEphemeralKey", + "group": "keys", + "weight": 1102, + "cookies": false, + "type": "", + "demo": "project\/create-ephemeral-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "rules.read", + "rules.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "duration": { + "type": "integer", + "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", + "x-example": 1, + "format": "int32" + } + }, + "required": [ + "scopes", + "duration" + ] + } + } + } + } + } + }, "\/project\/keys\/{keyId}": { "get": { "summary": "Get project key", @@ -28401,7 +28743,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1043, + "weight": 1104, "cookies": false, "type": "", "demo": "project\/get-key.md", @@ -28462,7 +28804,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1045, + "weight": 1106, "cookies": false, "type": "", "demo": "project\/update-key.md", @@ -28517,75 +28859,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -28631,7 +28980,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1044, + "weight": 1105, "cookies": false, "type": "", "demo": "project\/delete-key.md", @@ -28694,7 +29043,7 @@ "x-appwrite": { "method": "updateLabels", "group": null, - "weight": 1029, + "weight": 1088, "cookies": false, "type": "", "demo": "project\/update-labels.md", @@ -28743,21 +29092,21 @@ } } }, - "\/project\/platforms": { + "\/project\/mock-phones": { "get": { - "summary": "List project platforms", - "operationId": "projectListPlatforms", + "summary": "List project mock phones", + "operationId": "projectListMockPhones", "tags": [ "project" ], - "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", + "description": "Get a list of all mock phones in the project. This endpoint returns an array of all mock phones and their OTPs.", "responses": { "200": { - "description": "Platforms List", + "description": "Mock Numbers List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformList" + "$ref": "#\/components\/schemas\/mockNumberList" } } } @@ -28765,16 +29114,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listPlatforms", - "group": "platforms", - "weight": 1058, + "method": "listMockPhones", + "group": "mocks", + "weight": 1121, "cookies": false, "type": "", - "demo": "project\/list-platforms.md", + "demo": "project\/list-mock-phones.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "mocks.read", "platforms": [ "console", "server" @@ -28795,7 +29144,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "schema": { "type": "array", @@ -28818,23 +29167,21 @@ "in": "query" } ] - } - }, - "\/project\/platforms\/android": { + }, "post": { - "summary": "Create project Android platform", - "operationId": "projectCreateAndroidPlatform", + "summary": "Create project mock phone", + "operationId": "projectCreateMockPhone", "tags": [ "project" ], - "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", + "description": "Create a new mock phone for your project. Use this endpoint to register a mock phone number and its sign-in OTP for your testers.", "responses": { "201": { - "description": "Platform Android", + "description": "Mock Number", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformAndroid" + "$ref": "#\/components\/schemas\/mockNumber" } } } @@ -28842,16 +29189,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createAndroidPlatform", - "group": "platforms", - "weight": 1054, + "method": "createMockPhone", + "group": "mocks", + "weight": 1120, "cookies": false, "type": "", - "demo": "project\/create-android-platform.md", + "demo": "project\/create-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -28875,26 +29222,21 @@ "schema": { "type": "object", "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { + "number": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.", + "x-example": "+12065550100", + "format": "phone" }, - "applicationId": { + "otp": { "type": "string", - "description": "Android application ID. Max length: 256 chars.", - "x-example": "" + "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", + "x-example": "" } }, "required": [ - "platformId", - "name", - "applicationId" + "number", + "otp" ] } } @@ -28902,21 +29244,21 @@ } } }, - "\/project\/platforms\/android\/{platformId}": { - "put": { - "summary": "Update project Android platform", - "operationId": "projectUpdateAndroidPlatform", + "\/project\/mock-phones\/{number}": { + "get": { + "summary": "Get project mock phone", + "operationId": "projectGetMockPhone", "tags": [ "project" ], - "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", + "description": "Get a mock phone by its unique number. This endpoint returns the mock phone's OTP.", "responses": { "200": { - "description": "Platform Android", + "description": "Mock Number", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformAndroid" + "$ref": "#\/components\/schemas\/mockNumber" } } } @@ -28924,16 +29266,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateAndroidPlatform", - "group": "platforms", - "weight": 1049, + "method": "getMockPhone", + "group": "mocks", + "weight": 1122, "cookies": false, "type": "", - "demo": "project\/update-android-platform.md", + "demo": "project\/get-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.read", "platforms": [ "console", "server" @@ -28953,58 +29295,32 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", "required": true, "schema": { "type": "string", - "x-example": "" + "format": "phone", + "x-example": "+12065550100" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" - }, - "applicationId": { - "type": "string", - "description": "Android application ID. Max length: 256 chars.", - "x-example": "" - } - }, - "required": [ - "name", - "applicationId" - ] - } - } - } - } - } - }, - "\/project\/platforms\/apple": { - "post": { - "summary": "Create project Apple platform", - "operationId": "projectCreateApplePlatform", + ] + }, + "put": { + "summary": "Update project mock phone", + "operationId": "projectUpdateMockPhone", "tags": [ "project" ], - "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update a mock phone by its unique number. Use this endpoint to update the mock phone's OTP.", "responses": { - "201": { - "description": "Platform Apple", + "200": { + "description": "Mock Number", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformApple" + "$ref": "#\/components\/schemas\/mockNumber" } } } @@ -29012,16 +29328,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createApplePlatform", - "group": "platforms", - "weight": 1053, + "method": "updateMockPhone", + "group": "mocks", + "weight": 1123, "cookies": false, "type": "", - "demo": "project\/create-apple-platform.md", + "demo": "project\/update-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -29039,71 +29355,63 @@ "Key": [] } ], + "parameters": [ + { + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", + "required": true, + "schema": { + "type": "string", + "format": "phone", + "x-example": "+12065550100" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" - }, - "bundleIdentifier": { + "otp": { "type": "string", - "description": "Apple bundle identifier. Max length: 256 chars.", - "x-example": "" + "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", + "x-example": "" } }, "required": [ - "platformId", - "name", - "bundleIdentifier" + "otp" ] } } } } - } - }, - "\/project\/platforms\/apple\/{platformId}": { - "put": { - "summary": "Update project Apple platform", - "operationId": "projectUpdateApplePlatform", + }, + "delete": { + "summary": "Delete project mock phone", + "operationId": "projectDeleteMockPhone", "tags": [ "project" ], - "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", + "description": "Delete a mock phone by its unique number. This endpoint removes the mock phone and its OTP configuration from the project.", "responses": { - "200": { - "description": "Platform Apple", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/platformApple" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateApplePlatform", - "group": "platforms", - "weight": 1048, + "method": "deleteMockPhone", + "group": "mocks", + "weight": 1124, "cookies": false, "type": "", - "demo": "project\/update-apple-platform.md", + "demo": "project\/delete-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -29123,58 +29431,34 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", "required": true, "schema": { "type": "string", - "x-example": "" + "format": "phone", + "x-example": "+12065550100" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" - }, - "bundleIdentifier": { - "type": "string", - "description": "Apple bundle identifier. Max length: 256 chars.", - "x-example": "" - } - }, - "required": [ - "name", - "bundleIdentifier" - ] - } - } - } - } + ] } }, - "\/project\/platforms\/linux": { - "post": { - "summary": "Create project Linux platform", - "operationId": "projectCreateLinuxPlatform", + "\/project\/oauth2": { + "get": { + "summary": "List project OAuth2 providers", + "operationId": "projectListOAuth2Providers", "tags": [ "project" ], - "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", + "description": "Get a list of all OAuth2 providers supported by the server, along with the project's configuration for each. Credential fields are write-only and always returned empty.", "responses": { - "201": { - "description": "Platform Linux", + "200": { + "description": "OAuth2 Providers List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformLinux" + "$ref": "#\/components\/schemas\/oAuth2ProviderList" } } } @@ -29182,16 +29466,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLinuxPlatform", - "group": "platforms", - "weight": 1056, + "method": "listOAuth2Providers", + "group": "oauth2", + "weight": 1137, "cookies": false, "type": "", - "demo": "project\/create-linux-platform.md", + "demo": "project\/list-o-auth-2-providers.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.read", "platforms": [ "console", "server" @@ -29208,55 +29492,24 @@ "Project": [], "Key": [] } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" - }, - "packageName": { - "type": "string", - "description": "Linux package name. Max length: 256 chars.", - "x-example": "" - } - }, - "required": [ - "platformId", - "name", - "packageName" - ] - } - } - } - } + ] } }, - "\/project\/platforms\/linux\/{platformId}": { - "put": { - "summary": "Update project Linux platform", - "operationId": "projectUpdateLinuxPlatform", + "\/project\/oauth2\/amazon": { + "patch": { + "summary": "Update project OAuth2 Amazon", + "operationId": "projectUpdateOAuth2Amazon", "tags": [ "project" ], - "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", + "description": "Update the project OAuth2 Amazon configuration.", "responses": { "200": { - "description": "Platform Linux", + "description": "OAuth2Amazon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformLinux" + "$ref": "#\/components\/schemas\/oAuth2Amazon" } } } @@ -29264,16 +29517,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLinuxPlatform", - "group": "platforms", - "weight": 1051, + "method": "updateOAuth2Amazon", + "group": "oauth2", + "weight": 1164, "cookies": false, "type": "", - "demo": "project\/update-linux-platform.md", + "demo": "project\/update-o-auth-2-amazon.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29291,60 +29544,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2", + "x-example": "", + "x-nullable": true }, - "packageName": { + "clientSecret": { "type": "string", - "description": "Linux package name. Max length: 256 chars.", - "x-example": "" + "description": "'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "packageName" - ] + } } } } } } }, - "\/project\/platforms\/web": { - "post": { - "summary": "Create project web platform", - "operationId": "projectCreateWebPlatform", + "\/project\/oauth2\/apple": { + "patch": { + "summary": "Update project OAuth2 Apple", + "operationId": "projectUpdateOAuth2Apple", "tags": [ "project" ], - "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Apple configuration.", "responses": { - "201": { - "description": "Platform Web", + "200": { + "description": "OAuth2Apple", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformWeb" + "$ref": "#\/components\/schemas\/oAuth2Apple" } } } @@ -29352,16 +29597,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createWebPlatform", - "group": "platforms", - "weight": 1052, + "method": "updateOAuth2Apple", + "group": "oauth2", + "weight": 1179, "cookies": false, "type": "", - "demo": "project\/create-web-platform.md", + "demo": "project\/update-o-auth-2-apple.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29385,48 +29630,58 @@ "schema": { "type": "object", "properties": { - "platformId": { + "serviceId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web", + "x-example": "", + "x-nullable": true }, - "name": { + "keyId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Key ID' of Apple OAuth2 app. For example: P4000000N8", + "x-example": "", + "x-nullable": true }, - "hostname": { + "teamId": { "type": "string", - "description": "Platform web hostname. Max length: 256 chars.", - "x-example": "app.example.com" + "description": "'Team ID' of Apple OAuth2 app. For example: D4000000R6", + "x-example": "", + "x-nullable": true + }, + "p8File": { + "type": "string", + "description": "Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "hostname" - ] + } } } } } } }, - "\/project\/platforms\/web\/{platformId}": { - "put": { - "summary": "Update project web platform", - "operationId": "projectUpdateWebPlatform", + "\/project\/oauth2\/auth0": { + "patch": { + "summary": "Update project OAuth2 Auth0", + "operationId": "projectUpdateOAuth2Auth0", "tags": [ "project" ], - "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", + "description": "Update the project OAuth2 Auth0 configuration.", "responses": { "200": { - "description": "Platform Web", + "description": "OAuth2Auth0", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformWeb" + "$ref": "#\/components\/schemas\/oAuth2Auth0" } } } @@ -29434,16 +29689,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateWebPlatform", - "group": "platforms", - "weight": 1047, + "method": "updateOAuth2Auth0", + "group": "oauth2", + "weight": 1173, "cookies": false, "type": "", - "demo": "project\/update-web-platform.md", + "demo": "project\/update-o-auth-2-auth-0.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29461,60 +29716,58 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq", + "x-example": "", + "x-nullable": true }, - "hostname": { + "clientSecret": { "type": "string", - "description": "Platform web hostname. Max length: 256 chars.", - "x-example": "app.example.com" + "description": "'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of Auth0 instance. For example: example.us.auth0.com", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "hostname" - ] + } } } } } } }, - "\/project\/platforms\/windows": { - "post": { - "summary": "Create project Windows platform", - "operationId": "projectCreateWindowsPlatform", + "\/project\/oauth2\/authentik": { + "patch": { + "summary": "Update project OAuth2 Authentik", + "operationId": "projectUpdateOAuth2Authentik", "tags": [ "project" ], - "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Authentik configuration.", "responses": { - "201": { - "description": "Platform Windows", + "200": { + "description": "OAuth2Authentik", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformWindows" + "$ref": "#\/components\/schemas\/oAuth2Authentik" } } } @@ -29522,16 +29775,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createWindowsPlatform", - "group": "platforms", - "weight": 1055, + "method": "updateOAuth2Authentik", + "group": "oauth2", + "weight": 1172, "cookies": false, "type": "", - "demo": "project\/create-windows-platform.md", + "demo": "project\/update-o-auth-2-authentik.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29555,48 +29808,52 @@ "schema": { "type": "object", "properties": { - "platformId": { + "clientId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv", + "x-example": "", + "x-nullable": true }, - "name": { + "clientSecret": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", + "x-example": "", + "x-nullable": true }, - "packageIdentifierName": { + "endpoint": { "type": "string", - "description": "Windows package identifier name. Max length: 256 chars.", - "x-example": "" + "description": "Domain of Authentik instance. For example: example.authentik.com", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "packageIdentifierName" - ] + } } } } } } }, - "\/project\/platforms\/windows\/{platformId}": { - "put": { - "summary": "Update project Windows platform", - "operationId": "projectUpdateWindowsPlatform", + "\/project\/oauth2\/autodesk": { + "patch": { + "summary": "Update project OAuth2 Autodesk", + "operationId": "projectUpdateOAuth2Autodesk", "tags": [ "project" ], - "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", + "description": "Update the project OAuth2 Autodesk configuration.", "responses": { "200": { - "description": "Platform Windows", + "description": "OAuth2Autodesk", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/platformWindows" + "$ref": "#\/components\/schemas\/oAuth2Autodesk" } } } @@ -29604,16 +29861,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateWindowsPlatform", - "group": "platforms", - "weight": 1050, + "method": "updateOAuth2Autodesk", + "group": "oauth2", + "weight": 1147, "cookies": false, "type": "", - "demo": "project\/update-windows-platform.md", + "demo": "project\/update-o-auth-2-autodesk.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29631,86 +29888,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7", + "x-example": "", + "x-nullable": true }, - "packageIdentifierName": { + "clientSecret": { "type": "string", - "description": "Windows package identifier name. Max length: 256 chars.", - "x-example": "" + "description": "'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "packageIdentifierName" - ] + } } } } } } }, - "\/project\/platforms\/{platformId}": { - "get": { - "summary": "Get project platform", - "operationId": "projectGetPlatform", + "\/project\/oauth2\/bitbucket": { + "patch": { + "summary": "Update project OAuth2 Bitbucket", + "operationId": "projectUpdateOAuth2Bitbucket", "tags": [ "project" ], - "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", + "description": "Update the project OAuth2 Bitbucket configuration.", "responses": { "200": { - "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", + "description": "OAuth2Bitbucket", "content": { "application\/json": { "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/platformWeb" - }, - { - "$ref": "#\/components\/schemas\/platformApple" - }, - { - "$ref": "#\/components\/schemas\/platformAndroid" - }, - { - "$ref": "#\/components\/schemas\/platformWindows" - }, - { - "$ref": "#\/components\/schemas\/platformLinux" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/components\/schemas\/platformWeb", - "apple": "#\/components\/schemas\/platformApple", - "android": "#\/components\/schemas\/platformAndroid", - "windows": "#\/components\/schemas\/platformWindows", - "linux": "#\/components\/schemas\/platformLinux" - } - } + "$ref": "#\/components\/schemas\/oAuth2Bitbucket" } } } @@ -29718,16 +29941,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPlatform", - "group": "platforms", - "weight": 1057, + "method": "updateOAuth2Bitbucket", + "group": "oauth2", + "weight": 1144, "cookies": false, "type": "", - "demo": "project\/get-platform.md", + "demo": "project\/update-o-auth-2-bitbucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29745,43 +29968,69 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete project platform", - "operationId": "projectDeletePlatform", - "tags": [ - "project" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc", + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "string", + "description": "'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/project\/oauth2\/bitly": { + "patch": { + "summary": "Update project OAuth2 Bitly", + "operationId": "projectUpdateOAuth2Bitly", + "tags": [ + "project" ], - "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", + "description": "Update the project OAuth2 Bitly configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Bitly", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Bitly" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deletePlatform", - "group": "platforms", - "weight": 1046, + "method": "updateOAuth2Bitly", + "group": "oauth2", + "weight": 1145, "cookies": false, "type": "", - "demo": "project\/delete-platform.md", + "demo": "project\/update-o-auth-2-bitly.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29799,35 +30048,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/project\/policies\/membership-privacy": { + "\/project\/oauth2\/box": { "patch": { - "summary": "Update membership privacy policy", - "operationId": "projectUpdateMembershipPrivacyPolicy", + "summary": "Update project OAuth2 Box", + "operationId": "projectUpdateOAuth2Box", "tags": [ "project" ], - "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", + "description": "Update the project OAuth2 Box configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Box", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Box" } } } @@ -29835,16 +30101,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipPrivacyPolicy", - "group": "policies", - "weight": 1059, + "method": "updateOAuth2Box", + "group": "oauth2", + "weight": 1146, "cookies": false, "type": "", - "demo": "project\/update-membership-privacy-policy.md", + "demo": "project\/update-o-auth-2-box.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29868,30 +30134,23 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "boolean", - "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "x-example": false - }, - "userPhone": { - "type": "boolean", - "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", - "x-example": false + "clientId": { + "type": "string", + "description": "'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y", + "x-example": "", + "x-nullable": true }, - "userName": { - "type": "boolean", - "description": "Set to true if you want make user name visible to all team members, or false to hide it.", - "x-example": false + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif", + "x-example": "", + "x-nullable": true }, - "userMFA": { + "enabled": { "type": "boolean", - "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } } } @@ -29900,21 +30159,21 @@ } } }, - "\/project\/policies\/password-dictionary": { + "\/project\/oauth2\/dailymotion": { "patch": { - "summary": "Update password dictionary policy", - "operationId": "projectUpdatePasswordDictionaryPolicy", + "summary": "Update project OAuth2 Dailymotion", + "operationId": "projectUpdateOAuth2Dailymotion", "tags": [ "project" ], - "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "description": "Update the project OAuth2 Dailymotion configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Dailymotion", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Dailymotion" } } } @@ -29922,16 +30181,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordDictionaryPolicy", - "group": "policies", - "weight": 1060, + "method": "updateOAuth2Dailymotion", + "group": "oauth2", + "weight": 1143, "cookies": false, "type": "", - "demo": "project\/update-password-dictionary-policy.md", + "demo": "project\/update-o-auth-2-dailymotion.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29955,36 +30214,46 @@ "schema": { "type": "object", "properties": { + "apiKey": { + "type": "string", + "description": "'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f", + "x-example": "", + "x-nullable": true + }, + "apiSecret": { + "type": "string", + "description": "'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/password-history": { + "\/project\/oauth2\/discord": { "patch": { - "summary": "Update password history policy", - "operationId": "projectUpdatePasswordHistoryPolicy", + "summary": "Update project OAuth2 Discord", + "operationId": "projectUpdateOAuth2Discord", "tags": [ "project" ], - "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", + "description": "Update the project OAuth2 Discord configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Discord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Discord" } } } @@ -29992,16 +30261,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordHistoryPolicy", - "group": "policies", - "weight": 1061, + "method": "updateOAuth2Discord", + "group": "oauth2", + "weight": 1140, "cookies": false, "type": "", - "demo": "project\/update-password-history-policy.md", + "demo": "project\/update-o-auth-2-discord.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30025,38 +30294,46 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", + "clientId": { + "type": "string", + "description": "'Client ID' of Discord OAuth2 app. For example: 950722000000343754", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } } } } }, - "\/project\/policies\/password-personal-data": { + "\/project\/oauth2\/disqus": { "patch": { - "summary": "Update password personal data policy", - "operationId": "projectUpdatePasswordPersonalDataPolicy", + "summary": "Update project OAuth2 Disqus", + "operationId": "projectUpdateOAuth2Disqus", "tags": [ "project" ], - "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", + "description": "Update the project OAuth2 Disqus configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Disqus", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Disqus" } } } @@ -30064,16 +30341,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordPersonalDataPolicy", - "group": "policies", - "weight": 1062, + "method": "updateOAuth2Disqus", + "group": "oauth2", + "weight": 1163, "cookies": false, "type": "", - "demo": "project\/update-password-personal-data-policy.md", + "demo": "project\/update-o-auth-2-disqus.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30097,36 +30374,46 @@ "schema": { "type": "object", "properties": { + "publicKey": { + "type": "string", + "description": "'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/session-alert": { + "\/project\/oauth2\/dropbox": { "patch": { - "summary": "Update session alert policy", - "operationId": "projectUpdateSessionAlertPolicy", + "summary": "Update project OAuth2 Dropbox", + "operationId": "projectUpdateOAuth2Dropbox", "tags": [ "project" ], - "description": "Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.", + "description": "Update the project OAuth2 Dropbox configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Dropbox", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Dropbox" } } } @@ -30134,16 +30421,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSessionAlertPolicy", - "group": "policies", - "weight": 1063, + "method": "updateOAuth2Dropbox", + "group": "oauth2", + "weight": 1142, "cookies": false, "type": "", - "demo": "project\/update-session-alert-policy.md", + "demo": "project\/update-o-auth-2-dropbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30167,36 +30454,46 @@ "schema": { "type": "object", "properties": { + "appKey": { + "type": "string", + "description": "'App Key' of Dropbox OAuth2 app. For example: jl000000000009t", + "x-example": "", + "x-nullable": true + }, + "appSecret": { + "type": "string", + "description": "'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/session-duration": { + "\/project\/oauth2\/etsy": { "patch": { - "summary": "Update session duration policy", - "operationId": "projectUpdateSessionDurationPolicy", + "summary": "Update project OAuth2 Etsy", + "operationId": "projectUpdateOAuth2Etsy", "tags": [ "project" ], - "description": "Update maximum duration how long sessions created within a project should stay active for.", + "description": "Update the project OAuth2 Etsy configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Etsy", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Etsy" } } } @@ -30204,16 +30501,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSessionDurationPolicy", - "group": "policies", - "weight": 1064, + "method": "updateOAuth2Etsy", + "group": "oauth2", + "weight": 1165, "cookies": false, "type": "", - "demo": "project\/update-session-duration-policy.md", + "demo": "project\/update-o-auth-2-etsy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30237,37 +30534,46 @@ "schema": { "type": "object", "properties": { - "duration": { - "type": "integer", - "description": "Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.", - "x-example": 5, - "format": "int32" + "keyString": { + "type": "string", + "description": "'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2", + "x-example": "", + "x-nullable": true + }, + "sharedSecret": { + "type": "string", + "description": "'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "duration" - ] + } } } } } } }, - "\/project\/policies\/session-invalidation": { + "\/project\/oauth2\/facebook": { "patch": { - "summary": "Update session invalidation policy", - "operationId": "projectUpdateSessionInvalidationPolicy", + "summary": "Update project OAuth2 Facebook", + "operationId": "projectUpdateOAuth2Facebook", "tags": [ "project" ], - "description": "Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.", + "description": "Update the project OAuth2 Facebook configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Facebook", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Facebook" } } } @@ -30275,16 +30581,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSessionInvalidationPolicy", - "group": "policies", - "weight": 1065, + "method": "updateOAuth2Facebook", + "group": "oauth2", + "weight": 1166, "cookies": false, "type": "", - "demo": "project\/update-session-invalidation-policy.md", + "demo": "project\/update-o-auth-2-facebook.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30308,36 +30614,46 @@ "schema": { "type": "object", "properties": { + "appId": { + "type": "string", + "description": "'App ID' of Facebook OAuth2 app. For example: 260600000007694", + "x-example": "", + "x-nullable": true + }, + "appSecret": { + "type": "string", + "description": "'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/session-limit": { + "\/project\/oauth2\/figma": { "patch": { - "summary": "Update session limit policy", - "operationId": "projectUpdateSessionLimitPolicy", + "summary": "Update project OAuth2 Figma", + "operationId": "projectUpdateOAuth2Figma", "tags": [ "project" ], - "description": "Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.", + "description": "Update the project OAuth2 Figma configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Figma", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Figma" } } } @@ -30345,16 +30661,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSessionLimitPolicy", - "group": "policies", - "weight": 1066, + "method": "updateOAuth2Figma", + "group": "oauth2", + "weight": 1141, "cookies": false, "type": "", - "demo": "project\/update-session-limit-policy.md", + "demo": "project\/update-o-auth-2-figma.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30378,38 +30694,46 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", + "clientId": { + "type": "string", + "description": "'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } } } } }, - "\/project\/policies\/user-limit": { + "\/project\/oauth2\/fusionauth": { "patch": { - "summary": "Update user limit policy", - "operationId": "projectUpdateUserLimitPolicy", + "summary": "Update project OAuth2 FusionAuth", + "operationId": "projectUpdateOAuth2FusionAuth", "tags": [ "project" ], - "description": "Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.", + "description": "Update the project OAuth2 FusionAuth configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2FusionAuth", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2FusionAuth" } } } @@ -30417,16 +30741,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateUserLimitPolicy", - "group": "policies", - "weight": 1067, + "method": "updateOAuth2FusionAuth", + "group": "oauth2", + "weight": 1174, "cookies": false, "type": "", - "demo": "project\/update-user-limit-policy.md", + "demo": "project\/update-o-auth-2-fusion-auth.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30450,38 +30774,52 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.", - "x-example": 1, - "format": "int32", + "clientId": { + "type": "string", + "description": "'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc", + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of FusionAuth instance. For example: example.fusionauth.io", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } } } } }, - "\/project\/protocols\/{protocolId}": { + "\/project\/oauth2\/github": { "patch": { - "summary": "Update project protocol", - "operationId": "projectUpdateProtocol", + "summary": "Update project OAuth2 GitHub", + "operationId": "projectUpdateOAuth2GitHub", "tags": [ "project" ], - "description": "Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project. ", + "description": "Update the project OAuth2 GitHub configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2GitHub", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Github" } } } @@ -30489,16 +30827,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateProtocol", - "group": null, - "weight": 1030, + "method": "updateOAuth2GitHub", + "group": "oauth2", + "weight": 1139, "cookies": false, "type": "", - "demo": "project\/update-protocol.md", + "demo": "project\/update-o-auth-2-git-hub.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30516,61 +30854,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "protocolId", - "description": "Protocol name. Can be one of: rest, graphql, websocket", - "required": true, - "schema": { - "type": "string", - "x-example": "rest", - "enum": [ - "rest", - "graphql", - "websocket" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { + "clientId": { + "type": "string", + "description": "'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc", + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Protocol status.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/services\/{serviceId}": { + "\/project\/oauth2\/gitlab": { "patch": { - "summary": "Update project service", - "operationId": "projectUpdateService", + "summary": "Update project OAuth2 Gitlab", + "operationId": "projectUpdateOAuth2Gitlab", "tags": [ "project" ], - "description": "Update properties of a specific service. Use this endpoint to enable or disable a service in your project. ", + "description": "Update the project OAuth2 Gitlab configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Gitlab", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Gitlab" } } } @@ -30578,16 +30907,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateService", - "group": null, - "weight": 1031, + "method": "updateOAuth2Gitlab", + "group": "oauth2", + "weight": 1171, "cookies": false, "type": "", - "demo": "project\/update-service.md", + "demo": "project\/update-o-auth-2-gitlab.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30605,75 +30934,59 @@ "Key": [] } ], - "parameters": [ - { - "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", - "required": true, - "schema": { - "type": "string", - "x-example": "account", - "enum": [ - "account", - "avatars", - "databases", - "tablesdb", - "locale", - "health", - "project", - "storage", - "teams", - "users", - "vcs", - "sites", - "functions", - "proxy", - "graphql", - "migrations", - "messaging" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { + "applicationId": { + "type": "string", + "description": "'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "string", + "description": "'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Endpoint URL of self-hosted GitLab instance. For example: https:\/\/gitlab.com", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Service status.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/smtp": { + "\/project\/oauth2\/google": { "patch": { - "summary": "Update project SMTP configuration", - "operationId": "projectUpdateSMTP", + "summary": "Update project OAuth2 Google", + "operationId": "projectUpdateOAuth2Google", "tags": [ "project" ], - "description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.", + "description": "Update the project OAuth2 Google configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Google", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/project" + "$ref": "#\/components\/schemas\/oAuth2Google" } } } @@ -30681,16 +30994,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSMTP", - "group": "smtp", - "weight": 1032, + "method": "updateOAuth2Google", + "group": "oauth2", + "weight": 1148, "cookies": false, "type": "", - "demo": "project\/update-smtp.md", + "demo": "project\/update-o-auth-2-google.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30714,73 +31027,22 @@ "schema": { "type": "object", "properties": { - "host": { - "type": "string", - "description": "SMTP server hostname (domain)", - "x-example": null, - "x-nullable": true - }, - "port": { - "type": "integer", - "description": "SMTP server port", - "x-example": null, - "format": "int32", - "x-nullable": true - }, - "username": { - "type": "string", - "description": "SMTP server username. Leave empty for no authorization.", - "x-example": "", - "x-nullable": true - }, - "password": { - "type": "string", - "description": "SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).", - "x-example": "", - "x-nullable": true - }, - "senderEmail": { - "type": "string", - "description": "Email address shown in inbox as the sender of the email.", - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "senderName": { + "clientId": { "type": "string", - "description": "Name shown in inbox as the sender of the email.", - "x-example": "", + "description": "'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", + "x-example": "", "x-nullable": true }, - "replyToEmail": { + "clientSecret": { "type": "string", - "description": "Email used when user replies to the email.", - "x-example": "email@example.com", - "format": "email", + "description": "'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj", + "x-example": "", "x-nullable": true }, - "replyToName": { - "type": "string", - "description": "Name used when user replies to the email.", - "x-example": "", - "x-nullable": true - }, - "secure": { - "type": "string", - "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", - "x-example": "tls", - "enum": [ - "tls", - "ssl" - ], - "x-enum-name": null, - "x-enum-keys": [], - "x-nullable": true - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", - "x-example": false, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } } @@ -30790,31 +31052,38 @@ } } }, - "\/project\/smtp\/tests": { - "post": { - "summary": "Create project SMTP test", - "operationId": "projectCreateSMTPTest", + "\/project\/oauth2\/keycloak": { + "patch": { + "summary": "Update project OAuth2 Keycloak", + "operationId": "projectUpdateOAuth2Keycloak", "tags": [ "project" ], - "description": "Send a test email to verify SMTP configuration. ", + "description": "Update the project OAuth2 Keycloak configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Keycloak", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Keycloak" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "createSMTPTest", - "group": "smtp", - "weight": 1033, + "method": "updateOAuth2Keycloak", + "group": "oauth2", + "weight": 1175, "cookies": false, "type": "", - "demo": "project\/create-smtp-test.md", + "demo": "project\/update-o-auth-2-keycloak.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30838,39 +31107,58 @@ "schema": { "type": "object", "properties": { - "emails": { - "type": "array", - "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", - "x-example": null, - "items": { - "type": "string" - } + "clientId": { + "type": "string", + "description": "'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO", + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of Keycloak instance. For example: keycloak.example.com", + "x-example": "", + "x-nullable": true + }, + "realmName": { + "type": "string", + "description": "Keycloak realm name. For example: appwrite-realm", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "emails" - ] + } } } } } } }, - "\/project\/templates\/email": { + "\/project\/oauth2\/kick": { "patch": { - "summary": "Update project email template", - "operationId": "projectUpdateEmailTemplate", + "summary": "Update project OAuth2 Kick", + "operationId": "projectUpdateOAuth2Kick", "tags": [ "project" ], - "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", + "description": "Update the project OAuth2 Kick configuration.", "responses": { "200": { - "description": "EmailTemplate", + "description": "OAuth2Kick", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/emailTemplate" + "$ref": "#\/components\/schemas\/oAuth2Kick" } } } @@ -30878,16 +31166,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailTemplate", - "group": "templates", - "weight": 1035, + "method": "updateOAuth2Kick", + "group": "oauth2", + "weight": 1178, "cookies": false, "type": "", - "demo": "project\/update-email-template.md", + "demo": "project\/update-o-auth-2-kick.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "templates.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30911,225 +31199,46 @@ "schema": { "type": "object", "properties": { - "templateId": { - "type": "string", - "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [] - }, - "locale": { - "type": "string", - "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [] - }, - "subject": { - "type": "string", - "description": "Subject of the email template. Can be up to 255 characters.", - "x-example": "", - "x-nullable": true - }, - "message": { - "type": "string", - "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", - "x-example": "", - "x-nullable": true - }, - "senderName": { - "type": "string", - "description": "Name of the email sender.", - "x-example": "", - "x-nullable": true - }, - "senderEmail": { + "clientId": { "type": "string", - "description": "Email of the sender.", - "x-example": "email@example.com", - "format": "email", + "description": "'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32", + "x-example": "", "x-nullable": true }, - "replyToEmail": { + "clientSecret": { "type": "string", - "description": "Reply to email.", - "x-example": "email@example.com", - "format": "email", + "description": "'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b", + "x-example": "", "x-nullable": true }, - "replyToName": { - "type": "string", - "description": "Reply to name.", - "x-example": "", + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, "x-nullable": true } - }, - "required": [ - "templateId" - ] + } } } } } } }, - "\/project\/templates\/email\/{templateId}": { - "get": { - "summary": "Get project email template", - "operationId": "projectGetEmailTemplate", + "\/project\/oauth2\/linkedin": { + "patch": { + "summary": "Update project OAuth2 Linkedin", + "operationId": "projectUpdateOAuth2Linkedin", "tags": [ "project" ], - "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.", + "description": "Update the project OAuth2 Linkedin configuration.", "responses": { "200": { - "description": "EmailTemplate", + "description": "OAuth2Linkedin", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/emailTemplate" + "$ref": "#\/components\/schemas\/oAuth2Linkedin" } } } @@ -31137,16 +31246,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getEmailTemplate", - "group": "templates", - "weight": 1034, + "method": "updateOAuth2Linkedin", + "group": "oauth2", + "weight": 1162, "cookies": false, "type": "", - "demo": "project\/get-email-template.md", + "demo": "project\/update-o-auth-2-linkedin.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "templates.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31164,192 +31273,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "templateId", - "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", - "required": true, - "schema": { - "type": "string", - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [] - }, - "in": "path" - }, - { - "name": "locale", - "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "required": false, - "schema": { - "type": "string", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [], - "default": "" - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv", + "x-example": "", + "x-nullable": true + }, + "primaryClientSecret": { + "type": "string", + "description": "'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000.\/HtlYw==", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/project\/variables": { - "get": { - "summary": "List project variables", - "operationId": "projectListVariables", + "\/project\/oauth2\/microsoft": { + "patch": { + "summary": "Update project OAuth2 Microsoft", + "operationId": "projectUpdateOAuth2Microsoft", "tags": [ "project" ], - "description": "Get a list of all project environment variables.", + "description": "Update the project OAuth2 Microsoft configuration.", "responses": { "200": { - "description": "Variables List", + "description": "OAuth2Microsoft", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variableList" + "$ref": "#\/components\/schemas\/oAuth2Microsoft" } } } @@ -31357,16 +31326,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 1037, + "method": "updateOAuth2Microsoft", + "group": "oauth2", + "weight": 1180, "cookies": false, "type": "", - "demo": "project\/list-variables.md", + "demo": "project\/update-o-auth-2-microsoft.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31384,47 +31353,58 @@ "Key": [] } ], - "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: key, resourceType, resourceId, secret", - "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", - "x-example": false, - "default": true - }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", - "tags": [ - "project" - ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", - "responses": { - "201": { - "description": "Variable", + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "applicationId": { + "type": "string", + "description": "'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444", + "x-example": "", + "x-nullable": true + }, + "applicationSecret": { + "type": "string", + "description": "'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", + "x-example": "", + "x-nullable": true + }, + "tenant": { + "type": "string", + "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/project\/oauth2\/notion": { + "patch": { + "summary": "Update project OAuth2 Notion", + "operationId": "projectUpdateOAuth2Notion", + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Notion configuration.", + "responses": { + "200": { + "description": "OAuth2Notion", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/oAuth2Notion" } } } @@ -31432,16 +31412,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 1036, + "method": "updateOAuth2Notion", + "group": "oauth2", + "weight": 1159, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "project\/update-o-auth-2-notion.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31465,53 +31445,46 @@ "schema": { "type": "object", "properties": { - "variableId": { + "oauthClientId": { "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "key": { - "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "description": "'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3", + "x-example": "", + "x-nullable": true }, - "value": { + "oauthClientSecret": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "" + "description": "'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9", + "x-example": "", + "x-nullable": true }, - "secret": { + "enabled": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "variableId", - "key", - "value" - ] + } } } } } } }, - "\/project\/variables\/{variableId}": { - "get": { - "summary": "Get project variable", - "operationId": "projectGetVariable", + "\/project\/oauth2\/oidc": { + "patch": { + "summary": "Update project OAuth2 Oidc", + "operationId": "projectUpdateOAuth2Oidc", "tags": [ "project" ], - "description": "Get a variable by its unique ID. ", + "description": "Update the project OAuth2 Oidc configuration.", "responses": { "200": { - "description": "Variable", + "description": "OAuth2Oidc", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/oAuth2Oidc" } } } @@ -31519,16 +31492,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 1038, + "method": "updateOAuth2Oidc", + "group": "oauth2", + "weight": 1176, "cookies": false, "type": "", - "demo": "project\/get-variable.md", + "demo": "project\/update-o-auth-2-oidc.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31546,33 +31519,80 @@ "Key": [] } ], - "parameters": [ - { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", + "x-example": "", + "x-nullable": true + }, + "wellKnownURL": { + "type": "string", + "description": "OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https:\/\/myoauth.com\/.well-known\/openid-configuration", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "authorizationURL": { + "type": "string", + "description": "OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/authorize", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "tokenUrl": { + "type": "string", + "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "userInfoUrl": { + "type": "string", + "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "put": { - "summary": "Update project variable", - "operationId": "projectUpdateVariable", + } + } + }, + "\/project\/oauth2\/okta": { + "patch": { + "summary": "Update project OAuth2 Okta", + "operationId": "projectUpdateOAuth2Okta", "tags": [ "project" ], - "description": "Update variable by its unique ID.", + "description": "Update the project OAuth2 Okta configuration.", "responses": { "200": { - "description": "Variable", + "description": "OAuth2Okta", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/oAuth2Okta" } } } @@ -31580,16 +31600,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 1040, + "method": "updateOAuth2Okta", + "group": "oauth2", + "weight": 1177, "cookies": false, "type": "", - "demo": "project\/update-variable.md", + "demo": "project\/update-o-auth-2-okta.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31607,39 +31627,39 @@ "Key": [] } ], - "parameters": [ - { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "key": { + "clientId": { "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "", + "description": "'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698", + "x-example": "", "x-nullable": true }, - "value": { + "clientSecret": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "", + "description": "'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "x-example": "", "x-nullable": true }, - "secret": { + "domain": { + "type": "string", + "description": "Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https:\/\/trial-6400025.okta.com\/", + "x-example": null, + "x-nullable": true + }, + "authorizationServerId": { + "type": "string", + "description": "Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z", + "x-example": "", + "x-nullable": true + }, + "enabled": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "x-example": false, "x-nullable": true } @@ -31648,31 +31668,40 @@ } } } - }, - "delete": { - "summary": "Delete project variable", - "operationId": "projectDeleteVariable", + } + }, + "\/project\/oauth2\/paypal": { + "patch": { + "summary": "Update project OAuth2 Paypal", + "operationId": "projectUpdateOAuth2Paypal", "tags": [ "project" ], - "description": "Delete a variable by its unique ID. ", + "description": "Update the project OAuth2 Paypal configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Paypal", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Paypal" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 1039, + "method": "updateOAuth2Paypal", + "group": "oauth2", + "weight": 1169, "cookies": false, "type": "", - "demo": "project\/delete-variable.md", + "demo": "project\/update-o-auth-2-paypal.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31690,35 +31719,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] + } } }, - "\/sites": { - "get": { - "summary": "List sites", - "operationId": "sitesList", + "\/project\/oauth2\/paypalSandbox": { + "patch": { + "summary": "Update project OAuth2 PaypalSandbox", + "operationId": "projectUpdateOAuth2PaypalSandbox", "tags": [ - "sites" + "project" ], - "description": "Get a list of all the project's sites. You can use the query params to filter your results.", + "description": "Update the project OAuth2 PaypalSandbox configuration.", "responses": { "200": { - "description": "Sites List", + "description": "OAuth2Paypal", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/siteList" + "$ref": "#\/components\/schemas\/oAuth2Paypal" } } } @@ -31726,16 +31772,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "sites", - "weight": 491, + "method": "updateOAuth2PaypalSandbox", + "group": "oauth2", + "weight": 1170, "cookies": false, "type": "", - "demo": "sites\/list.md", + "demo": "project\/update-o-auth-2-paypal-sandbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31753,58 +31799,52 @@ "Key": [] } ], - "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: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "post": { - "summary": "Create site", - "operationId": "sitesCreate", + } + } + }, + "\/project\/oauth2\/podio": { + "patch": { + "summary": "Update project OAuth2 Podio", + "operationId": "projectUpdateOAuth2Podio", "tags": [ - "sites" + "project" ], - "description": "Create a new site.", + "description": "Update the project OAuth2 Podio configuration.", "responses": { - "201": { - "description": "Site", + "200": { + "description": "OAuth2Podio", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/site" + "$ref": "#\/components\/schemas\/oAuth2Podio" } } } @@ -31812,16 +31852,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "sites", - "weight": 848, + "method": "updateOAuth2Podio", + "group": "oauth2", + "weight": 1158, "cookies": false, "type": "", - "demo": "sites\/create.md", + "demo": "project\/update-o-auth-2-podio.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31845,261 +31885,366 @@ "schema": { "type": "object", "properties": { - "siteId": { + "clientId": { "type": "string", - "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Site name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app", + "x-example": "", + "x-nullable": true }, - "framework": { + "clientSecret": { "type": "string", - "description": "Sites framework.", - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN", + "x-example": "", + "x-nullable": true }, "enabled": { "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false - }, - "timeout": { - "type": "integer", - "description": "Maximum request time in seconds.", - "x-example": 1, - "format": "int32" - }, - "installCommand": { + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/project\/oauth2\/salesforce": { + "patch": { + "summary": "Update project OAuth2 Salesforce", + "operationId": "projectUpdateOAuth2Salesforce", + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Salesforce configuration.", + "responses": { + "200": { + "description": "OAuth2Salesforce", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Salesforce" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Salesforce", + "group": "oauth2", + "weight": 1160, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-salesforce.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "customerKey": { "type": "string", - "description": "Install Command.", - "x-example": "" + "description": "'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", + "x-example": "", + "x-nullable": true }, - "buildCommand": { + "customerSecret": { "type": "string", - "description": "Build Command.", - "x-example": "" + "description": "'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2", + "x-example": "", + "x-nullable": true }, - "startCommand": { + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/project\/oauth2\/slack": { + "patch": { + "summary": "Update project OAuth2 Slack", + "operationId": "projectUpdateOAuth2Slack", + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Slack configuration.", + "responses": { + "200": { + "description": "OAuth2Slack", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Slack" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Slack", + "group": "oauth2", + "weight": 1157, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-slack.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { "type": "string", - "description": "Custom start command. Leave empty to use default.", - "x-example": "" + "description": "'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023", + "x-example": "", + "x-nullable": true }, - "outputDirectory": { + "clientSecret": { "type": "string", - "description": "Output Directory for site.", - "x-example": "" + "description": "'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd", + "x-example": "", + "x-nullable": true }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dart-3.11", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "flutter-3.41" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "x-example": "" - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "x-example": "" - }, - "providerRepositoryId": { + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/project\/oauth2\/spotify": { + "patch": { + "summary": "Update project OAuth2 Spotify", + "operationId": "projectUpdateOAuth2Spotify", + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Spotify configuration.", + "responses": { + "200": { + "description": "OAuth2Spotify", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Spotify" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Spotify", + "group": "oauth2", + "weight": 1156, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-spotify.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { "type": "string", - "description": "Repository ID of the repo linked to the site.", - "x-example": "" + "description": "'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace", + "x-example": "", + "x-nullable": true }, - "providerBranch": { + "clientSecret": { "type": "string", - "description": "Production branch for the repo linked to the site.", - "x-example": "" + "description": "'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f", + "x-example": "", + "x-nullable": true }, - "providerSilentMode": { + "enabled": { "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", - "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "x-example": "" - }, - "buildSpecification": { + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/project\/oauth2\/stripe": { + "patch": { + "summary": "Update project OAuth2 Stripe", + "operationId": "projectUpdateOAuth2Stripe", + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Stripe configuration.", + "responses": { + "200": { + "description": "OAuth2Stripe", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2Stripe" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Stripe", + "group": "oauth2", + "weight": 1155, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-stripe.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { "type": "string", - "description": "Build specification for the site deployments.", - "x-example": null + "description": "'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR", + "x-example": "", + "x-nullable": true }, - "runtimeSpecification": { + "apiSecretKey": { "type": "string", - "description": "Runtime specification for the SSR executions.", - "x-example": null + "description": "'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp", + "x-example": "", + "x-nullable": true }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "x-example": 0, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "siteId", - "name", - "framework", - "buildRuntime" - ] + } } } } } } }, - "\/sites\/frameworks": { - "get": { - "summary": "List frameworks", - "operationId": "sitesListFrameworks", + "\/project\/oauth2\/tradeshift": { + "patch": { + "summary": "Update project OAuth2 Tradeshift", + "operationId": "projectUpdateOAuth2Tradeshift", "tags": [ - "sites" + "project" ], - "description": "Get a list of all frameworks that are currently available on the server instance.", + "description": "Update the project OAuth2 Tradeshift configuration.", "responses": { "200": { - "description": "Frameworks List", + "description": "OAuth2Tradeshift", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/frameworkList" + "$ref": "#\/components\/schemas\/oAuth2Tradeshift" } } } @@ -32107,16 +32252,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listFrameworks", - "group": "frameworks", - "weight": 494, + "method": "updateOAuth2Tradeshift", + "group": "oauth2", + "weight": 1167, "cookies": false, "type": "", - "demo": "sites\/list-frameworks.md", + "demo": "project\/update-o-auth-2-tradeshift.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32133,24 +32278,53 @@ "Project": [], "Key": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "oauth2ClientId": { + "type": "string", + "description": "'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app", + "x-example": "", + "x-nullable": true + }, + "oauth2ClientSecret": { + "type": "string", + "description": "'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } } }, - "\/sites\/specifications": { - "get": { - "summary": "List specifications", - "operationId": "sitesListSpecifications", + "\/project\/oauth2\/tradeshiftBox": { + "patch": { + "summary": "Update project OAuth2 Tradeshift Sandbox", + "operationId": "projectUpdateOAuth2TradeshiftSandbox", "tags": [ - "sites" + "project" ], - "description": "List allowed site specifications for this instance.", + "description": "Update the project OAuth2 Tradeshift Sandbox configuration.", "responses": { "200": { - "description": "Specifications List", + "description": "OAuth2Tradeshift", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/specificationList" + "$ref": "#\/components\/schemas\/oAuth2Tradeshift" } } } @@ -32158,19 +32332,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "listSpecifications", - "group": "frameworks", - "weight": 517, + "method": "updateOAuth2TradeshiftSandbox", + "group": "oauth2", + "weight": 1168, "cookies": false, "type": "", - "demo": "sites\/list-specifications.md", + "demo": "project\/update-o-auth-2-tradeshift-sandbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "oauth2.write", "platforms": [ - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -32184,24 +32358,53 @@ "Project": [], "Key": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "oauth2ClientId": { + "type": "string", + "description": "'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app", + "x-example": "", + "x-nullable": true + }, + "oauth2ClientSecret": { + "type": "string", + "description": "'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } } }, - "\/sites\/{siteId}": { - "get": { - "summary": "Get site", - "operationId": "sitesGet", + "\/project\/oauth2\/twitch": { + "patch": { + "summary": "Update project OAuth2 Twitch", + "operationId": "projectUpdateOAuth2Twitch", "tags": [ - "sites" + "project" ], - "description": "Get a site by its unique ID.", + "description": "Update the project OAuth2 Twitch configuration.", "responses": { "200": { - "description": "Site", + "description": "OAuth2Twitch", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/site" + "$ref": "#\/components\/schemas\/oAuth2Twitch" } } } @@ -32209,16 +32412,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "sites", - "weight": 490, + "method": "updateOAuth2Twitch", + "group": "oauth2", + "weight": 1154, "cookies": false, "type": "", - "demo": "sites\/get.md", + "demo": "project\/update-o-auth-2-twitch.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32236,33 +32439,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, - "put": { - "summary": "Update site", - "operationId": "sitesUpdate", + } + } + }, + "\/project\/oauth2\/wordpress": { + "patch": { + "summary": "Update project OAuth2 WordPress", + "operationId": "projectUpdateOAuth2WordPress", "tags": [ - "sites" + "project" ], - "description": "Update site by its unique ID.", + "description": "Update the project OAuth2 WordPress configuration.", "responses": { "200": { - "description": "Site", + "description": "OAuth2WordPress", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/site" + "$ref": "#\/components\/schemas\/oAuth2WordPress" } } } @@ -32270,16 +32492,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "sites", - "weight": 849, + "method": "updateOAuth2WordPress", + "group": "oauth2", + "weight": 1153, "cookies": false, "type": "", - "demo": "sites\/update.md", + "demo": "project\/update-o-auth-2-word-press.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32297,326 +32519,132 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Site name. Max length: 128 chars.", - "x-example": "" + "description": "'Client ID' of WordPress OAuth2 app. For example: 130005", + "x-example": "", + "x-nullable": true }, - "framework": { + "clientSecret": { "type": "string", - "description": "Sites framework.", - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk", + "x-example": "", + "x-nullable": true }, "enabled": { "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false - }, - "timeout": { - "type": "integer", - "description": "Maximum request time in seconds.", - "x-example": 1, - "format": "int32" - }, - "installCommand": { + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/project\/oauth2\/x": { + "patch": { + "summary": "Update project OAuth2 X", + "operationId": "projectUpdateOAuth2X", + "tags": [ + "project" + ], + "description": "Update the project OAuth2 X configuration.", + "responses": { + "200": { + "description": "OAuth2X", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/oAuth2X" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2X", + "group": "oauth2", + "weight": 1152, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2x.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "customerKey": { "type": "string", - "description": "Install Command.", - "x-example": "" + "description": "'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT", + "x-example": "", + "x-nullable": true }, - "buildCommand": { + "secretKey": { "type": "string", - "description": "Build Command.", - "x-example": "" + "description": "'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9", + "x-example": "", + "x-nullable": true }, - "startCommand": { - "type": "string", - "description": "Custom start command. Leave empty to use default.", - "x-example": "" - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory for site.", - "x-example": "" - }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dart-3.11", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "flutter-3.41" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "x-example": "" - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "x-example": "" - }, - "providerRepositoryId": { - "type": "string", - "description": "Repository ID of the repo linked to the site.", - "x-example": "" - }, - "providerBranch": { - "type": "string", - "description": "Production branch for the repo linked to the site.", - "x-example": "" - }, - "providerSilentMode": { + "enabled": { "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", - "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "x-example": "" - }, - "buildSpecification": { - "type": "string", - "description": "Build specification for the site deployments.", - "x-example": null - }, - "runtimeSpecification": { - "type": "string", - "description": "Runtime specification for the SSR executions.", - "x-example": null - }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "x-example": 0, - "format": "int32" + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "framework" - ] + } } } } } - }, - "delete": { - "summary": "Delete site", - "operationId": "sitesDelete", - "tags": [ - "sites" - ], - "description": "Delete a site by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "delete", - "group": "sites", - "weight": 493, - "cookies": false, - "type": "", - "demo": "sites\/delete.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] } }, - "\/sites\/{siteId}\/deployment": { + "\/project\/oauth2\/yahoo": { "patch": { - "summary": "Update site's deployment", - "operationId": "sitesUpdateSiteDeployment", + "summary": "Update project OAuth2 Yahoo", + "operationId": "projectUpdateOAuth2Yahoo", "tags": [ - "sites" + "project" ], - "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "description": "Update the project OAuth2 Yahoo configuration.", "responses": { "200": { - "description": "Site", + "description": "OAuth2Yahoo", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/site" + "$ref": "#\/components\/schemas\/oAuth2Yahoo" } } } @@ -32624,16 +32652,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSiteDeployment", - "group": "sites", - "weight": 500, + "method": "updateOAuth2Yahoo", + "group": "oauth2", + "weight": 1161, "cookies": false, "type": "", - "demo": "sites\/update-site-deployment.md", + "demo": "project\/update-o-auth-2-yahoo.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32651,54 +32679,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "deploymentId": { + "clientId": { "type": "string", - "description": "Deployment ID.", - "x-example": "" + "description": "'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "deploymentId" - ] + } } } } } } }, - "\/sites\/{siteId}\/deployments": { - "get": { - "summary": "List deployments", - "operationId": "sitesListDeployments", + "\/project\/oauth2\/yandex": { + "patch": { + "summary": "Update project OAuth2 Yandex", + "operationId": "projectUpdateOAuth2Yandex", "tags": [ - "sites" + "project" ], - "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", + "description": "Update the project OAuth2 Yandex configuration.", "responses": { "200": { - "description": "Deployments List", + "description": "OAuth2Yandex", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deploymentList" + "$ref": "#\/components\/schemas\/oAuth2Yandex" } } } @@ -32706,16 +32732,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listDeployments", - "group": "deployments", - "weight": 499, + "method": "updateOAuth2Yandex", + "group": "oauth2", + "weight": 1151, "cookies": false, "type": "", - "demo": "sites\/list-deployments.md", + "demo": "project\/update-o-auth-2-yandex.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32733,174 +32759,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create deployment", - "operationId": "sitesCreateDeployment", - "tags": [ - "sites" - ], - "description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.", - "responses": { - "202": { - "description": "Deployment", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/deployment" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createDeployment", - "group": "deployments", - "weight": 495, - "cookies": false, - "type": "upload", - "demo": "sites\/create-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": true, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { - "multipart\/form-data": { + "application\/json": { "schema": { "type": "object", "properties": { - "installCommand": { + "clientId": { "type": "string", - "description": "Install Commands.", - "x-example": "", - "x-nullable": true - }, - "buildCommand": { - "type": "string", - "description": "Build Commands.", - "x-example": "", + "description": "'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c", + "x-example": "", "x-nullable": true }, - "outputDirectory": { + "clientSecret": { "type": "string", - "description": "Output Directory.", - "x-example": "", + "description": "'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63", + "x-example": "", "x-nullable": true }, - "code": { - "type": "string", - "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "x-example": null, - "format": "binary" - }, - "activate": { + "enabled": { "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "code" - ] + } } } } } } }, - "\/sites\/{siteId}\/deployments\/duplicate": { - "post": { - "summary": "Create duplicate deployment", - "operationId": "sitesCreateDuplicateDeployment", + "\/project\/oauth2\/zoho": { + "patch": { + "summary": "Update project OAuth2 Zoho", + "operationId": "projectUpdateOAuth2Zoho", "tags": [ - "sites" + "project" ], - "description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.", + "description": "Update the project OAuth2 Zoho configuration.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "OAuth2Zoho", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deployment" + "$ref": "#\/components\/schemas\/oAuth2Zoho" } } } @@ -32908,16 +32812,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDuplicateDeployment", - "group": "deployments", - "weight": 503, + "method": "updateOAuth2Zoho", + "group": "oauth2", + "weight": 1150, "cookies": false, "type": "", - "demo": "sites\/create-duplicate-deployment.md", + "demo": "project\/update-o-auth-2-zoho.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32935,54 +32839,52 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "deploymentId": { + "clientId": { "type": "string", - "description": "Deployment ID.", - "x-example": "" + "description": "'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e", + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "deploymentId" - ] + } } } } } } }, - "\/sites\/{siteId}\/deployments\/template": { - "post": { - "summary": "Create template deployment", - "operationId": "sitesCreateTemplateDeployment", + "\/project\/oauth2\/zoom": { + "patch": { + "summary": "Update project OAuth2 Zoom", + "operationId": "projectUpdateOAuth2Zoom", "tags": [ - "sites" + "project" ], - "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", + "description": "Update the project OAuth2 Zoom configuration.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "OAuth2Zoom", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deployment" + "$ref": "#\/components\/schemas\/oAuth2Zoom" } } } @@ -32990,16 +32892,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTemplateDeployment", - "group": "deployments", - "weight": 496, + "method": "updateOAuth2Zoom", + "group": "oauth2", + "weight": 1149, "cookies": false, "type": "", - "demo": "sites\/create-template-deployment.md", + "demo": "project\/update-o-auth-2-zoom.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -33017,90 +32919,220 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "repository": { - "type": "string", - "description": "Repository name of the template.", - "x-example": "" - }, - "owner": { + "clientId": { "type": "string", - "description": "The name of the owner of the template.", - "x-example": "" + "description": "'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ", + "x-example": "", + "x-nullable": true }, - "rootDirectory": { + "clientSecret": { "type": "string", - "description": "Path to site code in the template repo.", - "x-example": "" + "description": "'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON", + "x-example": "", + "x-nullable": true }, - "type": { - "type": "string", - "description": "Type for the reference provided. Can be commit, branch, or tag", - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "TemplateReferenceType", - "x-enum-keys": [] - }, - "reference": { - "type": "string", - "description": "Reference value, can be a commit hash, branch name, or release tag", - "x-example": "" - }, - "activate": { + "enabled": { "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "x-example": false, + "x-nullable": true } - }, - "required": [ - "repository", - "owner", - "rootDirectory", - "type", - "reference" - ] + } } } } } } }, - "\/sites\/{siteId}\/deployments\/vcs": { - "post": { - "summary": "Create VCS deployment", - "operationId": "sitesCreateVcsDeployment", + "\/project\/oauth2\/{provider}": { + "get": { + "summary": "Get project OAuth2 provider", + "operationId": "projectGetOAuth2Provider", "tags": [ - "sites" + "project" ], - "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", + "description": "Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key\/team IDs) are write-only and always returned empty.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "OAuth2GitHub, or OAuth2Discord, or OAuth2Figma, or OAuth2Dropbox, or OAuth2Dailymotion, or OAuth2Bitbucket, or OAuth2Bitly, or OAuth2Box, or OAuth2Autodesk, or OAuth2Google, or OAuth2Zoom, or OAuth2Zoho, or OAuth2Yandex, or OAuth2X, or OAuth2WordPress, or OAuth2Twitch, or OAuth2Stripe, or OAuth2Spotify, or OAuth2Slack, or OAuth2Podio, or OAuth2Notion, or OAuth2Salesforce, or OAuth2Yahoo, or OAuth2Linkedin, or OAuth2Disqus, or OAuth2Amazon, or OAuth2Etsy, or OAuth2Facebook, or OAuth2Tradeshift, or OAuth2Paypal, or OAuth2Gitlab, or OAuth2Authentik, or OAuth2Auth0, or OAuth2FusionAuth, or OAuth2Keycloak, or OAuth2Oidc, or OAuth2Apple, or OAuth2Okta, or OAuth2Kick, or OAuth2Microsoft", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deployment" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/oAuth2Github" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Discord" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Figma" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Dropbox" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Dailymotion" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Bitbucket" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Bitly" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Box" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Autodesk" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Google" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Zoom" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Zoho" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Yandex" + }, + { + "$ref": "#\/components\/schemas\/oAuth2X" + }, + { + "$ref": "#\/components\/schemas\/oAuth2WordPress" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Twitch" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Stripe" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Spotify" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Slack" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Podio" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Notion" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Salesforce" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Yahoo" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Linkedin" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Disqus" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Amazon" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Etsy" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Facebook" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Tradeshift" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Paypal" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Gitlab" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Authentik" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Auth0" + }, + { + "$ref": "#\/components\/schemas\/oAuth2FusionAuth" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Keycloak" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Oidc" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Apple" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Okta" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Kick" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Microsoft" + } + ], + "discriminator": { + "propertyName": "$id", + "mapping": { + "github": "#\/components\/schemas\/oAuth2Github", + "discord": "#\/components\/schemas\/oAuth2Discord", + "figma": "#\/components\/schemas\/oAuth2Figma", + "dropbox": "#\/components\/schemas\/oAuth2Dropbox", + "dailymotion": "#\/components\/schemas\/oAuth2Dailymotion", + "bitbucket": "#\/components\/schemas\/oAuth2Bitbucket", + "bitly": "#\/components\/schemas\/oAuth2Bitly", + "box": "#\/components\/schemas\/oAuth2Box", + "autodesk": "#\/components\/schemas\/oAuth2Autodesk", + "google": "#\/components\/schemas\/oAuth2Google", + "zoom": "#\/components\/schemas\/oAuth2Zoom", + "zoho": "#\/components\/schemas\/oAuth2Zoho", + "yandex": "#\/components\/schemas\/oAuth2Yandex", + "x": "#\/components\/schemas\/oAuth2X", + "wordpress": "#\/components\/schemas\/oAuth2WordPress", + "twitch": "#\/components\/schemas\/oAuth2Twitch", + "stripe": "#\/components\/schemas\/oAuth2Stripe", + "spotify": "#\/components\/schemas\/oAuth2Spotify", + "slack": "#\/components\/schemas\/oAuth2Slack", + "podio": "#\/components\/schemas\/oAuth2Podio", + "notion": "#\/components\/schemas\/oAuth2Notion", + "salesforce": "#\/components\/schemas\/oAuth2Salesforce", + "yahoo": "#\/components\/schemas\/oAuth2Yahoo", + "linkedin": "#\/components\/schemas\/oAuth2Linkedin", + "disqus": "#\/components\/schemas\/oAuth2Disqus", + "amazon": "#\/components\/schemas\/oAuth2Amazon", + "etsy": "#\/components\/schemas\/oAuth2Etsy", + "facebook": "#\/components\/schemas\/oAuth2Facebook", + "tradeshift": "#\/components\/schemas\/oAuth2Tradeshift", + "tradeshiftBox": "#\/components\/schemas\/oAuth2Tradeshift", + "paypal": "#\/components\/schemas\/oAuth2Paypal", + "paypalSandbox": "#\/components\/schemas\/oAuth2Paypal", + "gitlab": "#\/components\/schemas\/oAuth2Gitlab", + "authentik": "#\/components\/schemas\/oAuth2Authentik", + "auth0": "#\/components\/schemas\/oAuth2Auth0", + "fusionauth": "#\/components\/schemas\/oAuth2FusionAuth", + "keycloak": "#\/components\/schemas\/oAuth2Keycloak", + "oidc": "#\/components\/schemas\/oAuth2Oidc", + "apple": "#\/components\/schemas\/oAuth2Apple", + "okta": "#\/components\/schemas\/oAuth2Okta", + "kick": "#\/components\/schemas\/oAuth2Kick", + "microsoft": "#\/components\/schemas\/oAuth2Microsoft" + } + } } } } @@ -33108,16 +33140,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVcsDeployment", - "group": "deployments", - "weight": 497, + "method": "getOAuth2Provider", + "group": "oauth2", + "weight": 1138, "cookies": false, "type": "", - "demo": "sites\/create-vcs-deployment.md", + "demo": "project\/get-o-auth-2-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.read", "platforms": [ "console", "server" @@ -33137,70 +33169,33 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "provider", + "description": "OAuth2 provider key. For example: github, google, apple.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of reference passed. Allowed values are: branch, commit", - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "VCSReferenceType", - "x-enum-keys": [] - }, - "reference": { - "type": "string", - "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "x-example": "" - }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "x-example": false - } - }, - "required": [ - "type", - "reference" - ] - } - } - } - } + ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}": { + "\/project\/platforms": { "get": { - "summary": "Get deployment", - "operationId": "sitesGetDeployment", + "summary": "List project platforms", + "operationId": "projectListPlatforms", "tags": [ - "sites" + "project" ], - "description": "Get a site deployment by its unique ID.", + "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", "responses": { "200": { - "description": "Deployment", + "description": "Platforms List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deployment" + "$ref": "#\/components\/schemas\/platformList" } } } @@ -33208,16 +33203,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getDeployment", - "group": "deployments", - "weight": 498, + "method": "listPlatforms", + "group": "platforms", + "weight": 1119, "cookies": false, "type": "", - "demo": "sites\/get-deployment.md", + "demo": "project\/list-platforms.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "platforms.read", "platforms": [ "console", "server" @@ -33237,51 +33232,64 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "boolean", + "x-example": false, + "default": true }, - "in": "path" + "in": "query" } ] - }, - "delete": { - "summary": "Delete deployment", - "operationId": "sitesDeleteDeployment", + } + }, + "\/project\/platforms\/android": { + "post": { + "summary": "Create project Android platform", + "operationId": "projectCreateAndroidPlatform", "tags": [ - "sites" + "project" ], - "description": "Delete a site deployment by its unique ID.", + "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Platform Android", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformAndroid" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDeployment", - "group": "deployments", - "weight": 501, + "method": "createAndroidPlatform", + "group": "platforms", + "weight": 1115, "cookies": false, "type": "", - "demo": "sites\/delete-deployment.md", + "demo": "project\/create-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33299,58 +33307,73 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "applicationId" + ] + } + } } - ] + } } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { - "get": { - "summary": "Get deployment download", - "operationId": "sitesGetDeploymentDownload", + "\/project\/platforms\/android\/{platformId}": { + "put": { + "summary": "Update project Android platform", + "operationId": "projectUpdateAndroidPlatform", "tags": [ - "sites" + "project" ], - "description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", "responses": { "200": { - "description": "File" + "description": "Platform Android", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformAndroid" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getDeploymentDownload", - "group": "deployments", - "weight": 502, + "method": "updateAndroidPlatform", + "group": "platforms", + "weight": 1110, "cookies": false, - "type": "location", - "demo": "sites\/get-deployment-download.md", + "type": "", + "demo": "project\/update-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "platforms.write", "platforms": [ "console", - "server", "server" ], "packaging": false, @@ -33363,66 +33386,63 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "type", - "description": "Deployment file to download. Can be: \"source\", \"output\".", - "required": false, - "schema": { - "type": "string", - "x-example": "source", - "enum": [ - "source", - "output" - ], - "x-enum-name": "DeploymentDownloadType", - "x-enum-keys": [], - "default": "source" - }, - "in": "query" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "applicationId" + ] + } + } + } + } } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { - "patch": { - "summary": "Update deployment status", - "operationId": "sitesUpdateDeploymentStatus", + "\/project\/platforms\/apple": { + "post": { + "summary": "Create project Apple platform", + "operationId": "projectCreateApplePlatform", "tags": [ - "sites" + "project" ], - "description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", + "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Deployment", + "201": { + "description": "Platform Apple", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/deployment" + "$ref": "#\/components\/schemas\/platformApple" } } } @@ -33430,16 +33450,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDeploymentStatus", - "group": "deployments", - "weight": 504, + "method": "createApplePlatform", + "group": "platforms", + "weight": 1114, "cookies": false, "type": "", - "demo": "sites\/update-deployment-status.md", + "demo": "project\/create-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33457,45 +33477,54 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "bundleIdentifier" + ] + } + } } - ] + } } }, - "\/sites\/{siteId}\/logs": { - "get": { - "summary": "List logs", - "operationId": "sitesListLogs", + "\/project\/platforms\/apple\/{platformId}": { + "put": { + "summary": "Update project Apple platform", + "operationId": "projectUpdateApplePlatform", "tags": [ - "sites" + "project" ], - "description": "Get a list of all site logs. You can use the query params to filter your results.", + "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", "responses": { "200": { - "description": "Executions List", + "description": "Platform Apple", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/executionList" + "$ref": "#\/components\/schemas\/platformApple" } } } @@ -33503,16 +33532,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 506, + "method": "updateApplePlatform", + "group": "platforms", + "weight": 1109, "cookies": false, "type": "", - "demo": "sites\/list-logs.md", + "demo": "project\/update-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33532,57 +33561,58 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", - "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", - "x-example": false, - "default": true - }, - "in": "query" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "bundleIdentifier" + ] + } + } + } + } } }, - "\/sites\/{siteId}\/logs\/{logId}": { - "get": { - "summary": "Get log", - "operationId": "sitesGetLog", + "\/project\/platforms\/linux": { + "post": { + "summary": "Create project Linux platform", + "operationId": "projectCreateLinuxPlatform", "tags": [ - "sites" + "project" ], - "description": "Get a site request log by its unique ID.", + "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Execution", + "201": { + "description": "Platform Linux", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/execution" + "$ref": "#\/components\/schemas\/platformLinux" } } } @@ -33590,16 +33620,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getLog", - "group": "logs", - "weight": 505, + "method": "createLinuxPlatform", + "group": "platforms", + "weight": 1117, "cookies": false, "type": "", - "demo": "sites\/get-log.md", + "demo": "project\/create-linux-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33617,53 +33647,71 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageName" + ] + } + } } - ] - }, - "delete": { - "summary": "Delete log", - "operationId": "sitesDeleteLog", + } + } + }, + "\/project\/platforms\/linux\/{platformId}": { + "put": { + "summary": "Update project Linux platform", + "operationId": "projectUpdateLinuxPlatform", "tags": [ - "sites" + "project" ], - "description": "Delete a site log by its unique ID.", + "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Platform Linux", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/platformLinux" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteLog", - "group": "logs", - "weight": 507, + "method": "updateLinuxPlatform", + "group": "platforms", + "weight": 1112, "cookies": false, "type": "", - "demo": "sites\/delete-log.md", + "demo": "project\/update-linux-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33683,43 +33731,58 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "packageName" + ] + } + } + } + } } }, - "\/sites\/{siteId}\/variables": { - "get": { - "summary": "List variables", - "operationId": "sitesListVariables", + "\/project\/platforms\/web": { + "post": { + "summary": "Create project web platform", + "operationId": "projectCreateWebPlatform", "tags": [ - "sites" + "project" ], - "description": "Get a list of all variables of a specific site.", + "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Variables List", + "201": { + "description": "Platform Web", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variableList" + "$ref": "#\/components\/schemas\/platformWeb" } } } @@ -33727,16 +33790,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 510, + "method": "createWebPlatform", + "group": "platforms", + "weight": 1113, "cookies": false, "type": "", - "demo": "sites\/list-variables.md", + "demo": "project\/create-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33754,33 +33817,54 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "x-example": "app.example.com" + } + }, + "required": [ + "platformId", + "name", + "hostname" + ] + } + } } - ] - }, - "post": { - "summary": "Create variable", - "operationId": "sitesCreateVariable", + } + } + }, + "\/project\/platforms\/web\/{platformId}": { + "put": { + "summary": "Update project web platform", + "operationId": "projectUpdateWebPlatform", "tags": [ - "sites" + "project" ], - "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", + "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", "responses": { - "201": { - "description": "Variable", + "200": { + "description": "Platform Web", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/platformWeb" } } } @@ -33788,16 +33872,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 850, + "method": "updateWebPlatform", + "group": "platforms", + "weight": 1108, "cookies": false, "type": "", - "demo": "sites\/create-variable.md", + "demo": "project\/update-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33817,12 +33901,12 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -33833,25 +33917,20 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "value": { + "hostname": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "" - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "x-example": false + "description": "Platform web hostname. Max length: 256 chars.", + "x-example": "app.example.com" } }, "required": [ - "key", - "value" + "name", + "hostname" ] } } @@ -33859,21 +33938,21 @@ } } }, - "\/sites\/{siteId}\/variables\/{variableId}": { - "get": { - "summary": "Get variable", - "operationId": "sitesGetVariable", + "\/project\/platforms\/windows": { + "post": { + "summary": "Create project Windows platform", + "operationId": "projectCreateWindowsPlatform", "tags": [ - "sites" + "project" ], - "description": "Get a variable by its unique ID.", + "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Variable", + "201": { + "description": "Platform Windows", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/platformWindows" } } } @@ -33881,16 +33960,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 509, + "method": "createWindowsPlatform", + "group": "platforms", + "weight": 1116, "cookies": false, "type": "", - "demo": "sites\/get-variable.md", + "demo": "project\/create-windows-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33908,43 +33987,54 @@ "Key": [] } ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "variableId", - "description": "Variable unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "x-example": "" + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageIdentifierName" + ] + } + } } - ] - }, + } + } + }, + "\/project\/platforms\/windows\/{platformId}": { "put": { - "summary": "Update variable", - "operationId": "sitesUpdateVariable", + "summary": "Update project Windows platform", + "operationId": "projectUpdateWindowsPlatform", "tags": [ - "sites" + "project" ], - "description": "Update variable by its unique ID.", + "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", "responses": { "200": { - "description": "Variable", + "description": "Platform Windows", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/variable" + "$ref": "#\/components\/schemas\/platformWindows" } } } @@ -33952,16 +34042,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 511, + "method": "updateWindowsPlatform", + "group": "platforms", + "weight": 1111, "cookies": false, "type": "", - "demo": "sites\/update-variable.md", + "demo": "project\/update-windows-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33981,22 +34071,12 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "variableId", - "description": "Variable unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -34007,112 +34087,185 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "description": "Platform name. Max length: 128 chars.", + "x-example": "" }, - "value": { + "packageIdentifierName": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "x-example": "", - "x-nullable": true - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "x-example": false, - "x-nullable": true + "description": "Windows package identifier name. Max length: 256 chars.", + "x-example": "" } }, "required": [ - "key" + "name", + "packageIdentifierName" ] } } } } - }, - "delete": { - "summary": "Delete variable", - "operationId": "sitesDeleteVariable", + } + }, + "\/project\/platforms\/{platformId}": { + "get": { + "summary": "Get project platform", + "operationId": "projectGetPlatform", "tags": [ - "sites" + "project" ], - "description": "Delete a variable by its unique ID.", + "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 512, - "cookies": false, - "type": "", - "demo": "sites\/delete-variable.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", + "200": { + "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "web": "#\/components\/schemas\/platformWeb", + "apple": "#\/components\/schemas\/platformApple", + "android": "#\/components\/schemas\/platformAndroid", + "windows": "#\/components\/schemas\/platformWindows", + "linux": "#\/components\/schemas\/platformLinux" + } + } + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getPlatform", + "group": "platforms", + "weight": 1118, + "cookies": false, + "type": "", + "demo": "project\/get-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, + } + ] + }, + "delete": { + "summary": "Delete project platform", + "operationId": "projectDeletePlatform", + "tags": [ + "project" + ], + "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deletePlatform", + "group": "platforms", + "weight": 1107, + "cookies": false, + "type": "", + "demo": "project\/delete-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "variableId", - "description": "Variable unique ID.", + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/storage\/buckets": { + "\/project\/policies": { "get": { - "summary": "List buckets", - "operationId": "storageListBuckets", + "summary": "List project policies", + "operationId": "projectListPolicies", "tags": [ - "storage" + "project" ], - "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", + "description": "Get a list of all project policies and their current configuration.", "responses": { "200": { - "description": "Buckets List", + "description": "Policies List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/bucketList" + "$ref": "#\/components\/schemas\/policyList" } } } @@ -34120,23 +34273,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listBuckets", - "group": "buckets", - "weight": 558, + "method": "listPolicies", + "group": "policies", + "weight": 1125, "cookies": false, "type": "", - "demo": "storage\/list-buckets.md", + "demo": "project\/list-policies.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "policies.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [], "Key": [] @@ -34151,7 +34303,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "schema": { "type": "array", @@ -34162,17 +34314,6 @@ }, "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -34185,21 +34326,23 @@ "in": "query" } ] - }, - "post": { - "summary": "Create bucket", - "operationId": "storageCreateBucket", + } + }, + "\/project\/policies\/membership-privacy": { + "patch": { + "summary": "Update membership privacy policy", + "operationId": "projectUpdateMembershipPrivacyPolicy", "tags": [ - "storage" + "project" ], - "description": "Create a new storage bucket.", + "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", "responses": { - "201": { - "description": "Bucket", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/bucket" + "$ref": "#\/components\/schemas\/project" } } } @@ -34207,23 +34350,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createBucket", - "group": "buckets", - "weight": 556, + "method": "updateMembershipPrivacyPolicy", + "group": "policies", + "weight": 1127, "cookies": false, "type": "", - "demo": "storage\/create-bucket.md", + "demo": "project\/update-membership-privacy-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "policies.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", "auth": { "Project": [], "Key": [] @@ -34241,102 +34383,53 @@ "schema": { "type": "object", "properties": { - "bucketId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Bucket name", - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "fileSecurity": { + "userId": { "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", "x-example": false }, - "enabled": { + "userEmail": { "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "description": "Set to true if you want make user email visible to all team members, or false to hide it.", "x-example": false }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "encryption": { + "userPhone": { "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", "x-example": false }, - "antivirus": { + "userName": { "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "description": "Set to true if you want make user name visible to all team members, or false to hide it.", "x-example": false }, - "transformations": { + "userMFA": { "type": "boolean", - "description": "Are image transformations enabled?", + "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", "x-example": false } - }, - "required": [ - "bucketId", - "name" - ] + } } } } } } }, - "\/storage\/buckets\/{bucketId}": { - "get": { - "summary": "Get bucket", - "operationId": "storageGetBucket", + "\/project\/policies\/password-dictionary": { + "patch": { + "summary": "Update password dictionary policy", + "operationId": "projectUpdatePasswordDictionaryPolicy", "tags": [ - "storage" + "project" ], - "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", + "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", "responses": { "200": { - "description": "Bucket", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/bucket" + "$ref": "#\/components\/schemas\/project" } } } @@ -34344,23 +34437,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "getBucket", - "group": "buckets", - "weight": 557, + "method": "updatePasswordDictionaryPolicy", + "group": "policies", + "weight": 1128, "cookies": false, "type": "", - "demo": "storage\/get-bucket.md", + "demo": "project\/update-password-dictionary-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "policies.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [], "Key": [] @@ -34372,33 +34464,42 @@ "Key": [] } ], - "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } } - ] - }, - "put": { - "summary": "Update bucket", - "operationId": "storageUpdateBucket", + } + } + }, + "\/project\/policies\/password-history": { + "patch": { + "summary": "Update password history policy", + "operationId": "projectUpdatePasswordHistoryPolicy", "tags": [ - "storage" + "project" ], - "description": "Update a storage bucket by its unique ID.", + "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", "responses": { "200": { - "description": "Bucket", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/bucket" + "$ref": "#\/components\/schemas\/project" } } } @@ -34406,23 +34507,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateBucket", - "group": "buckets", - "weight": 559, + "method": "updatePasswordHistoryPolicy", + "group": "policies", + "weight": 1129, "cookies": false, "type": "", - "demo": "storage\/update-bucket.md", + "demo": "project\/update-password-history-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "policies.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [], "Key": [] @@ -34434,129 +34534,67 @@ "Key": [] } ], - "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Bucket name", - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "x-example": false - }, - "maximumFileSize": { + "total": { "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "x-example": false - }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "x-example": false + "format": "int32", + "x-nullable": true } }, "required": [ - "name" + "total" ] } } } } - }, - "delete": { - "summary": "Delete bucket", - "operationId": "storageDeleteBucket", + } + }, + "\/project\/policies\/password-personal-data": { + "patch": { + "summary": "Update password personal data policy", + "operationId": "projectUpdatePasswordPersonalDataPolicy", "tags": [ - "storage" + "project" ], - "description": "Delete a storage bucket by its unique ID.", + "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteBucket", - "group": "buckets", - "weight": 560, + "method": "updatePasswordPersonalDataPolicy", + "group": "policies", + "weight": 1130, "cookies": false, "type": "", - "demo": "storage\/delete-bucket.md", + "demo": "project\/update-password-personal-data-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "policies.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [], "Key": [] @@ -34568,35 +34606,42 @@ "Key": [] } ], - "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } } - ] + } } }, - "\/storage\/buckets\/{bucketId}\/files": { - "get": { - "summary": "List files", - "operationId": "storageListFiles", + "\/project\/policies\/session-alert": { + "patch": { + "summary": "Update session alert policy", + "operationId": "projectUpdateSessionAlertPolicy", "tags": [ - "storage" + "project" ], - "description": "Get a list of all the user files. You can use the query params to filter your results.", + "description": "Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.", "responses": { "200": { - "description": "Files List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/fileList" + "$ref": "#\/components\/schemas\/project" } } } @@ -34604,100 +34649,69 @@ }, "deprecated": false, "x-appwrite": { - "method": "listFiles", - "group": "files", - "weight": 563, + "method": "updateSessionAlertPolicy", + "group": "policies", + "weight": 1131, "cookies": false, "type": "", - "demo": "storage\/list-files.md", + "demo": "project\/update-session-alert-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "policies.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } } - ] - }, - "post": { - "summary": "Create file", - "operationId": "storageCreateFile", + } + } + }, + "\/project\/policies\/session-duration": { + "patch": { + "summary": "Update session duration policy", + "operationId": "projectUpdateSessionDurationPolicy", "tags": [ - "storage" + "project" ], - "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "description": "Update maximum duration how long sessions created within a project should stay active for.", "responses": { - "201": { - "description": "File", + "200": { + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/project" } } } @@ -34705,81 +34719,48 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFile", - "group": "files", - "weight": 1073, + "method": "updateSessionDurationPolicy", + "group": "policies", + "weight": 1132, "cookies": false, - "type": "upload", - "demo": "storage\/create-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", - "scope": "files.write", + "type": "", + "demo": "project\/update-session-duration-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "policies.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Key": [] } ], "requestBody": { "content": { - "multipart\/form-data": { + "application\/json": { "schema": { "type": "object", "properties": { - "fileId": { - "type": "string", - "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", - "x-upload-id": true - }, - "file": { - "type": "string", - "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "x-example": null, - "format": "binary" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true + "duration": { + "type": "integer", + "description": "Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.", + "x-example": 5, + "format": "int32" } }, "required": [ - "fileId", - "file" + "duration" ] } } @@ -34787,21 +34768,21 @@ } } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "Get file", - "operationId": "storageGetFile", + "\/project\/policies\/session-invalidation": { + "patch": { + "summary": "Update session invalidation policy", + "operationId": "projectUpdateSessionInvalidationPolicy", "tags": [ - "storage" + "project" ], - "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "description": "Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.", "responses": { "200": { - "description": "File", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/project" } } } @@ -34809,75 +34790,69 @@ }, "deprecated": false, "x-appwrite": { - "method": "getFile", - "group": "files", - "weight": 562, + "method": "updateSessionInvalidationPolicy", + "group": "policies", + "weight": 1133, "cookies": false, "type": "", - "demo": "storage\/get-file.md", + "demo": "project\/update-session-invalidation-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "policies.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } } - ] - }, - "put": { - "summary": "Update file", - "operationId": "storageUpdateFile", + } + } + }, + "\/project\/policies\/session-limit": { + "patch": { + "summary": "Update session limit policy", + "operationId": "projectUpdateSessionLimitPolicy", "tags": [ - "storage" + "project" ], - "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", + "description": "Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.", "responses": { "200": { - "description": "File", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/file" + "$ref": "#\/components\/schemas\/project" } } } @@ -34885,58 +34860,31 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFile", - "group": "files", - "weight": 564, + "method": "updateSessionLimitPolicy", + "group": "policies", + "weight": 1134, "cookies": false, "type": "", - "demo": "storage\/update-file.md", + "demo": "project\/update-session-limit-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.write", + "scope": "policies.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Key": [] } ], "requestBody": { @@ -34945,507 +34893,420 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "File name.", - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, + "total": { + "type": "integer", + "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.", + "x-example": 1, + "format": "int32", "x-nullable": true } - } + }, + "required": [ + "total" + ] } } } } - }, - "delete": { - "summary": "Delete file", - "operationId": "storageDeleteFile", + } + }, + "\/project\/policies\/user-limit": { + "patch": { + "summary": "Update user limit policy", + "operationId": "projectUpdateUserLimitPolicy", "tags": [ - "storage" + "project" ], - "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteFile", - "group": "files", - "weight": 565, + "method": "updateUserLimitPolicy", + "group": "policies", + "weight": 1135, "cookies": false, "type": "", - "demo": "storage\/delete-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "files.write", + "demo": "project\/update-user-limit-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "policies.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.", + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } + } } - ] + } } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "\/project\/policies\/{policyId}": { "get": { - "summary": "Get file for download", - "operationId": "storageGetFileDownload", + "summary": "Get project policy", + "operationId": "projectGetPolicy", "tags": [ - "storage" + "project" ], - "description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { "200": { - "description": "File" + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/policyPasswordDictionary" + }, + { + "$ref": "#\/components\/schemas\/policyPasswordHistory" + }, + { + "$ref": "#\/components\/schemas\/policyPasswordPersonalData" + }, + { + "$ref": "#\/components\/schemas\/policySessionAlert" + }, + { + "$ref": "#\/components\/schemas\/policySessionDuration" + }, + { + "$ref": "#\/components\/schemas\/policySessionInvalidation" + }, + { + "$ref": "#\/components\/schemas\/policySessionLimit" + }, + { + "$ref": "#\/components\/schemas\/policyUserLimit" + }, + { + "$ref": "#\/components\/schemas\/policyMembershipPrivacy" + } + ], + "discriminator": { + "propertyName": "$id", + "mapping": { + "password-dictionary": "#\/components\/schemas\/policyPasswordDictionary", + "password-history": "#\/components\/schemas\/policyPasswordHistory", + "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", + "session-alert": "#\/components\/schemas\/policySessionAlert", + "session-duration": "#\/components\/schemas\/policySessionDuration", + "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", + "session-limit": "#\/components\/schemas\/policySessionLimit", + "user-limit": "#\/components\/schemas\/policyUserLimit", + "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy" + } + } + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getFileDownload", - "group": "files", - "weight": 567, + "method": "getPolicy", + "group": "policies", + "weight": 1126, "cookies": false, - "type": "location", - "demo": "storage\/get-file-download.md", + "type": "", + "demo": "project\/get-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "policies.read", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", + "name": "policyId", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "password-dictionary", + "enum": [ + "password-dictionary", + "password-history", + "password-personal-data", + "session-alert", + "session-duration", + "session-invalidation", + "session-limit", + "user-limit", + "membership-privacy" + ], + "x-enum-name": null, + "x-enum-keys": [] }, "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { - "get": { - "summary": "Get file preview", - "operationId": "storageGetFilePreview", + "\/project\/protocols\/{protocolId}": { + "patch": { + "summary": "Update project protocol", + "operationId": "projectUpdateProtocol", "tags": [ - "storage" + "project" ], - "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", + "description": "Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project. ", "responses": { "200": { - "description": "Image" + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getFilePreview", - "group": "files", - "weight": 566, + "method": "updateProtocol", + "group": null, + "weight": 1089, "cookies": false, - "type": "location", - "demo": "storage\/get-file-preview.md", + "type": "", + "demo": "project\/update-protocol.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "project.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID", + "name": "protocolId", + "description": "Protocol name. Can be one of: rest, graphql, websocket", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "width", - "description": "Resize preview image width, Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "height", - "description": "Resize preview image height, Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "gravity", - "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", - "required": false, - "schema": { - "type": "string", - "x-example": "center", - "enum": [ - "center", - "top-left", - "top", - "top-right", - "left", - "right", - "bottom-left", - "bottom", - "bottom-right" - ], - "x-enum-name": "ImageGravity", - "x-enum-keys": [], - "default": "center" - }, - "in": "query" - }, - { - "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1 - }, - "in": "query" - }, - { - "name": "borderWidth", - "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "borderColor", - "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", - "required": false, - "schema": { - "type": "string", - "default": "" - }, - "in": "query" - }, - { - "name": "borderRadius", - "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" - }, - { - "name": "opacity", - "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", - "required": false, - "schema": { - "type": "number", - "format": "float", - "x-example": 0, - "default": 1 - }, - "in": "query" - }, - { - "name": "rotation", - "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": -360, - "default": 0 - }, - "in": "query" - }, - { - "name": "background", - "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", - "required": false, - "schema": { - "type": "string", - "default": "" - }, - "in": "query" - }, - { - "name": "output", - "description": "Output format type (jpeg, jpg, png, gif and webp).", - "required": false, - "schema": { - "type": "string", - "x-example": "jpg", + "x-example": "rest", "enum": [ - "jpg", - "jpeg", - "png", - "webp", - "heic", - "avif", - "gif" + "rest", + "graphql", + "websocket" ], - "x-enum-name": "ImageFormat", - "x-enum-keys": [], - "default": "" - }, - "in": "query" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" + "x-enum-name": null, + "x-enum-keys": [] }, - "in": "query" + "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Protocol status.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { - "get": { - "summary": "Get file for view", - "operationId": "storageGetFileView", + "\/project\/services\/{serviceId}": { + "patch": { + "summary": "Update project service", + "operationId": "projectUpdateService", "tags": [ - "storage" + "project" ], - "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", + "description": "Update properties of a specific service. Use this endpoint to enable or disable a service in your project. ", "responses": { "200": { - "description": "File" + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "getFileView", - "group": "files", - "weight": 568, + "method": "updateService", + "group": null, + "weight": 1090, "cookies": false, - "type": "location", - "demo": "storage\/get-file-view.md", + "type": "", + "demo": "project\/update-service.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "project.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", + "name": "serviceId", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "account", + "enum": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging" + ], + "x-enum-name": null, + "x-enum-keys": [] }, "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Service status.", + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } } }, - "\/tablesdb": { - "get": { - "summary": "List databases", - "operationId": "tablesDBList", + "\/project\/smtp": { + "patch": { + "summary": "Update project SMTP configuration", + "operationId": "projectUpdateSMTP", "tags": [ - "tablesDB" + "project" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.", "responses": { "200": { - "description": "Databases List", + "description": "Project", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/databaseList" + "$ref": "#\/components\/schemas\/project" } } } @@ -35453,23 +35314,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "tablesdb", - "weight": 709, + "method": "updateSMTP", + "group": "smtp", + "weight": 1091, "cookies": false, "type": "", - "demo": "tablesdb\/list.md", + "demo": "project\/update-smtp.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "project.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [], "Key": [] @@ -35481,82 +35341,119 @@ "Key": [] } ], - "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 columns: name", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "host": { + "type": "string", + "description": "SMTP server hostname (domain)", + "x-example": null, + "x-nullable": true + }, + "port": { + "type": "integer", + "description": "SMTP server port", + "x-example": null, + "format": "int32", + "x-nullable": true + }, + "username": { + "type": "string", + "description": "SMTP server username. Leave empty for no authorization.", + "x-example": "", + "x-nullable": true + }, + "password": { + "type": "string", + "description": "SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).", + "x-example": "", + "x-nullable": true + }, + "senderEmail": { + "type": "string", + "description": "Email address shown in inbox as the sender of the email.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "senderName": { + "type": "string", + "description": "Name shown in inbox as the sender of the email.", + "x-example": "", + "x-nullable": true + }, + "replyToEmail": { + "type": "string", + "description": "Email used when user replies to the email.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToName": { + "type": "string", + "description": "Name used when user replies to the email.", + "x-example": "", + "x-nullable": true + }, + "secure": { + "type": "string", + "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", + "x-example": "tls", + "enum": [ + "tls", + "ssl" + ], + "x-enum-name": null, + "x-enum-keys": [], + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", + "x-example": false, + "x-nullable": true + } + } + } + } } - ] - }, + } + } + }, + "\/project\/smtp\/tests": { "post": { - "summary": "Create database", - "operationId": "tablesDBCreate", + "summary": "Create project SMTP test", + "operationId": "projectCreateSMTPTest", "tags": [ - "tablesDB" + "project" ], - "description": "Create a new Database.\n", + "description": "Send a test email to verify SMTP configuration. ", "responses": { - "201": { - "description": "Database", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/database" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "tablesdb", - "weight": 705, + "method": "createSMTPTest", + "group": "smtp", + "weight": 1092, "cookies": false, "type": "", - "demo": "tablesdb\/create.md", + "demo": "project\/create-smtp-test.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "project.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [], "Key": [] @@ -35574,25 +35471,17 @@ "schema": { "type": "object", "properties": { - "databaseId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "x-example": false + "emails": { + "type": "array", + "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "databaseId", - "name" + "emails" ] } } @@ -35600,21 +35489,21 @@ } } }, - "\/tablesdb\/transactions": { + "\/project\/templates\/email": { "get": { - "summary": "List transactions", - "operationId": "tablesDBListTransactions", + "summary": "List project email templates", + "operationId": "projectListEmailTemplates", "tags": [ - "tablesDB" + "project" ], - "description": "List transactions across all databases.", + "description": "Get a list of all custom email templates configured for the project. This endpoint returns an array of all configured email templates and their locales.", "responses": { "200": { - "description": "Transaction List", + "description": "Email Templates List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transactionList" + "$ref": "#\/components\/schemas\/emailTemplateList" } } } @@ -35622,28 +35511,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 776, + "method": "listEmailTemplates", + "group": "templates", + "weight": 1093, "cookies": false, "type": "", - "demo": "tablesdb\/list-transactions.md", + "demo": "project\/list-email-templates.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "scope": "templates.read", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [], "Key": [] @@ -35652,15 +35535,13 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "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).", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "schema": { "type": "array", @@ -35670,23 +35551,34 @@ "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", + "x-example": false, + "default": true + }, + "in": "query" } ] }, - "post": { - "summary": "Create transaction", - "operationId": "tablesDBCreateTransaction", + "patch": { + "summary": "Update project email template", + "operationId": "projectUpdateEmailTemplate", "tags": [ - "tablesDB" + "project" ], - "description": "Create a new transaction.", + "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "EmailTemplate", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/emailTemplate" } } } @@ -35694,28 +35586,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 772, + "method": "updateEmailTemplate", + "group": "templates", + "weight": 1095, "cookies": false, "type": "", - "demo": "tablesdb\/create-transaction.md", + "demo": "project\/update-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "templates.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [], "Key": [] @@ -35724,9 +35610,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "requestBody": { @@ -35735,34 +35619,225 @@ "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "x-example": 60, - "format": "int32" + "templateId": { + "type": "string", + "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", + "x-example": "verification", + "enum": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ], + "x-enum-name": "EmailTemplateType", + "x-enum-keys": [] + }, + "locale": { + "type": "string", + "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "EmailTemplateLocale", + "x-enum-keys": [] + }, + "subject": { + "type": "string", + "description": "Subject of the email template. Can be up to 255 characters.", + "x-example": "", + "x-nullable": true + }, + "message": { + "type": "string", + "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", + "x-example": "", + "x-nullable": true + }, + "senderName": { + "type": "string", + "description": "Name of the email sender.", + "x-example": "", + "x-nullable": true + }, + "senderEmail": { + "type": "string", + "description": "Email of the sender.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToEmail": { + "type": "string", + "description": "Reply to email.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToName": { + "type": "string", + "description": "Reply to name.", + "x-example": "", + "x-nullable": true } - } + }, + "required": [ + "templateId" + ] } } } } } }, - "\/tablesdb\/transactions\/{transactionId}": { + "\/project\/templates\/email\/{templateId}": { "get": { - "summary": "Get transaction", - "operationId": "tablesDBGetTransaction", + "summary": "Get project email template", + "operationId": "projectGetEmailTemplate", "tags": [ - "tablesDB" + "project" ], - "description": "Get a transaction by its unique ID.", + "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.", "responses": { "200": { - "description": "Transaction", + "description": "EmailTemplate", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/emailTemplate" } } } @@ -35770,28 +35845,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 773, + "method": "getEmailTemplate", + "group": "templates", + "weight": 1094, "cookies": false, "type": "", - "demo": "tablesdb\/get-transaction.md", + "demo": "project\/get-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "scope": "templates.read", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [], "Key": [] @@ -35800,38 +35869,195 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "templateId", + "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "verification", + "enum": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ], + "x-enum-name": "EmailTemplateType", + "x-enum-keys": [] }, "in": "path" + }, + { + "name": "locale", + "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", + "required": false, + "schema": { + "type": "string", + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "EmailTemplateLocale", + "x-enum-keys": [], + "default": "" + }, + "in": "query" } ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "tablesDBUpdateTransaction", + } + }, + "\/project\/variables": { + "get": { + "summary": "List project variables", + "operationId": "projectListVariables", "tags": [ - "tablesDB" + "project" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Get a list of all project environment variables.", "responses": { "200": { - "description": "Transaction", + "description": "Variables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/variableList" } } } @@ -35839,28 +36065,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 774, + "method": "listVariables", + "group": "variables", + "weight": 1097, "cookies": false, "type": "", - "demo": "tablesdb\/update-transaction.md", + "demo": "project\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "project.read", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [], "Key": [] @@ -35869,123 +36089,50 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "x-example": false - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete transaction", - "operationId": "tablesDBDeleteTransaction", - "tags": [ - "tablesDB" - ], - "description": "Delete a transaction by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 775, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ + "in": "query" + }, { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "boolean", + "x-example": false, + "default": true }, - "in": "path" + "in": "query" } ] - } - }, - "\/tablesdb\/transactions\/{transactionId}\/operations": { + }, "post": { - "summary": "Create operations", - "operationId": "tablesDBCreateOperations", + "summary": "Create project variable", + "operationId": "projectCreateVariable", "tags": [ - "tablesDB" + "project" ], - "description": "Create multiple operations in a single transaction.", + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", "responses": { "201": { - "description": "Transaction", + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/variable" } } } @@ -35993,28 +36140,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 777, + "method": "createVariable", + "group": "variables", + "weight": 1096, "cookies": false, "type": "", - "demo": "tablesdb\/create-operations.md", + "demo": "project\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "project.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [], "Key": [] @@ -36023,21 +36164,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Key": [] } ], "requestBody": { @@ -36046,36 +36173,53 @@ "schema": { "type": "object", "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "x-example": false } - } + }, + "required": [ + "variableId", + "key", + "value" + ] } } } } } }, - "\/tablesdb\/{databaseId}": { + "\/project\/variables\/{variableId}": { "get": { - "summary": "Get database", - "operationId": "tablesDBGet", + "summary": "Get project variable", + "operationId": "projectGetVariable", "tags": [ - "tablesDB" + "project" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "description": "Get a variable by its unique ID. ", "responses": { "200": { - "description": "Database", + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/variable" } } } @@ -36083,23 +36227,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "tablesdb", - "weight": 706, + "method": "getVariable", + "group": "variables", + "weight": 1098, "cookies": false, "type": "", - "demo": "tablesdb\/get.md", + "demo": "project\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "project.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [], "Key": [] @@ -36113,31 +36256,31 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, "put": { - "summary": "Update database", - "operationId": "tablesDBUpdate", + "summary": "Update project variable", + "operationId": "projectUpdateVariable", "tags": [ - "tablesDB" + "project" ], - "description": "Update a database by its unique ID.", + "description": "Update variable by its unique ID.", "responses": { "200": { - "description": "Database", + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/variable" } } } @@ -36145,23 +36288,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "tablesdb", - "weight": 707, + "method": "updateVariable", + "group": "variables", + "weight": 1100, "cookies": false, "type": "", - "demo": "tablesdb\/update.md", + "demo": "project\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "project.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [], "Key": [] @@ -36175,12 +36317,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -36191,15 +36333,23 @@ "schema": { "type": "object", "properties": { - "name": { + "key": { "type": "string", - "description": "Database name. Max length: 128 chars.", - "x-example": "" + "description": "Variable key. Max length: 255 chars.", + "x-example": "", + "x-nullable": true }, - "enabled": { + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "", + "x-nullable": true + }, + "secret": { "type": "boolean", - "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "x-example": false + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "x-example": false, + "x-nullable": true } } } @@ -36208,12 +36358,12 @@ } }, "delete": { - "summary": "Delete database", - "operationId": "tablesDBDelete", + "summary": "Delete project variable", + "operationId": "projectDeleteVariable", "tags": [ - "tablesDB" + "project" ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "description": "Delete a variable by its unique ID. ", "responses": { "204": { "description": "No content" @@ -36221,23 +36371,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "tablesdb", - "weight": 708, + "method": "deleteVariable", + "group": "variables", + "weight": 1099, "cookies": false, "type": "", - "demo": "tablesdb\/delete.md", + "demo": "project\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "project.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [], "Key": [] @@ -36251,33 +36400,33 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/tablesdb\/{databaseId}\/tables": { + "\/sites": { "get": { - "summary": "List tables", - "operationId": "tablesDBListTables", + "summary": "List sites", + "operationId": "sitesList", "tags": [ - "tablesDB" + "sites" ], - "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "description": "Get a list of all the project's sites. You can use the query params to filter your results.", "responses": { "200": { - "description": "Tables List", + "description": "Sites List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/tableList" + "$ref": "#\/components\/schemas\/siteList" } } } @@ -36285,26 +36434,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTables", - "group": "tables", - "weight": 716, + "method": "list", + "group": "sites", + "weight": 470, "cookies": false, "type": "", - "demo": "tablesdb\/list-tables.md", + "demo": "sites\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [], "Key": [] @@ -36317,19 +36462,9 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name, enabled, rowSecurity", + "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: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", "required": false, "schema": { "type": "array", @@ -36365,19 +36500,19 @@ ] }, "post": { - "summary": "Create table", - "operationId": "tablesDBCreateTable", + "summary": "Create site", + "operationId": "sitesCreate", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new site.", "responses": { "201": { - "description": "Table", + "description": "Site", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/site" } } } @@ -36385,26 +36520,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTable", - "group": "tables", - "weight": 712, + "method": "create", + "group": "sites", + "weight": 903, "cookies": false, "type": "", - "demo": "tablesdb\/create-table.md", + "demo": "sites\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [], "Key": [] @@ -36416,170 +36547,268 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "tableId": { + "siteId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, "name": { "type": "string", - "description": "Table name. Max length: 128 chars.", + "description": "Site name. Max length: 128 chars.", "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true + "framework": { + "type": "string", + "description": "Sites framework.", + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] }, - "rowSecurity": { + "enabled": { "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", "x-example": false }, - "enabled": { + "logging": { "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", "x-example": false }, - "columns": { - "type": "array", - "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", - "x-example": null, - "items": { - "type": "object" - } + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "x-example": 1, + "format": "int32" }, - "indexes": { - "type": "array", - "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", - "x-example": null, - "items": { - "type": "object" - } - } - }, - "required": [ - "tableId", - "name" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}": { - "get": { - "summary": "Get table", - "operationId": "tablesDBGetTable", - "tags": [ - "tablesDB" - ], - "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", - "responses": { - "200": { - "description": "Table", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/table" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getTable", - "group": "tables", - "weight": 713, - "cookies": false, - "type": "", - "demo": "tablesdb\/get-table.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "put": { - "summary": "Update table", - "operationId": "tablesDBUpdateTable", + "installCommand": { + "type": "string", + "description": "Install Command.", + "x-example": "" + }, + "buildCommand": { + "type": "string", + "description": "Build Command.", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { + "type": "string", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "x-example": "static", + "enum": [ + "static", + "ssr" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "x-example": "" + }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "x-example": "" + }, + "providerSilentMode": { + "type": "boolean", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", + "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "siteId", + "name", + "framework", + "buildRuntime" + ] + } + } + } + } + } + }, + "\/sites\/frameworks": { + "get": { + "summary": "List frameworks", + "operationId": "sitesListFrameworks", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a table by its unique ID.", + "description": "Get a list of all frameworks that are currently available on the server instance.", "responses": { "200": { - "description": "Table", + "description": "Frameworks List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/frameworkList" } } } @@ -36587,26 +36816,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTable", - "group": "tables", - "weight": 714, + "method": "listFrameworks", + "group": "frameworks", + "weight": 473, "cookies": false, "type": "", - "demo": "tablesdb\/update-table.md", + "demo": "sites\/list-frameworks.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "public", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [], "Key": [] @@ -36617,104 +36842,47 @@ "Project": [], "Key": [] } + ] + } + }, + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", + "tags": [ + "sites" ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "rowSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", - "x-example": false - }, - "purge": { - "type": "boolean", - "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", - "x-example": false - } + "description": "List allowed site specifications for this instance.", + "responses": { + "200": { + "description": "Specifications List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/specificationList" } } } } - } - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", - "tags": [ - "tablesDB" - ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", - "responses": { - "204": { - "description": "No content" - } }, "deprecated": false, "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 715, + "method": "listSpecifications", + "group": "frameworks", + "weight": 496, "cookies": false, "type": "", - "demo": "tablesdb\/delete-table.md", + "demo": "sites\/list-specifications.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [], "Key": [] @@ -36725,46 +36893,24 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "\/sites\/{siteId}": { "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", + "summary": "Get site", + "operationId": "sitesGet", "tags": [ - "tablesDB" + "sites" ], - "description": "List columns in the table.", + "description": "Get a site by its unique ID.", "responses": { "200": { - "description": "Columns List", + "description": "Site", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnList" + "$ref": "#\/components\/schemas\/site" } } } @@ -36772,26 +36918,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listColumns", - "group": "columns", - "weight": 721, + "method": "get", + "group": "sites", + "weight": 469, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "sites\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [], "Key": [] @@ -36805,67 +36947,31 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", - "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", - "x-example": false, - "default": true - }, - "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { - "post": { - "summary": "Create boolean column", - "operationId": "tablesDBCreateBooleanColumn", + }, + "put": { + "summary": "Update site", + "operationId": "sitesUpdate", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a boolean column.\n", + "description": "Update site by its unique ID.", "responses": { - "202": { - "description": "ColumnBoolean", + "200": { + "description": "Site", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnBoolean" + "$ref": "#\/components\/schemas\/site" } } } @@ -36873,26 +36979,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createBooleanColumn", - "group": "columns", - "weight": 722, + "method": "update", + "group": "sites", + "weight": 904, "cookies": false, "type": "", - "demo": "tablesdb\/create-boolean-column.md", + "demo": "sites\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [], "Key": [] @@ -36906,22 +37008,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -36932,80 +37024,269 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Site name. Max length: 128 chars.", + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "framework": { + "type": "string", + "description": "Sites framework.", + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] }, - "default": { + "enabled": { "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, - "x-nullable": true + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", + "x-example": false }, - "array": { + "logging": { "type": "boolean", - "description": "Is column an array?", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", "x-example": false - } - }, - "required": [ - "key", - "required" + }, + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "x-example": 1, + "format": "int32" + }, + "installCommand": { + "type": "string", + "description": "Install Command.", + "x-example": "" + }, + "buildCommand": { + "type": "string", + "description": "Build Command.", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { + "type": "string", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "x-example": "static", + "enum": [ + "static", + "ssr" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "x-example": "" + }, + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "x-example": "" + }, + "providerSilentMode": { + "type": "boolean", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", + "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "name", + "framework" ] } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { - "patch": { - "summary": "Update boolean column", - "operationId": "tablesDBUpdateBooleanColumn", + }, + "delete": { + "summary": "Delete site", + "operationId": "sitesDelete", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "description": "Delete a site by its unique ID.", "responses": { - "200": { - "description": "ColumnBoolean", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnBoolean" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateBooleanColumn", - "group": "columns", - "weight": 723, + "method": "delete", + "group": "sites", + "weight": 472, "cookies": false, "type": "", - "demo": "tablesdb\/update-boolean-column.md", + "demo": "sites\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [], "Key": [] @@ -37019,84 +37300,33 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { - "post": { - "summary": "Create datetime column", - "operationId": "tablesDBCreateDatetimeColumn", + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a date time column according to the ISO 8601 standard.", + "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", "responses": { - "202": { - "description": "ColumnDatetime", + "200": { + "description": "Site", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnDatetime" + "$ref": "#\/components\/schemas\/site" } } } @@ -37104,26 +37334,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDatetimeColumn", - "group": "columns", - "weight": 724, + "method": "updateSiteDeployment", + "group": "sites", + "weight": 479, "cookies": false, "type": "", - "demo": "tablesdb\/create-datetime-column.md", + "demo": "sites\/update-site-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [], "Key": [] @@ -37137,22 +37363,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -37163,32 +37379,14 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { + "deploymentId": { "type": "string", - "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false + "description": "Deployment ID.", + "x-example": "" } }, "required": [ - "key", - "required" + "deploymentId" ] } } @@ -37196,21 +37394,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { - "patch": { - "summary": "Update dateTime column", - "operationId": "tablesDBUpdateDatetimeColumn", + "\/sites\/{siteId}\/deployments": { + "get": { + "summary": "List deployments", + "operationId": "sitesListDeployments", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", "responses": { "200": { - "description": "ColumnDatetime", + "description": "Deployments List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnDatetime" + "$ref": "#\/components\/schemas\/deploymentList" } } } @@ -37218,26 +37416,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDatetimeColumn", - "group": "columns", - "weight": 725, + "method": "listDeployments", + "group": "deployments", + "weight": 478, "cookies": false, "type": "", - "demo": "tablesdb\/update-datetime-column.md", + "demo": "sites\/list-deployments.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [], "Key": [] @@ -37251,85 +37445,66 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" + "in": "query" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, "schema": { - "type": "string" + "type": "boolean", + "x-example": false, + "default": true }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } + "in": "query" } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { + ] + }, "post": { - "summary": "Create email column", - "operationId": "tablesDBCreateEmailColumn", + "summary": "Create deployment", + "operationId": "sitesCreateDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Create an email column.\n", + "description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.", "responses": { "202": { - "description": "ColumnEmail", + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEmail" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -37337,26 +37512,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createEmailColumn", - "group": "columns", - "weight": 726, + "method": "createDeployment", + "group": "deployments", + "weight": 474, "cookies": false, - "type": "", - "demo": "tablesdb\/create-email-column.md", + "type": "upload", + "demo": "sites\/create-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], - "packaging": false, + "packaging": true, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [], "Key": [] @@ -37370,58 +37541,54 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ], "requestBody": { "content": { - "application\/json": { + "multipart\/form-data": { "schema": { "type": "object", "properties": { - "key": { + "installCommand": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Install Commands.", + "x-example": "", + "x-nullable": true }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "buildCommand": { + "type": "string", + "description": "Build Commands.", + "x-example": "", + "x-nullable": true }, - "default": { + "outputDirectory": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", - "format": "email", + "description": "Output Directory.", + "x-example": "", "x-nullable": true }, - "array": { + "code": { + "type": "string", + "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", + "x-example": null, + "format": "binary" + }, + "activate": { "type": "boolean", - "description": "Is column an array?", + "description": "Automatically activate the deployment when it is finished building.", "x-example": false } }, "required": [ - "key", - "required" + "code" ] } } @@ -37429,21 +37596,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { - "patch": { - "summary": "Update email column", - "operationId": "tablesDBUpdateEmailColumn", + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.", "responses": { - "200": { - "description": "ColumnEmail", + "202": { + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEmail" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -37451,26 +37618,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailColumn", - "group": "columns", - "weight": 727, + "method": "createDuplicateDeployment", + "group": "deployments", + "weight": 482, "cookies": false, "type": "", - "demo": "tablesdb\/update-email-column.md", + "demo": "sites\/create-duplicate-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [], "Key": [] @@ -37484,31 +37647,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } @@ -37519,28 +37663,14 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "newKey": { + "deploymentId": { "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "description": "Deployment ID.", + "x-example": "" } }, "required": [ - "required", - "default" + "deploymentId" ] } } @@ -37548,21 +37678,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "\/sites\/{siteId}\/deployments\/template": { "post": { - "summary": "Create enum column", - "operationId": "tablesDBCreateEnumColumn", + "summary": "Create template deployment", + "operationId": "sitesCreateTemplateDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", "responses": { "202": { - "description": "ColumnEnum", + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEnum" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -37570,26 +37700,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createEnumColumn", - "group": "columns", - "weight": 728, + "method": "createTemplateDeployment", + "group": "deployments", + "weight": 475, "cookies": false, "type": "", - "demo": "tablesdb\/create-enum-column.md", + "demo": "sites\/create-template-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [], "Key": [] @@ -37603,22 +37729,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -37629,40 +37745,50 @@ "schema": { "type": "object", "properties": { - "key": { + "repository": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Repository name of the template.", + "x-example": "" }, - "elements": { - "type": "array", - "description": "Array of enum values.", - "x-example": null, - "items": { - "type": "string" - } + "owner": { + "type": "string", + "description": "The name of the owner of the template.", + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "rootDirectory": { + "type": "string", + "description": "Path to site code in the template repo.", + "x-example": "" }, - "default": { + "type": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true + "description": "Type for the reference provided. Can be commit, branch, or tag", + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [] }, - "array": { + "reference": { + "type": "string", + "description": "Reference value, can be a commit hash, branch name, or release tag", + "x-example": "" + }, + "activate": { "type": "boolean", - "description": "Is column an array?", + "description": "Automatically activate the deployment when it is finished building.", "x-example": false } }, "required": [ - "key", - "elements", - "required" + "repository", + "owner", + "rootDirectory", + "type", + "reference" ] } } @@ -37670,21 +37796,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { - "patch": { - "summary": "Update enum column", - "operationId": "tablesDBUpdateEnumColumn", + "\/sites\/{siteId}\/deployments\/vcs": { + "post": { + "summary": "Create VCS deployment", + "operationId": "sitesCreateVcsDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", "responses": { - "200": { - "description": "ColumnEnum", + "202": { + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEnum" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -37692,26 +37818,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEnumColumn", - "group": "columns", - "weight": 729, + "method": "createVcsDeployment", + "group": "deployments", + "weight": 476, "cookies": false, "type": "", - "demo": "tablesdb\/update-enum-column.md", + "demo": "sites\/create-vcs-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [], "Key": [] @@ -37725,31 +37847,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } @@ -37760,36 +37863,32 @@ "schema": { "type": "object", "properties": { - "elements": { - "type": "array", - "description": "Updated list of enum values.", - "x-example": null, - "items": { - "type": "string" - } - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { + "type": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true + "description": "Type of reference passed. Allowed values are: branch, commit", + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [] }, - "newKey": { + "reference": { "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", + "x-example": "" + }, + "activate": { + "type": "boolean", + "description": "Automatically activate the deployment when it is finished building.", + "x-example": false } }, "required": [ - "elements", - "required", - "default" + "type", + "reference" ] } } @@ -37797,21 +37896,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { - "post": { - "summary": "Create float column", - "operationId": "tablesDBCreateFloatColumn", + "\/sites\/{siteId}\/deployments\/{deploymentId}": { + "get": { + "summary": "Get deployment", + "operationId": "sitesGetDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "description": "Get a site deployment by its unique ID.", "responses": { - "202": { - "description": "ColumnFloat", + "200": { + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnFloat" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -37819,26 +37918,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFloatColumn", - "group": "columns", - "weight": 730, + "method": "getDeployment", + "group": "deployments", + "weight": 477, "cookies": false, "type": "", - "demo": "tablesdb\/create-float-column.md", + "demo": "sites\/get-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [], "Key": [] @@ -37852,121 +37947,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "min": { - "type": "number", - "description": "Minimum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { - "patch": { - "summary": "Update float column", - "operationId": "tablesDBUpdateFloatColumn", + ] + }, + "delete": { + "summary": "Delete deployment", + "operationId": "sitesDeleteDeployment", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "description": "Delete a site deployment by its unique ID.", "responses": { - "200": { - "description": "ColumnFloat", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnFloat" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateFloatColumn", - "group": "columns", - "weight": 731, + "method": "deleteDeployment", + "group": "deployments", + "weight": 480, "cookies": false, "type": "", - "demo": "tablesdb\/update-float-column.md", + "demo": "sites\/delete-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [], "Key": [] @@ -37980,126 +38011,60 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } + ] + } + }, + "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { + "get": { + "summary": "Get deployment download", + "operationId": "sitesGetDeploymentDownload", + "tags": [ + "sites" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "min": { - "type": "number", - "description": "Minimum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { - "post": { - "summary": "Create integer column", - "operationId": "tablesDBCreateIntegerColumn", - "tags": [ - "tablesDB" - ], - "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "responses": { - "202": { - "description": "ColumnInteger", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnInteger" - } - } - } + "200": { + "description": "File" } }, "deprecated": false, "x-appwrite": { - "method": "createIntegerColumn", - "group": "columns", - "weight": 732, + "method": "getDeploymentDownload", + "group": "deployments", + "weight": 481, "cookies": false, - "type": "", - "demo": "tablesdb\/create-integer-column.md", + "type": "location", + "demo": "sites\/get-deployment-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [], "Key": [] @@ -38108,99 +38073,66 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "schema": { + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "min": { - "type": "integer", - "description": "Minimum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { "patch": { - "summary": "Update integer column", - "operationId": "tablesDBUpdateIntegerColumn", + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", "tags": [ - "tablesDB" + "sites" ], - "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", "responses": { "200": { - "description": "ColumnInteger", + "description": "Deployment", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnInteger" + "$ref": "#\/components\/schemas\/deployment" } } } @@ -38208,26 +38140,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateIntegerColumn", - "group": "columns", - "weight": 733, + "method": "updateDeploymentStatus", + "group": "deployments", + "weight": 483, "cookies": false, "type": "", - "demo": "tablesdb\/update-integer-column.md", + "demo": "sites\/update-deployment-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [], "Key": [] @@ -38241,99 +38169,43 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "min": { - "type": "integer", - "description": "Minimum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { - "post": { - "summary": "Create IP address column", - "operationId": "tablesDBCreateIpColumn", + "\/sites\/{siteId}\/logs": { + "get": { + "summary": "List logs", + "operationId": "sitesListLogs", "tags": [ - "tablesDB" + "sites" ], - "description": "Create IP address column.\n", + "description": "Get a list of all site logs. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnIP", + "200": { + "description": "Executions List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIp" + "$ref": "#\/components\/schemas\/executionList" } } } @@ -38341,26 +38213,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIpColumn", - "group": "columns", - "weight": 734, + "method": "listLogs", + "group": "logs", + "weight": 485, "cookies": false, "type": "", - "demo": "tablesdb\/create-ip-column.md", + "demo": "sites\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [], "Key": [] @@ -38374,79 +38242,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { - "patch": { - "summary": "Update IP address column", - "operationId": "tablesDBUpdateIpColumn", + "\/sites\/{siteId}\/logs\/{logId}": { + "get": { + "summary": "Get log", + "operationId": "sitesGetLog", "tags": [ - "tablesDB" + "sites" ], - "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a site request log by its unique ID.", "responses": { "200": { - "description": "ColumnIP", + "description": "Execution", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIp" + "$ref": "#\/components\/schemas\/execution" } } } @@ -38454,26 +38300,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateIpColumn", - "group": "columns", - "weight": 735, + "method": "getLog", + "group": "logs", + "weight": 484, "cookies": false, "type": "", - "demo": "tablesdb\/update-ip-column.md", + "demo": "sites\/get-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [], "Key": [] @@ -38487,111 +38329,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "logId", + "description": "Log ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { - "post": { - "summary": "Create line column", - "operationId": "tablesDBCreateLineColumn", + ] + }, + "delete": { + "summary": "Delete log", + "operationId": "sitesDeleteLog", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a geometric line column.", + "description": "Delete a site log by its unique ID.", "responses": { - "202": { - "description": "ColumnLine", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnLine" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createLineColumn", - "group": "columns", - "weight": 736, + "method": "deleteLog", + "group": "logs", + "weight": 486, "cookies": false, "type": "", - "demo": "tablesdb\/create-line-column.md", + "demo": "sites\/delete-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [], "Key": [] @@ -38605,81 +38393,43 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "logId", + "description": "Log ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } + ] + } + }, + "\/sites\/{siteId}\/variables": { + "get": { + "summary": "List variables", + "operationId": "sitesListVariables", + "tags": [ + "sites" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", - "x-example": "[[1, 2], [3, 4], [5, 6]]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { - "patch": { - "summary": "Update line column", - "operationId": "tablesDBUpdateLineColumn", - "tags": [ - "tablesDB" - ], - "description": "Update a line column. Changing the `default` value will not update already existing rows.", + "description": "Get a list of all variables of a specific site.", "responses": { "200": { - "description": "ColumnLine", + "description": "Variables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLine" + "$ref": "#\/components\/schemas\/variableList" } } } @@ -38687,26 +38437,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLineColumn", - "group": "columns", - "weight": 737, + "method": "listVariables", + "group": "variables", + "weight": 489, "cookies": false, "type": "", - "demo": "tablesdb\/update-line-column.md", + "demo": "sites\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [], "Key": [] @@ -38720,90 +38466,31 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", - "x-example": "[[1, 2], [3, 4], [5, 6]]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + ] + }, "post": { - "summary": "Create longtext column", - "operationId": "tablesDBCreateLongtextColumn", + "summary": "Create variable", + "operationId": "sitesCreateVariable", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a longtext column.\n", + "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", "responses": { - "202": { - "description": "ColumnLongtext", + "201": { + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLongtext" + "$ref": "#\/components\/schemas\/variable" } } } @@ -38811,26 +38498,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLongtextColumn", - "group": "columns", - "weight": 754, + "method": "createVariable", + "group": "variables", + "weight": 905, "cookies": false, "type": "", - "demo": "tablesdb\/create-longtext-column.md", + "demo": "sites\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", "auth": { "Project": [], "Key": [] @@ -38844,22 +38527,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -38872,34 +38545,23 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "description": "Variable key. Max length: 255 chars.", + "x-example": "" }, - "default": { + "value": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false + "description": "Variable value. Max length: 8192 chars.", + "x-example": "" }, - "encrypt": { + "secret": { "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", "x-example": false } }, "required": [ "key", - "required" + "value" ] } } @@ -38907,21 +38569,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { - "patch": { - "summary": "Update longtext column", - "operationId": "tablesDBUpdateLongtextColumn", + "\/sites\/{siteId}\/variables\/{variableId}": { + "get": { + "summary": "Get variable", + "operationId": "sitesGetVariable", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a variable by its unique ID.", "responses": { "200": { - "description": "ColumnLongtext", + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLongtext" + "$ref": "#\/components\/schemas\/variable" } } } @@ -38929,26 +38591,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextColumn", - "group": "columns", - "weight": 755, + "method": "getVariable", + "group": "variables", + "weight": 488, "cookies": false, "type": "", - "demo": "tablesdb\/update-longtext-column.md", + "demo": "sites\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", "auth": { "Project": [], "Key": [] @@ -38962,84 +38620,41 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { - "post": { - "summary": "Create mediumtext column", - "operationId": "tablesDBCreateMediumtextColumn", + ] + }, + "put": { + "summary": "Update variable", + "operationId": "sitesUpdateVariable", "tags": [ - "tablesDB" + "sites" ], - "description": "Create a mediumtext column.\n", + "description": "Update variable by its unique ID.", "responses": { - "202": { - "description": "ColumnMediumtext", + "200": { + "description": "Variable", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnMediumtext" + "$ref": "#\/components\/schemas\/variable" } } } @@ -39047,26 +38662,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createMediumtextColumn", - "group": "columns", - "weight": 752, + "method": "updateVariable", + "group": "variables", + "weight": 490, "cookies": false, "type": "", - "demo": "tablesdb\/create-mediumtext-column.md", + "demo": "sites\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", "auth": { "Project": [], "Key": [] @@ -39080,22 +38691,22 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -39108,83 +38719,60 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "description": "Variable key. Max length: 255 chars.", + "x-example": "" }, - "default": { + "value": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "", "x-nullable": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - }, - "encrypt": { + "secret": { "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "x-example": false + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "x-example": false, + "x-nullable": true } }, "required": [ - "key", - "required" + "key" ] } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { - "patch": { - "summary": "Update mediumtext column", - "operationId": "tablesDBUpdateMediumtextColumn", + }, + "delete": { + "summary": "Delete variable", + "operationId": "sitesDeleteVariable", "tags": [ - "tablesDB" + "sites" ], - "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Delete a variable by its unique ID.", "responses": { - "200": { - "description": "ColumnMediumtext", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnMediumtext" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateMediumtextColumn", - "group": "columns", - "weight": 753, + "method": "deleteVariable", + "group": "variables", + "weight": 491, "cookies": false, "type": "", - "demo": "tablesdb\/update-mediumtext-column.md", + "demo": "sites\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", "auth": { "Project": [], "Key": [] @@ -39198,84 +38786,43 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { - "post": { - "summary": "Create point column", - "operationId": "tablesDBCreatePointColumn", + "\/storage\/buckets": { + "get": { + "summary": "List buckets", + "operationId": "storageListBuckets", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a geometric point column.", + "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnPoint", + "200": { + "description": "Buckets List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPoint" + "$ref": "#\/components\/schemas\/bucketList" } } } @@ -39283,26 +38830,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPointColumn", - "group": "columns", - "weight": 738, + "method": "listBuckets", + "group": "buckets", + "weight": 539, "cookies": false, "type": "", - "demo": "tablesdb\/create-point-column.md", + "demo": "storage\/list-buckets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [], "Key": [] @@ -39316,59 +38860,171 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" + "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", + "x-example": false, + "default": true + }, + "in": "query" } - ], - "requestBody": { + ] + }, + "post": { + "summary": "Create bucket", + "operationId": "storageCreateBucket", + "tags": [ + "storage" + ], + "description": "Create a new storage bucket.", + "responses": { + "201": { + "description": "Bucket", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/bucket" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBucket", + "group": "buckets", + "weight": 537, + "cookies": false, + "type": "", + "demo": "storage\/create-bucket.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "buckets.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "key": { + "bucketId": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "name": { + "type": "string", + "description": "Bucket name", + "x-example": "" }, - "default": { + "permissions": { "type": "array", - "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", - "x-example": "[1, 2]", + "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "string" }, "x-nullable": true + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "x-example": false } }, "required": [ - "key", - "required" + "bucketId", + "name" ] } } @@ -39376,21 +39032,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { - "patch": { - "summary": "Update point column", - "operationId": "tablesDBUpdatePointColumn", + "\/storage\/buckets\/{bucketId}": { + "get": { + "summary": "Get bucket", + "operationId": "storageGetBucket", "tags": [ - "tablesDB" + "storage" ], - "description": "Update a point column. Changing the `default` value will not update already existing rows.", + "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", "responses": { "200": { - "description": "ColumnPoint", + "description": "Bucket", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPoint" + "$ref": "#\/components\/schemas\/bucket" } } } @@ -39398,26 +39054,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePointColumn", - "group": "columns", - "weight": 739, + "method": "getBucket", + "group": "buckets", + "weight": 538, "cookies": false, "type": "", - "demo": "tablesdb\/update-point-column.md", + "demo": "storage\/get-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [], "Key": [] @@ -39431,90 +39084,31 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", - "x-example": "[1, 2]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { - "post": { - "summary": "Create polygon column", - "operationId": "tablesDBCreatePolygonColumn", + ] + }, + "put": { + "summary": "Update bucket", + "operationId": "storageUpdateBucket", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a geometric polygon column.", + "description": "Update a storage bucket by its unique ID.", "responses": { - "202": { - "description": "ColumnPolygon", + "200": { + "description": "Bucket", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPolygon" + "$ref": "#\/components\/schemas\/bucket" } } } @@ -39522,26 +39116,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPolygonColumn", - "group": "columns", - "weight": 740, + "method": "updateBucket", + "group": "buckets", + "weight": 540, "cookies": false, "type": "", - "demo": "tablesdb\/create-polygon-column.md", + "demo": "storage\/update-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [], "Key": [] @@ -39555,22 +39146,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -39581,82 +39162,111 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Bucket name", + "x-example": "" }, - "required": { + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "fileSecurity": { "type": "boolean", - "description": "Is column required?", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": false }, - "default": { + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { "type": "array", - "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "x-example": null, "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "x-example": false } }, "required": [ - "key", - "required" + "name" ] } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { - "patch": { - "summary": "Update polygon column", - "operationId": "tablesDBUpdatePolygonColumn", + }, + "delete": { + "summary": "Delete bucket", + "operationId": "storageDeleteBucket", "tags": [ - "tablesDB" + "storage" ], - "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", + "description": "Delete a storage bucket by its unique ID.", "responses": { - "200": { - "description": "ColumnPolygon", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnPolygon" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updatePolygonColumn", - "group": "columns", - "weight": 741, + "method": "deleteBucket", + "group": "buckets", + "weight": 541, "cookies": false, "type": "", - "demo": "tablesdb\/update-polygon-column.md", + "demo": "storage\/delete-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [], "Key": [] @@ -39670,90 +39280,33 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { - "post": { - "summary": "Create relationship column", - "operationId": "tablesDBCreateRelationshipColumn", + "\/storage\/buckets\/{bucketId}\/files": { + "get": { + "summary": "List files", + "operationId": "storageListFiles", "tags": [ - "tablesDB" + "storage" ], - "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Get a list of all the user files. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnRelationship", + "200": { + "description": "Files List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnRelationship" + "$ref": "#\/components\/schemas\/fileList" } } } @@ -39761,245 +39314,182 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRelationshipColumn", - "group": "columns", - "weight": 742, + "method": "listFiles", + "group": "files", + "weight": 544, "cookies": false, "type": "", - "demo": "tablesdb\/create-relationship-column.md", + "demo": "storage\/list-files.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "relatedTableId": { - "type": "string", - "description": "Related Table ID.", - "x-example": "" - }, - "type": { - "type": "string", - "description": "Relation type", - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] - }, - "twoWay": { - "type": "boolean", - "description": "Is Two Way?", - "x-example": false - }, - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null, - "x-nullable": true - }, - "twoWayKey": { - "type": "string", - "description": "Two Way Column Key.", - "x-example": null, - "x-nullable": true - }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] - } - }, - "required": [ - "relatedTableId", - "type" - ] - } - } + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { + ] + }, "post": { - "summary": "Create string column", - "operationId": "tablesDBCreateStringColumn", + "summary": "Create file", + "operationId": "storageCreateFile", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a string column.\n", + "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", "responses": { - "202": { - "description": "ColumnString", + "201": { + "description": "File", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnString" + "$ref": "#\/components\/schemas\/file" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createStringColumn", - "group": "columns", - "weight": 744, + "method": "createFile", + "group": "files", + "weight": 1186, "cookies": false, - "type": "", - "demo": "tablesdb\/create-string-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "type": "upload", + "demo": "storage\/create-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", + "scope": "files.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", - "deprecated": { - "since": "1.9.0", - "replaceWith": "tablesDB.createTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ], "requestBody": { "content": { - "application\/json": { + "multipart\/form-data": { "schema": { "type": "object", "properties": { - "key": { + "fileId": { "type": "string", - "description": "Column Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for text columns, in number of characters.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "", + "x-upload-id": true }, - "default": { + "file": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false + "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", + "x-example": null, + "format": "binary" }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "x-example": false + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true } }, "required": [ - "key", - "size", - "required" + "fileId", + "file" ] } } @@ -40007,150 +39497,97 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { - "patch": { - "summary": "Update string column", - "operationId": "tablesDBUpdateStringColumn", + "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "get": { + "summary": "Get file", + "operationId": "storageGetFile", "tags": [ - "tablesDB" + "storage" ], - "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", "responses": { "200": { - "description": "ColumnString", + "description": "File", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnString" + "$ref": "#\/components\/schemas\/file" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateStringColumn", - "group": "columns", - "weight": 745, + "method": "getFile", + "group": "files", + "weight": 543, "cookies": false, "type": "", - "demo": "tablesdb\/update-string-column.md", + "demo": "storage\/get-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string column.", - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { - "post": { - "summary": "Create text column", - "operationId": "tablesDBCreateTextColumn", + ] + }, + "put": { + "summary": "Update file", + "operationId": "storageUpdateFile", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a text column.\n", + "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", "responses": { - "202": { - "description": "ColumnText", + "200": { + "description": "File", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnText" + "$ref": "#\/components\/schemas\/file" } } } @@ -40158,55 +39595,56 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTextColumn", - "group": "columns", - "weight": 750, + "method": "updateFile", + "group": "files", + "weight": 545, "cookies": false, "type": "", - "demo": "tablesdb\/create-text-column.md", + "demo": "storage\/update-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -40217,409 +39655,507 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false + "description": "File name.", + "x-example": "" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "x-example": false } - }, - "required": [ - "key", - "required" - ] + } } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { - "patch": { - "summary": "Update text column", - "operationId": "tablesDBUpdateTextColumn", + }, + "delete": { + "summary": "Delete file", + "operationId": "storageDeleteFile", "tags": [ - "tablesDB" + "storage" ], - "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", + "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "200": { - "description": "ColumnText", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnText" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateTextColumn", - "group": "columns", - "weight": 751, + "method": "deleteFile", + "group": "files", + "weight": 546, "cookies": false, "type": "", - "demo": "tablesdb\/update-text-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "demo": "storage\/delete-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "files.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "get": { + "summary": "Get file for download", + "operationId": "storageGetFileDownload", + "tags": [ + "storage" ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } + "description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "responses": { + "200": { + "description": "File" } - } + }, + "deprecated": false, + "x-appwrite": { + "method": "getFileDownload", + "group": "files", + "weight": 548, + "cookies": false, + "type": "location", + "demo": "storage\/get-file-download.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "files.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { - "post": { - "summary": "Create URL column", - "operationId": "tablesDBCreateUrlColumn", + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { + "get": { + "summary": "Get file preview", + "operationId": "storageGetFilePreview", "tags": [ - "tablesDB" + "storage" ], - "description": "Create a URL column.\n", + "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { - "202": { - "description": "ColumnURL", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnUrl" - } - } - } + "200": { + "description": "Image" } }, "deprecated": false, "x-appwrite": { - "method": "createUrlColumn", - "group": "columns", - "weight": 746, + "method": "getFilePreview", + "group": "files", + "weight": 547, "cookies": false, - "type": "", - "demo": "tablesdb\/create-url-column.md", + "type": "location", + "demo": "storage\/get-file-preview.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" + }, + { + "name": "width", + "description": "Resize preview image width, Pass an integer between 0 to 4000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "height", + "description": "Resize preview image height, Pass an integer between 0 to 4000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "gravity", + "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", + "required": false, + "schema": { + "type": "string", + "x-example": "center", + "enum": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], + "x-enum-name": "ImageGravity", + "x-enum-keys": [], + "default": "center" + }, + "in": "query" + }, + { + "name": "quality", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1 + }, + "in": "query" + }, + { + "name": "borderWidth", + "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "borderColor", + "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", + "required": false, + "schema": { + "type": "string", + "default": "" + }, + "in": "query" + }, + { + "name": "borderRadius", + "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + }, + { + "name": "opacity", + "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", + "required": false, + "schema": { + "type": "number", + "format": "float", + "x-example": 0, + "default": 1 + }, + "in": "query" + }, + { + "name": "rotation", + "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": -360, + "default": 0 + }, + "in": "query" + }, + { + "name": "background", + "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", + "required": false, + "schema": { + "type": "string", + "default": "" + }, + "in": "query" + }, + { + "name": "output", + "description": "Output format type (jpeg, jpg, png, gif and webp).", + "required": false, + "schema": { + "type": "string", + "x-example": "jpg", + "enum": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ], + "x-enum-name": "ImageFormat", + "x-enum-keys": [], + "default": "" + }, + "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { - "patch": { - "summary": "Update URL column", - "operationId": "tablesDBUpdateUrlColumn", + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { + "get": { + "summary": "Get file for view", + "operationId": "storageGetFileView", "tags": [ - "tablesDB" + "storage" ], - "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { "200": { - "description": "ColumnURL", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnUrl" - } - } - } + "description": "File" } }, "deprecated": false, "x-appwrite": { - "method": "updateUrlColumn", - "group": "columns", - "weight": 747, + "method": "getFileView", + "group": "files", + "weight": 549, "cookies": false, - "type": "", - "demo": "tablesdb\/update-url-column.md", + "type": "location", + "demo": "storage\/get-file-view.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "token", + "description": "File token for accessing this file.", + "required": false, "schema": { - "type": "string" + "type": "string", + "x-example": "", + "default": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { - "post": { - "summary": "Create varchar column", - "operationId": "tablesDBCreateVarcharColumn", + "\/tablesdb": { + "get": { + "summary": "List databases", + "operationId": "tablesDBList", "tags": [ "tablesDB" ], - "description": "Create a varchar column.\n", + "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", "responses": { - "202": { - "description": "ColumnVarchar", + "200": { + "description": "Databases List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnVarchar" + "$ref": "#\/components\/schemas\/databaseList" } } } @@ -40627,26 +40163,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVarcharColumn", - "group": "columns", - "weight": 748, + "method": "list", + "group": "tablesdb", + "weight": 761, "cookies": false, "type": "", - "demo": "tablesdb\/create-varchar-column.md", + "demo": "tablesdb\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [], "Key": [] @@ -40660,91 +40193,56 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } - } + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { - "patch": { - "summary": "Update varchar column", - "operationId": "tablesDBUpdateVarcharColumn", + ] + }, + "post": { + "summary": "Create database", + "operationId": "tablesDBCreate", "tags": [ "tablesDB" ], - "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a new Database.\n", "responses": { - "200": { - "description": "ColumnVarchar", + "201": { + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnVarchar" + "$ref": "#\/components\/schemas\/database" } } } @@ -40752,26 +40250,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateVarcharColumn", - "group": "columns", - "weight": 749, + "method": "create", + "group": "tablesdb", + "weight": 757, "cookies": false, "type": "", - "demo": "tablesdb\/update-varchar-column.md", + "demo": "tablesdb\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [], "Key": [] @@ -40783,71 +40278,31 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { + "databaseId": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar column.", - "x-example": 1, - "format": "int32", - "x-nullable": true + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "newKey": { + "name": { "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false } }, "required": [ - "required", - "default" + "databaseId", + "name" ] } } @@ -40855,103 +40310,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "\/tablesdb\/transactions": { "get": { - "summary": "Get column", - "operationId": "tablesDBGetColumn", + "summary": "List transactions", + "operationId": "tablesDBListTransactions", "tags": [ "tablesDB" ], - "description": "Get column by ID.", + "description": "List transactions across all databases.", "responses": { "200": { - "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "description": "Transaction List", "content": { "application\/json": { "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/columnBoolean" - }, - { - "$ref": "#\/components\/schemas\/columnInteger" - }, - { - "$ref": "#\/components\/schemas\/columnFloat" - }, - { - "$ref": "#\/components\/schemas\/columnEmail" - }, - { - "$ref": "#\/components\/schemas\/columnEnum" - }, - { - "$ref": "#\/components\/schemas\/columnUrl" - }, - { - "$ref": "#\/components\/schemas\/columnIp" - }, - { - "$ref": "#\/components\/schemas\/columnDatetime" - }, - { - "$ref": "#\/components\/schemas\/columnRelationship" - }, - { - "$ref": "#\/components\/schemas\/columnString" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/components\/schemas\/columnBoolean", - "integer": "#\/components\/schemas\/columnInteger", - "double": "#\/components\/schemas\/columnFloat", - "string": "#\/components\/schemas\/columnString", - "datetime": "#\/components\/schemas\/columnDatetime", - "relationship": "#\/components\/schemas\/columnRelationship" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/components\/schemas\/columnBoolean": { - "type": "boolean" - }, - "#\/components\/schemas\/columnInteger": { - "type": "integer" - }, - "#\/components\/schemas\/columnFloat": { - "type": "double" - }, - "#\/components\/schemas\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/components\/schemas\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/components\/schemas\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/components\/schemas\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/components\/schemas\/columnDatetime": { - "type": "datetime" - }, - "#\/components\/schemas\/columnRelationship": { - "type": "relationship" - }, - "#\/components\/schemas\/columnString": { - "type": "string" - } - } - } + "$ref": "#\/components\/schemas\/transactionList" } } } @@ -40959,26 +40332,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "getColumn", - "group": "columns", - "weight": 719, + "method": "listTransactions", + "group": "transactions", + "weight": 828, "cookies": false, "type": "", - "demo": "tablesdb\/get-column.md", + "demo": "tablesdb\/list-transactions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [], "Key": [] @@ -40987,75 +40362,70 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", + "required": false, "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" } ] }, - "delete": { - "summary": "Delete column", - "operationId": "tablesDBDeleteColumn", + "post": { + "summary": "Create transaction", + "operationId": "tablesDBCreateTransaction", "tags": [ "tablesDB" ], - "description": "Deletes a column.", + "description": "Create a new transaction.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteColumn", - "group": "columns", - "weight": 720, + "method": "createTransaction", + "group": "transactions", + "weight": 824, "cookies": false, "type": "", - "demo": "tablesdb\/delete-column.md", + "demo": "tablesdb\/create-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [], "Key": [] @@ -41064,57 +40434,45 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "x-example": 60, + "format": "int32" + } + } + } + } } - ] + } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { - "patch": { - "summary": "Update relationship column", - "operationId": "tablesDBUpdateRelationshipColumn", + "\/tablesdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "tablesDBGetTransaction", "tags": [ "tablesDB" ], - "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "ColumnRelationship", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnRelationship" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -41122,26 +40480,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRelationshipColumn", - "group": "columns", - "weight": 743, + "method": "getTransaction", + "group": "transactions", + "weight": 825, "cookies": false, "type": "", - "demo": "tablesdb\/update-relationship-column.md", + "demo": "tablesdb\/get-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.read", + "rows.read" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [], "Key": [] @@ -41150,87 +40510,38 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, - "x-nullable": true - } - } - } - } - } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": { - "get": { - "summary": "List indexes", - "operationId": "tablesDBListIndexes", + ] + }, + "patch": { + "summary": "Update transaction", + "operationId": "tablesDBUpdateTransaction", "tags": [ "tablesDB" ], - "description": "List indexes on the table.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { "200": { - "description": "Column Indexes List", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIndexList" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -41238,26 +40549,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 759, + "method": "updateTransaction", + "group": "transactions", + "weight": 826, "cookies": false, "type": "", - "demo": "tablesdb\/list-indexes.md", + "demo": "tablesdb\/update-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" - ], + "documents.write", + "rows.write" + ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [], "Key": [] @@ -41266,70 +40579,123 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "x-example": false + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete transaction", + "operationId": "tablesDBDeleteTransaction", + "tags": [ + "tablesDB" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 827, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "documents.write", + "rows.write" + ], + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, status, attributes, error", - "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", - "x-example": false, - "default": true - }, - "in": "query" } ] - }, + } + }, + "\/tablesdb\/transactions\/{transactionId}\/operations": { "post": { - "summary": "Create index", - "operationId": "tablesDBCreateIndex", + "summary": "Create operations", + "operationId": "tablesDBCreateOperations", "tags": [ "tablesDB" ], - "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.", + "description": "Create multiple operations in a single transaction.", "responses": { - "202": { - "description": "Index", + "201": { + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIndex" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -41337,26 +40703,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 756, + "method": "createOperations", + "group": "transactions", + "weight": 829, "cookies": false, "type": "", - "demo": "tablesdb\/create-index.md", + "demo": "tablesdb\/create-operations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [], "Key": [] @@ -41365,27 +40733,19 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -41396,81 +40756,36 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Index Key.", - "x-example": null - }, - "type": { - "type": "string", - "description": "Index type.", - "x-example": "key", - "enum": [ - "key", - "fulltext", - "unique", - "spatial" - ], - "x-enum-name": "TablesDBIndexType", - "x-enum-keys": [] - }, - "columns": { - "type": "array", - "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } - }, - "lengths": { + "operations": { "type": "array", - "description": "Length of index. Maximum of 100", - "x-example": null, + "description": "Array of staged operations.", + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", "items": { - "type": "integer" + "type": "object" } } - }, - "required": [ - "key", - "type", - "columns" - ] + } } } } } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "\/tablesdb\/{databaseId}": { "get": { - "summary": "Get index", - "operationId": "tablesDBGetIndex", + "summary": "Get database", + "operationId": "tablesDBGet", "tags": [ "tablesDB" ], - "description": "Get index by ID.", + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", "responses": { "200": { - "description": "Index", + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIndex" + "$ref": "#\/components\/schemas\/database" } } } @@ -41478,26 +40793,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 757, + "method": "get", + "group": "tablesdb", + "weight": 758, "cookies": false, "type": "", - "demo": "tablesdb\/get-index.md", + "demo": "tablesdb\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [], "Key": [] @@ -41519,35 +40831,99 @@ "x-example": "" }, "in": "path" - }, + } + ] + }, + "put": { + "summary": "Update database", + "operationId": "tablesDBUpdate", + "tags": [ + "tablesDB" + ], + "description": "Update a database by its unique ID.", + "responses": { + "200": { + "description": "Database", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/database" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": "tablesdb", + "weight": 759, + "cookies": false, + "type": "", + "demo": "tablesdb\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, + "Project": [], + "Key": [] + } + ], + "parameters": [ { - "name": "key", - "description": "Index Key.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false + } + } + } + } + } + } }, "delete": { - "summary": "Delete index", - "operationId": "tablesDBDeleteIndex", + "summary": "Delete database", + "operationId": "tablesDBDelete", "tags": [ "tablesDB" ], - "description": "Delete an index.", + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", "responses": { "204": { "description": "No content" @@ -41555,26 +40931,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 758, + "method": "delete", + "group": "tablesdb", + "weight": 760, "cookies": false, "type": "", - "demo": "tablesdb\/delete-index.md", + "demo": "tablesdb\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [], "Key": [] @@ -41596,44 +40969,25 @@ "x-example": "" }, "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": { + "\/tablesdb\/{databaseId}\/tables": { "get": { - "summary": "List rows", - "operationId": "tablesDBListRows", + "summary": "List tables", + "operationId": "tablesDBListTables", "tags": [ "tablesDB" ], - "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", "responses": { "200": { - "description": "Rows List", + "description": "Tables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/rowList" + "$ref": "#\/components\/schemas\/tableList" } } } @@ -41641,39 +40995,35 @@ }, "deprecated": false, "x-appwrite": { - "method": "listRows", - "group": "rows", + "method": "listTables", + "group": "tables", "weight": 768, "cookies": false, "type": "", - "demo": "tablesdb\/list-rows.md", + "demo": "tablesdb\/list-tables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "tables.read", + "collections.read" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -41687,19 +41037,9 @@ }, "in": "path" }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "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 columns: name, enabled, rowSecurity", "required": false, "schema": { "type": "array", @@ -41711,12 +41051,13 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, "in": "query" }, @@ -41730,35 +41071,23 @@ "default": true }, "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" } ] }, "post": { - "summary": "Create row", - "operationId": "tablesDBCreateRow", + "summary": "Create table", + "operationId": "tablesDBCreateTable", "tags": [ "tablesDB" ], - "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { "201": { - "description": "Row", + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/table" } } } @@ -41766,102 +41095,35 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRow", - "group": "rows", - "weight": 760, + "method": "createTable", + "group": "tables", + "weight": 764, "cookies": false, "type": "", - "demo": "tablesdb\/create-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md", - "methods": [ - { - "name": "createRow", - "namespace": "tablesDB", - "desc": "Create row", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rowId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rowId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/row" - } - ], - "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/create-row.md", - "public": true - }, - { - "name": "createRows", - "namespace": "tablesDB", - "desc": "Create rows", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rows", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rows" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/rowList" - } - ], - "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/create-rows.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -41874,16 +41136,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -41892,59 +41144,77 @@ "schema": { "type": "object", "properties": { - "rowId": { + "tableId": { "type": "string", - "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "data": { - "type": "object", - "description": "Row data as JSON object.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": "[\"read(\"any\")\"]", "items": { "type": "string" }, "x-nullable": true }, - "rows": { + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + }, + "columns": { "type": "array", - "description": "Array of rows data as JSON objects.", + "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "x-example": null, "items": { "type": "object" } }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "indexes": { + "type": "array", + "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "x-example": null, + "items": { + "type": "object" + } } - } + }, + "required": [ + "tableId", + "name" + ] } } } } - }, - "put": { - "summary": "Upsert rows", - "operationId": "tablesDBUpsertRows", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesDBGetTable", "tags": [ "tablesDB" ], - "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", "responses": { - "201": { - "description": "Rows List", + "200": { + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/rowList" + "$ref": "#\/components\/schemas\/table" } } } @@ -41952,18 +41222,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "upsertRows", - "group": "rows", + "method": "getTable", + "group": "tables", "weight": 765, "cookies": false, "type": "", - "demo": "tablesdb\/upsert-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -41971,38 +41241,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md", - "methods": [ - { - "name": "upsertRows", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rows", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rows" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/rowList" - } - ], - "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", - "demo": "tablesdb\/upsert-rows.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [], "Key": [] @@ -42035,50 +41274,22 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "rows": { - "type": "array", - "description": "Array of row data as JSON objects. May contain partial rows.", - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - }, - "required": [ - "rows" - ] - } - } - } - } + ] }, - "patch": { - "summary": "Update rows", - "operationId": "tablesDBUpdateRows", + "put": { + "summary": "Update table", + "operationId": "tablesDBUpdateTable", "tags": [ "tablesDB" ], - "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "description": "Update a table by its unique ID.", "responses": { "200": { - "description": "Rows List", + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/rowList" + "$ref": "#\/components\/schemas\/table" } } } @@ -42086,18 +41297,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRows", - "group": "rows", - "weight": 763, + "method": "updateTable", + "group": "tables", + "weight": 766, "cookies": false, "type": "", - "demo": "tablesdb\/update-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", @@ -42105,7 +41316,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [], "Key": [] @@ -42145,24 +41356,34 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only column and value pairs to be updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "x-example": "" }, - "queries": { + "permissions": { "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "x-example": null, + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", "items": { "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", + }, "x-nullable": true + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "x-example": false } } } @@ -42171,38 +41392,31 @@ } }, "delete": { - "summary": "Delete rows", - "operationId": "tablesDBDeleteRows", + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", "tags": [ "tablesDB" ], - "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "200": { - "description": "Rows List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/rowList" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "deleteRows", - "group": "rows", + "method": "deleteTable", + "group": "tables", "weight": 767, "cookies": false, "type": "", - "demo": "tablesdb\/delete-rows.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", @@ -42210,7 +41424,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [], "Key": [] @@ -42235,7 +41449,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -42243,49 +41457,24 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { "get": { - "summary": "Get row", - "operationId": "tablesDBGetRow", + "summary": "List columns", + "operationId": "tablesDBListColumns", "tags": [ "tablesDB" ], - "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "description": "List columns in the table.", "responses": { "200": { - "description": "Row", + "description": "Columns List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/columnList" } } } @@ -42293,39 +41482,37 @@ }, "deprecated": false, "x-appwrite": { - "method": "getRow", - "group": "rows", - "weight": 761, + "method": "listColumns", + "group": "columns", + "weight": 773, "cookies": false, "type": "", - "demo": "tablesdb\/get-row.md", + "demo": "tablesdb\/list-columns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "tables.read", + "collections.read", + "columns.read", + "attributes.read" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -42341,7 +41528,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -42349,19 +41536,9 @@ }, "in": "path" }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "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 columns: key, type, size, required, array, status, error", "required": false, "schema": { "type": "array", @@ -42373,31 +41550,34 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "boolean", + "x-example": false, + "default": true }, "in": "query" } ] - }, - "put": { - "summary": "Upsert a row", - "operationId": "tablesDBUpsertRow", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesDBCreateBooleanColumn", "tags": [ "tablesDB" ], - "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a boolean column.\n", "responses": { - "201": { - "description": "Row", + "202": { + "description": "ColumnBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/columnBoolean" } } } @@ -42405,72 +41585,37 @@ }, "deprecated": false, "x-appwrite": { - "method": "upsertRow", - "group": "rows", - "weight": 764, + "method": "createBooleanColumn", + "group": "columns", + "weight": 774, "cookies": false, "type": "", - "demo": "tablesdb\/upsert-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md", - "methods": [ - { - "name": "upsertRow", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rowId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rowId" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/row" - } - ], - "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/upsert-row.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -42486,23 +41631,13 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -42511,46 +41646,53 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } } } - }, + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { "patch": { - "summary": "Update row", - "operationId": "tablesDBUpdateRow", + "summary": "Update boolean column", + "operationId": "tablesDBUpdateBooleanColumn", "tags": [ "tablesDB" ], - "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Row", + "description": "ColumnBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/columnBoolean" } } } @@ -42558,39 +41700,37 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRow", - "group": "rows", - "weight": 762, + "method": "updateBooleanColumn", + "group": "columns", + "weight": 775, "cookies": false, "type": "", - "demo": "tablesdb\/update-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -42606,7 +41746,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -42615,12 +41755,11 @@ "in": "path" }, { - "name": "rowId", - "description": "Row ID.", + "name": "key", + "description": "Column Key.", "required": true, "schema": { - "type": "string", - "x-example": "" + "type": "string" }, "in": "path" } @@ -42631,79 +41770,87 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only columns and value pairs to be updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, "x-nullable": true }, - "transactionId": { + "newKey": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", + "description": "New Column Key.", + "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } } } - }, - "delete": { - "summary": "Delete row", - "operationId": "tablesDBDeleteRow", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesDBCreateDatetimeColumn", "tags": [ "tablesDB" ], - "description": "Delete a row by its unique ID.", + "description": "Create a date time column according to the ISO 8601 standard.", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnDatetime", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnDatetime" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteRow", - "group": "rows", - "weight": 766, + "method": "createDatetimeColumn", + "group": "columns", + "weight": 776, "cookies": false, "type": "", - "demo": "tablesdb\/delete-row.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -42719,23 +41866,13 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -42744,34 +41881,54 @@ "schema": { "type": "object", "properties": { - "transactionId": { + "key": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } } } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Decrement row column", - "operationId": "tablesDBDecrementRowColumn", + "summary": "Update dateTime column", + "operationId": "tablesDBUpdateDatetimeColumn", "tags": [ "tablesDB" ], - "description": "Decrement a specific column of a row by a given value.", + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Row", + "description": "ColumnDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/columnDatetime" } } } @@ -42779,38 +41936,36 @@ }, "deprecated": false, "x-appwrite": { - "method": "decrementRowColumn", - "group": "rows", - "weight": 771, + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 777, "cookies": false, "type": "", - "demo": "tablesdb\/decrement-row-column.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "client", - "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [], "Key": [] } ], @@ -42836,18 +41991,8 @@ "in": "path" }, { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "column", - "description": "Column key.", + "name": "key", + "description": "Column Key.", "required": true, "schema": { "type": "string" @@ -42861,47 +42006,50 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the column by. The value must be a number.", - "x-example": null, - "format": "float" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, - "format": "float", + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true }, - "transactionId": { + "newKey": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", + "description": "New Column Key.", + "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } } } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { - "patch": { - "summary": "Increment row column", - "operationId": "tablesDBIncrementRowColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesDBCreateEmailColumn", "tags": [ "tablesDB" ], - "description": "Increment a specific column of a row by a given value.", + "description": "Create an email column.\n", "responses": { - "200": { - "description": "Row", + "202": { + "description": "ColumnEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/row" + "$ref": "#\/components\/schemas\/columnEmail" } } } @@ -42909,38 +42057,36 @@ }, "deprecated": false, "x-appwrite": { - "method": "incrementRowColumn", - "group": "rows", - "weight": 770, + "method": "createEmailColumn", + "group": "columns", + "weight": 778, "cookies": false, "type": "", - "demo": "tablesdb\/increment-row-column.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "client", - "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [], "Key": [] } ], @@ -42964,25 +42110,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "column", - "description": "Column key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -42991,47 +42118,54 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the column by. The value must be a number.", - "x-example": null, - "format": "float" + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null }, - "max": { - "type": "number", - "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "transactionId": { + "default": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "format": "email", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } } } } }, - "\/teams": { - "get": { - "summary": "List teams", - "operationId": "teamsList", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesDBUpdateEmailColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.", + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Teams List", + "description": "ColumnEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/teamList" + "$ref": "#\/components\/schemas\/columnEmail" } } } @@ -43039,90 +42173,120 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "teams", - "weight": 539, + "method": "updateEmailColumn", + "group": "columns", + "weight": 779, "cookies": false, "type": "", - "demo": "teams\/list.md", + "demo": "tablesdb\/update-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "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: name, total, billingPlan", - "required": false, + "name": "databaseId", + "description": "Database ID.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { "post": { - "summary": "Create team", - "operationId": "teamsCreate", + "summary": "Create enum column", + "operationId": "tablesDBCreateEnumColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.", + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", "responses": { - "201": { - "description": "Team", + "202": { + "description": "ColumnEnum", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/team" + "$ref": "#\/components\/schemas\/columnEnum" } } } @@ -43130,66 +42294,101 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "teams", - "weight": 537, + "method": "createEnumColumn", + "group": "columns", + "weight": 780, "cookies": false, "type": "", - "demo": "teams\/create.md", + "demo": "tablesdb\/create-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "teamId": { - "type": "string", - "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Team name. Max length: 128 chars.", - "x-example": "" + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null }, - "roles": { + "elements": { "type": "array", - "description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "description": "Array of enum values.", "x-example": null, "items": { "type": "string" } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ - "teamId", - "name" + "key", + "elements", + "required" ] } } @@ -43197,21 +42396,21 @@ } } }, - "\/teams\/{teamId}": { - "get": { - "summary": "Get team", - "operationId": "teamsGet", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesDBUpdateEnumColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Get a team by its ID. All team members have read access for this resource.", + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Team", + "description": "ColumnEnum", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/team" + "$ref": "#\/components\/schemas\/columnEnum" } } } @@ -43219,112 +42418,66 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "teams", - "weight": 538, + "method": "updateEnumColumn", + "group": "columns", + "weight": 781, "cookies": false, "type": "", - "demo": "teams\/get.md", + "demo": "tablesdb\/update-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - } - ] - }, - "put": { - "summary": "Update name", - "operationId": "teamsUpdateName", - "tags": [ - "teams" - ], - "description": "Update the team's name by its unique ID.", - "responses": { - "200": { - "description": "Team", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/team" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateName", - "group": "teams", - "weight": 541, - "cookies": false, - "type": "", - "demo": "teams\/update-name.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", - "platforms": [ - "console", - "client", - "server", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md", - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ + }, { - "name": "teamId", - "description": "Team ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } @@ -43335,95 +42488,188 @@ "schema": { "type": "object", "properties": { - "name": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { "type": "string", - "description": "New team name. Max length: 128 chars.", - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "name" + "elements", + "required", + "default" ] } } } } - }, - "delete": { - "summary": "Delete team", - "operationId": "teamsDelete", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesDBCreateFloatColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Delete a team using its ID. Only team members with the owner role can delete the team.", + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnFloat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnFloat" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "teams", - "weight": 540, + "method": "createFloatColumn", + "group": "columns", + "weight": 782, "cookies": false, "type": "", - "demo": "teams\/delete.md", + "demo": "tablesdb\/create-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } } }, - "\/teams\/{teamId}\/memberships": { - "get": { - "summary": "List team memberships", - "operationId": "teamsListMemberships", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesDBUpdateFloatColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Memberships List", + "description": "ColumnFloat", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membershipList" + "$ref": "#\/components\/schemas\/columnFloat" } } } @@ -43431,100 +42677,134 @@ }, "deprecated": false, "x-appwrite": { - "method": "listMemberships", - "group": "memberships", - "weight": 546, + "method": "updateFloatColumn", + "group": "columns", + "weight": 783, "cookies": false, "type": "", - "demo": "teams\/list-memberships.md", + "demo": "tablesdb\/update-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { "post": { - "summary": "Create team membership", - "operationId": "teamsCreateMembership", + "summary": "Create integer column", + "operationId": "tablesDBCreateIntegerColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n", + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", "responses": { - "201": { - "description": "Membership", + "202": { + "description": "ColumnInteger", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membership" + "$ref": "#\/components\/schemas\/columnInteger" } } } @@ -43532,46 +42812,57 @@ }, "deprecated": false, "x-appwrite": { - "method": "createMembership", - "group": "memberships", - "weight": 544, + "method": "createIntegerColumn", + "group": "columns", + "weight": 784, "cookies": false, "type": "", - "demo": "teams\/create-membership.md", - "rate-limit": 10, + "demo": "tablesdb\/create-integer-column.md", + "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -43582,45 +42873,46 @@ "schema": { "type": "object", "properties": { - "email": { + "key": { "type": "string", - "description": "Email of the new team member.", - "x-example": "email@example.com", - "format": "email" - }, - "userId": { - "type": "string", - "description": "ID of the user to be added to a team.", - "x-example": "" + "description": "Column Key.", + "x-example": null }, - "phone": { - "type": "string", - "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", - "format": "phone" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "roles": { - "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "min": { + "type": "integer", + "description": "Minimum value", "x-example": null, - "items": { - "type": "string" - } + "format": "int64", + "x-nullable": true }, - "url": { - "type": "string", - "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "x-example": "https:\/\/example.com", - "format": "url" + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true }, - "name": { - "type": "string", - "description": "Name of the new team member. Max length: 128 chars.", - "x-example": "" + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ - "roles" + "key", + "required" ] } } @@ -43628,21 +42920,21 @@ } } }, - "\/teams\/{teamId}\/memberships\/{membershipId}": { - "get": { - "summary": "Get team membership", - "operationId": "teamsGetMembership", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesDBUpdateIntegerColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Membership", + "description": "ColumnInteger", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membership" + "$ref": "#\/components\/schemas\/columnInteger" } } } @@ -43650,75 +42942,134 @@ }, "deprecated": false, "x-appwrite": { - "method": "getMembership", - "group": "memberships", - "weight": 545, + "method": "updateIntegerColumn", + "group": "columns", + "weight": 785, "cookies": false, "type": "", - "demo": "teams\/get-membership.md", + "demo": "tablesdb\/update-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, - "patch": { - "summary": "Update team membership", - "operationId": "teamsUpdateMembership", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesDBCreateIpColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n", + "description": "Create IP address column.\n", "responses": { - "200": { - "description": "Membership", + "202": { + "description": "ColumnIP", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membership" + "$ref": "#\/components\/schemas\/columnIp" } } } @@ -43726,56 +43077,57 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembership", - "group": "memberships", - "weight": 547, + "method": "createIpColumn", + "group": "columns", + "weight": 786, "cookies": false, "type": "", - "demo": "teams\/update-membership.md", + "demo": "tablesdb\/create-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -43786,108 +43138,173 @@ "schema": { "type": "object", "properties": { - "roles": { - "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", "x-example": null, - "items": { - "type": "string" - } + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ - "roles" + "key", + "required" ] } } } } - }, - "delete": { - "summary": "Delete team membership", - "operationId": "teamsDeleteMembership", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesDBUpdateIpColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.", + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnIP", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnIp" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteMembership", - "group": "memberships", - "weight": 1074, + "method": "updateIpColumn", + "group": "columns", + "weight": 787, "cookies": false, "type": "", - "demo": "teams\/delete-membership.md", + "demo": "tablesdb\/update-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, - "\/teams\/{teamId}\/memberships\/{membershipId}\/status": { - "patch": { - "summary": "Update team membership status", - "operationId": "teamsUpdateMembershipStatus", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { + "post": { + "summary": "Create line column", + "operationId": "tablesDBCreateLineColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n", + "description": "Create a geometric line column.", "responses": { - "200": { - "description": "Membership", + "202": { + "description": "ColumnLine", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membership" + "$ref": "#\/components\/schemas\/columnLine" } } } @@ -43895,54 +43312,57 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipStatus", - "group": "memberships", - "weight": 549, + "method": "createLineColumn", + "group": "columns", + "weight": 788, "cookies": false, "type": "", - "demo": "teams\/update-membership-status.md", + "demo": "tablesdb\/create-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -43953,20 +43373,33 @@ "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID.", - "x-example": "" + "description": "Column Key.", + "x-example": null }, - "secret": { - "type": "string", - "description": "Secret key.", - "x-example": "" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", + "x-example": "[[1, 2], [3, 4], [5, 6]]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true } }, "required": [ - "userId", - "secret" + "key", + "required" ] } } @@ -43974,21 +43407,21 @@ } } }, - "\/teams\/{teamId}\/prefs": { - "get": { - "summary": "Get team preferences", - "operationId": "teamsGetPrefs", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { + "patch": { + "summary": "Update line column", + "operationId": "tablesDBUpdateLineColumn", "tags": [ - "teams" + "tablesDB" ], - "description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).", + "description": "Update a line column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Preferences", + "description": "ColumnLine", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/preferences" + "$ref": "#\/components\/schemas\/columnLine" } } } @@ -43996,108 +43429,183 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPrefs", - "group": "teams", - "weight": 542, + "method": "updateLineColumn", + "group": "columns", + "weight": 789, "cookies": false, "type": "", - "demo": "teams\/get-prefs.md", + "demo": "tablesdb\/update-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, - "put": { - "summary": "Update team preferences", - "operationId": "teamsUpdatePrefs", - "tags": [ - "teams" ], - "description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.", - "responses": { - "200": { - "description": "Preferences", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/preferences" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updatePrefs", - "group": "teams", - "weight": 543, + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", + "x-example": "[[1, 2], [3, 4], [5, 6]]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + "post": { + "summary": "Create longtext column", + "operationId": "tablesDBCreateLongtextColumn", + "tags": [ + "tablesDB" + ], + "description": "Create a longtext column.\n", + "responses": { + "202": { + "description": "ColumnLongtext", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnLongtext" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createLongtextColumn", + "group": "columns", + "weight": 806, "cookies": false, "type": "", - "demo": "teams\/update-prefs.md", + "demo": "tablesdb\/create-longtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -44108,14 +43616,36 @@ "schema": { "type": "object", "properties": { - "prefs": { - "type": "object", - "description": "Prefs key-value JSON object.", - "x-example": "{}" + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false } }, "required": [ - "prefs" + "key", + "required" ] } } @@ -44123,21 +43653,21 @@ } } }, - "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "List tokens", - "operationId": "tokensList", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { + "patch": { + "summary": "Update longtext column", + "operationId": "tablesDBUpdateLongtextColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", + "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Resource Tokens List", + "description": "ColumnLongtext", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/resourceTokenList" + "$ref": "#\/components\/schemas\/columnLongtext" } } } @@ -44145,22 +43675,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "files", - "weight": 553, + "method": "updateLongtextColumn", + "group": "columns", + "weight": 807, "cookies": false, "type": "", - "demo": "tokens\/list.md", + "demo": "tablesdb\/update-longtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", "auth": { "Project": [], "Key": [] @@ -44174,65 +43710,84 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File unique ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire", - "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, + "name": "key", + "description": "Column Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { "post": { - "summary": "Create file token", - "operationId": "tokensCreateFileToken", + "summary": "Create mediumtext column", + "operationId": "tablesDBCreateMediumtextColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.", + "description": "Create a mediumtext column.\n", "responses": { - "201": { - "description": "ResourceToken", + "202": { + "description": "ColumnMediumtext", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/resourceToken" + "$ref": "#\/components\/schemas\/columnMediumtext" } } } @@ -44240,22 +43795,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFileToken", - "group": "files", - "weight": 551, + "method": "createMediumtextColumn", + "group": "columns", + "weight": 804, "cookies": false, "type": "", - "demo": "tokens\/create-file-token.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/create-mediumtext-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", "auth": { "Project": [], "Key": [] @@ -44269,22 +43830,22 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "fileId", - "description": "File unique ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -44295,35 +43856,58 @@ "schema": { "type": "object", "properties": { - "expire": { + "key": { "type": "string", - "description": "Token expiry date", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } } } } }, - "\/tokens\/{tokenId}": { - "get": { - "summary": "Get token", - "operationId": "tokensGet", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { + "patch": { + "summary": "Update mediumtext column", + "operationId": "tablesDBUpdateMediumtextColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "Get a token by its unique ID.", + "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ResourceToken", + "description": "ColumnMediumtext", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/resourceToken" + "$ref": "#\/components\/schemas\/columnMediumtext" } } } @@ -44331,22 +43915,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "tokens", - "weight": 552, + "method": "updateMediumtextColumn", + "group": "columns", + "weight": 805, "cookies": false, "type": "", - "demo": "tokens\/get.md", + "demo": "tablesdb\/update-mediumtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", "auth": { "Project": [], "Key": [] @@ -44360,31 +43950,84 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, - "patch": { - "summary": "Update token", - "operationId": "tokensUpdate", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { + "post": { + "summary": "Create point column", + "operationId": "tablesDBCreatePointColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", + "description": "Create a geometric point column.", "responses": { - "200": { - "description": "ResourceToken", + "202": { + "description": "ColumnPoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/resourceToken" + "$ref": "#\/components\/schemas\/columnPoint" } } } @@ -44392,22 +44035,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "tokens", - "weight": 554, + "method": "createPointColumn", + "group": "columns", + "weight": 790, "cookies": false, "type": "", - "demo": "tokens\/update.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/create-point-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [], "Key": [] @@ -44421,12 +44070,22 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token unique ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -44437,49 +44096,84 @@ "schema": { "type": "object", "properties": { - "expire": { + "key": { "type": "string", - "description": "File token expiry date", - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "description": "Column Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", + "x-example": "[1, 2]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, "x-nullable": true } - } + }, + "required": [ + "key", + "required" + ] } } } } - }, - "delete": { - "summary": "Delete token", - "operationId": "tokensDelete", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "patch": { + "summary": "Update point column", + "operationId": "tablesDBUpdatePointColumn", "tags": [ - "tokens" + "tablesDB" ], - "description": "Delete a token by its unique ID.", + "description": "Update a point column. Changing the `default` value will not update already existing rows.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnPoint", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnPoint" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "tokens", - "weight": 555, + "method": "updatePointColumn", + "group": "columns", + "weight": 791, "cookies": false, "type": "", - "demo": "tokens\/delete.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/update-point-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [], "Key": [] @@ -44493,33 +44187,90 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", + "x-example": "[1, 2]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required" + ] + } + } + } + } } }, - "\/users": { - "get": { - "summary": "List users", - "operationId": "usersList", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "post": { + "summary": "Create polygon column", + "operationId": "tablesDBCreatePolygonColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Get a list of all the project's users. You can use the query params to filter your results.", + "description": "Create a geometric polygon column.", "responses": { - "200": { - "description": "Users List", + "202": { + "description": "ColumnPolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/userList" + "$ref": "#\/components\/schemas\/columnPolygon" } } } @@ -44527,23 +44278,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "users", - "weight": 76, + "method": "createPolygonColumn", + "group": "columns", + "weight": 792, "cookies": false, "type": "", - "demo": "users\/list.md", + "demo": "tablesdb\/create-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", "auth": { "Project": [], "Key": [] @@ -44557,89 +44313,24 @@ ], "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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "databaseId", + "description": "Database ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string", + "x-example": "" }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create user", - "operationId": "usersCreate", - "tags": [ - "users" - ], - "description": "Create a new user.", - "responses": { - "201": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "create", - "group": "users", - "weight": 67, - "cookies": false, - "type": "", - "demo": "users\/create.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] + "in": "path" } ], "requestBody": { @@ -44648,38 +44339,33 @@ "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Column Key.", + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email", - "x-nullable": true + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "phone": { - "type": "string", - "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", - "format": "phone", + "default": { + "type": "array", + "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, "x-nullable": true - }, - "password": { - "type": "string", - "description": "Plain text user password. Must be at least 8 chars.", - "x-example": null - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" } }, "required": [ - "userId" + "key", + "required" ] } } @@ -44687,21 +44373,21 @@ } } }, - "\/users\/argon2": { - "post": { - "summary": "Create user with Argon2 password", - "operationId": "usersCreateArgon2User", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "patch": { + "summary": "Update polygon column", + "operationId": "tablesDBUpdatePolygonColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnPolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnPolygon" } } } @@ -44709,23 +44395,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createArgon2User", - "group": "users", - "weight": 70, + "method": "updatePolygonColumn", + "group": "columns", + "weight": 793, "cookies": false, "type": "", - "demo": "users\/create-argon-2-user.md", + "demo": "tablesdb\/update-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", "auth": { "Project": [], "Key": [] @@ -44737,39 +44428,70 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "password": { - "type": "string", - "description": "User password hashed using Argon2.", - "x-example": "password", - "format": "password" + "default": { + "type": "array", + "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "items": { + "oneOf": [ + { + "type": "array" + } + ] + }, + "x-nullable": true }, - "name": { + "newKey": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "required" ] } } @@ -44777,21 +44499,21 @@ } } }, - "\/users\/bcrypt": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { "post": { - "summary": "Create user with bcrypt password", - "operationId": "usersCreateBcryptUser", + "summary": "Create relationship column", + "operationId": "tablesDBCreateRelationshipColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnRelationship" } } } @@ -44799,23 +44521,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createBcryptUser", - "group": "users", - "weight": 68, + "method": "createRelationshipColumn", + "group": "columns", + "weight": 794, "cookies": false, "type": "", - "demo": "users\/create-bcrypt-user.md", + "demo": "tablesdb\/create-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", "auth": { "Project": [], "Key": [] @@ -44827,39 +44554,85 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { + "relatedTableId": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Related Table ID.", + "x-example": "" }, - "email": { + "type": { "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "description": "Relation type", + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [] }, - "password": { + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "x-example": false + }, + "key": { "type": "string", - "description": "User password hashed using Bcrypt.", - "x-example": "password", - "format": "password" + "description": "Column Key.", + "x-example": null, + "x-nullable": true }, - "name": { + "twoWayKey": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "Two Way Column Key.", + "x-example": null, + "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "userId", - "email", - "password" + "relatedTableId", + "type" ] } } @@ -44867,45 +44640,54 @@ } } }, - "\/users\/identities": { - "get": { - "summary": "List identities", - "operationId": "usersListIdentities", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesDBCreateStringColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Get identities for all users.", + "description": "Create a string column.\n", "responses": { - "200": { - "description": "Identities List", + "202": { + "description": "ColumnString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/identityList" + "$ref": "#\/components\/schemas\/columnString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "listIdentities", - "group": "identities", - "weight": 84, + "method": "createStringColumn", + "group": "columns", + "weight": 796, "cookies": false, "type": "", - "demo": "users\/list-identities.md", + "demo": "tablesdb\/create-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", + "deprecated": { + "since": "1.9.0", + "replaceWith": "tablesDB.createTextColumn" + }, "auth": { "Project": [], "Key": [] @@ -44919,75 +44701,124 @@ ], "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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry", - "required": false, + "name": "databaseId", + "description": "Database ID.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "schema": { "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true + "x-example": "" }, - "in": "query" + "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Column size for text columns, in number of characters.", + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } + } + } + } } }, - "\/users\/identities\/{identityId}": { - "delete": { - "summary": "Delete identity", - "operationId": "usersDeleteIdentity", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesDBUpdateStringColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Delete an identity by its unique ID.", + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnString", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/columnString" + } + } + } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteIdentity", - "group": "identities", - "weight": 108, + "method": "updateStringColumn", + "group": "columns", + "weight": 797, "cookies": false, "type": "", - "demo": "users\/delete-identity.md", + "demo": "tablesdb\/update-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateTextColumn" + }, "auth": { "Project": [], "Key": [] @@ -45001,33 +44832,91 @@ ], "parameters": [ { - "name": "identityId", - "description": "Identity ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } } }, - "\/users\/md5": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { "post": { - "summary": "Create user with MD5 password", - "operationId": "usersCreateMD5User", + "summary": "Create text column", + "operationId": "tablesDBCreateTextColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a text column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnText", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnText" } } } @@ -45035,23 +44924,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createMD5User", - "group": "users", - "weight": 69, + "method": "createTextColumn", + "group": "columns", + "weight": 802, "cookies": false, "type": "", - "demo": "users\/create-md-5-user.md", + "demo": "tablesdb\/create-text-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", "auth": { "Project": [], "Key": [] @@ -45063,39 +44957,64 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Column Key.", + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "password": { + "default": { "type": "string", - "description": "User password hashed using MD5.", - "x-example": "password", - "format": "password" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false } }, "required": [ - "userId", - "email", - "password" + "key", + "required" ] } } @@ -45103,21 +45022,21 @@ } } }, - "\/users\/phpass": { - "post": { - "summary": "Create user with PHPass password", - "operationId": "usersCreatePHPassUser", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { + "patch": { + "summary": "Update text column", + "operationId": "tablesDBUpdateTextColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnText", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnText" } } } @@ -45125,23 +45044,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPHPassUser", - "group": "users", - "weight": 72, + "method": "updateTextColumn", + "group": "columns", + "weight": 803, "cookies": false, "type": "", - "demo": "users\/create-ph-pass-user.md", + "demo": "tablesdb\/update-text-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", "auth": { "Project": [], "Key": [] @@ -45153,39 +45077,64 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "password": { + "default": { "type": "string", - "description": "User password hashed using PHPass.", - "x-example": "password", - "format": "password" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true }, - "name": { + "newKey": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "required", + "default" ] } } @@ -45193,21 +45142,21 @@ } } }, - "\/users\/scrypt": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { "post": { - "summary": "Create user with Scrypt password", - "operationId": "usersCreateScryptUser", + "summary": "Create URL column", + "operationId": "tablesDBCreateUrlColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a URL column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnUrl" } } } @@ -45215,23 +45164,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createScryptUser", - "group": "users", - "weight": 73, + "method": "createUrlColumn", + "group": "columns", + "weight": 798, "cookies": false, "type": "", - "demo": "users\/create-scrypt-user.md", + "demo": "tablesdb\/create-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", "auth": { "Project": [], "Key": [] @@ -45243,73 +45197,60 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { + "key": { "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "description": "Column Key.", + "x-example": null }, - "password": { - "type": "string", - "description": "User password hashed using Scrypt.", - "x-example": "password", - "format": "password" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "passwordSalt": { + "default": { "type": "string", - "description": "Optional salt used to hash password.", - "x-example": "" - }, - "passwordCpu": { - "type": "integer", - "description": "Optional CPU cost used to hash password.", - "x-example": null, - "format": "int32" - }, - "passwordMemory": { - "type": "integer", - "description": "Optional memory cost used to hash password.", - "x-example": null, - "format": "int32" - }, - "passwordParallel": { - "type": "integer", - "description": "Optional parallelization cost used to hash password.", - "x-example": null, - "format": "int32" - }, - "passwordLength": { - "type": "integer", - "description": "Optional hash length used to hash password.", - "x-example": null, - "format": "int32" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ - "userId", - "email", - "password", - "passwordSalt", - "passwordCpu", - "passwordMemory", - "passwordParallel", - "passwordLength" + "key", + "required" ] } } @@ -45317,21 +45258,21 @@ } } }, - "\/users\/scrypt-modified": { - "post": { - "summary": "Create user with Scrypt modified password", - "operationId": "usersCreateScryptModifiedUser", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesDBUpdateUrlColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnUrl" } } } @@ -45339,23 +45280,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createScryptModifiedUser", - "group": "users", - "weight": 74, + "method": "updateUrlColumn", + "group": "columns", + "weight": 799, "cookies": false, "type": "", - "demo": "users\/create-scrypt-modified-user.md", + "demo": "tablesdb\/update-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", "auth": { "Project": [], "Key": [] @@ -45367,57 +45313,65 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" - }, - "password": { - "type": "string", - "description": "User password hashed using Scrypt Modified.", - "x-example": "password", - "format": "password" - }, - "passwordSalt": { - "type": "string", - "description": "Salt used to hash password.", - "x-example": "" - }, - "passwordSaltSeparator": { - "type": "string", - "description": "Salt separator used to hash password.", - "x-example": "" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "passwordSignerKey": { + "default": { "type": "string", - "description": "Signer key used to hash password.", - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, - "name": { + "newKey": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password", - "passwordSalt", - "passwordSaltSeparator", - "passwordSignerKey" + "required", + "default" ] } } @@ -45425,21 +45379,21 @@ } } }, - "\/users\/sha": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { "post": { - "summary": "Create user with SHA password", - "operationId": "usersCreateSHAUser", + "summary": "Create varchar column", + "operationId": "tablesDBCreateVarcharColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a varchar column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnVarchar", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnVarchar" } } } @@ -45447,23 +45401,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSHAUser", - "group": "users", - "weight": 71, + "method": "createVarcharColumn", + "group": "columns", + "weight": 800, "cookies": false, "type": "", - "demo": "users\/create-sha-user.md", + "demo": "tablesdb\/create-varchar-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", "auth": { "Project": [], "Key": [] @@ -45475,59 +45434,71 @@ "Key": [] } ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Column Key.", + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" + "size": { + "type": "integer", + "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", + "x-example": 1, + "format": "int32" }, - "password": { - "type": "string", - "description": "User password hashed using SHA.", - "x-example": "password", - "format": "password" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false }, - "passwordVersion": { + "default": { "type": "string", - "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", - "x-example": "sha1", - "enum": [ - "sha1", - "sha224", - "sha256", - "sha384", - "sha512\/224", - "sha512\/256", - "sha512", - "sha3-224", - "sha3-256", - "sha3-384", - "sha3-512" - ], - "x-enum-name": "PasswordHash", - "x-enum-keys": [] + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "x-example": false } }, "required": [ - "userId", - "email", - "password" + "key", + "size", + "required" ] } } @@ -45535,21 +45506,21 @@ } } }, - "\/users\/{userId}": { - "get": { - "summary": "Get user", - "operationId": "usersGet", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { + "patch": { + "summary": "Update varchar column", + "operationId": "tablesDBUpdateVarcharColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Get a user by its unique ID.", + "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "User", + "description": "ColumnVarchar", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnVarchar" } } } @@ -45557,23 +45528,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "users", - "weight": 77, + "method": "updateVarcharColumn", + "group": "columns", + "weight": 801, "cookies": false, "type": "", - "demo": "users\/get.md", + "demo": "tablesdb\/update-varchar-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", "auth": { "Project": [], "Key": [] @@ -45587,48 +45563,202 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, - "delete": { - "summary": "Delete user", - "operationId": "usersDelete", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the varchar column.", + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesDBGetColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.", + "description": "Get column by ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "content": { + "application\/json": { + "schema": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/columnBoolean" + }, + { + "$ref": "#\/components\/schemas\/columnInteger" + }, + { + "$ref": "#\/components\/schemas\/columnFloat" + }, + { + "$ref": "#\/components\/schemas\/columnEmail" + }, + { + "$ref": "#\/components\/schemas\/columnEnum" + }, + { + "$ref": "#\/components\/schemas\/columnUrl" + }, + { + "$ref": "#\/components\/schemas\/columnIp" + }, + { + "$ref": "#\/components\/schemas\/columnDatetime" + }, + { + "$ref": "#\/components\/schemas\/columnRelationship" + }, + { + "$ref": "#\/components\/schemas\/columnString" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/components\/schemas\/columnBoolean", + "integer": "#\/components\/schemas\/columnInteger", + "double": "#\/components\/schemas\/columnFloat", + "string": "#\/components\/schemas\/columnString", + "datetime": "#\/components\/schemas\/columnDatetime", + "relationship": "#\/components\/schemas\/columnRelationship" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/components\/schemas\/columnBoolean": { + "type": "boolean" + }, + "#\/components\/schemas\/columnInteger": { + "type": "integer" + }, + "#\/components\/schemas\/columnFloat": { + "type": "double" + }, + "#\/components\/schemas\/columnEmail": { + "type": "string", + "format": "email" + }, + "#\/components\/schemas\/columnEnum": { + "type": "string", + "format": "enum" + }, + "#\/components\/schemas\/columnUrl": { + "type": "string", + "format": "url" + }, + "#\/components\/schemas\/columnIp": { + "type": "string", + "format": "ip" + }, + "#\/components\/schemas\/columnDatetime": { + "type": "datetime" + }, + "#\/components\/schemas\/columnRelationship": { + "type": "relationship" + }, + "#\/components\/schemas\/columnString": { + "type": "string" + } + } + } + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "users", - "weight": 106, + "method": "getColumn", + "group": "columns", + "weight": 771, "cookies": false, "type": "", - "demo": "users\/delete.md", + "demo": "tablesdb\/get-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read", + "columns.read", + "attributes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md", "auth": { "Project": [], "Key": [] @@ -45642,57 +45772,72 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } ] - } - }, - "\/users\/{userId}\/email": { - "patch": { - "summary": "Update email", - "operationId": "usersUpdateEmail", + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDBDeleteColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user email by its unique ID.", + "description": "Deletes a column.", "responses": { - "200": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateEmail", - "group": "users", - "weight": 91, + "method": "deleteColumn", + "group": "columns", + "weight": 772, "cookies": false, "type": "", - "demo": "users\/update-email.md", + "demo": "tablesdb\/delete-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md", "auth": { "Project": [], "Key": [] @@ -45706,53 +45851,52 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "User email.", - "x-example": "email@example.com", - "format": "email" - } - }, - "required": [ - "email" - ] - } - } - } - } + ] } }, - "\/users\/{userId}\/impersonator": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { "patch": { - "summary": "Update user impersonator capability", - "operationId": "usersUpdateImpersonator", + "summary": "Update relationship column", + "operationId": "tablesDBUpdateRelationshipColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.\n", + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { "200": { - "description": "User", + "description": "ColumnRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnRelationship" } } } @@ -45760,23 +45904,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateImpersonator", - "group": "users", - "weight": 87, + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 795, "cookies": false, "type": "", - "demo": "users\/update-impersonator.md", + "demo": "tablesdb\/update-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-impersonator.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md", "auth": { "Project": [], "Key": [] @@ -45790,12 +45939,31 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } @@ -45806,36 +45974,47 @@ "schema": { "type": "object", "properties": { - "impersonator": { - "type": "boolean", - "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", - "x-example": false + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [], + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } - }, - "required": [ - "impersonator" - ] + } } } } } } }, - "\/users\/{userId}\/jwts": { - "post": { - "summary": "Create user JWT", - "operationId": "usersCreateJWT", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesDBListIndexes", "tags": [ - "users" + "tablesDB" ], - "description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.", + "description": "List indexes on the table.", "responses": { - "201": { - "description": "JWT", + "200": { + "description": "Column Indexes List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/jwt" + "$ref": "#\/components\/schemas\/columnIndexList" } } } @@ -45843,23 +46022,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "createJWT", - "group": "sessions", - "weight": 109, + "method": "listIndexes", + "group": "indexes", + "weight": 811, "cookies": false, "type": "", - "demo": "users\/create-jwt.md", + "demo": "tablesdb\/list-indexes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read", + "indexes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md", "auth": { "Project": [], "Key": [] @@ -45873,55 +46056,65 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "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 columns: key, type, status, attributes, error", + "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", + "x-example": false, + "default": true + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "sessionId": { - "type": "string", - "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", - "x-example": "" - }, - "duration": { - "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", - "x-example": 0, - "format": "int32" - } - } - } - } - } - } - } - }, - "\/users\/{userId}\/labels": { - "put": { - "summary": "Update user labels", - "operationId": "usersUpdateLabels", + ] + }, + "post": { + "summary": "Create index", + "operationId": "tablesDBCreateIndex", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.", + "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.", "responses": { - "200": { - "description": "User", + "202": { + "description": "Index", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/columnIndex" } } } @@ -45929,23 +46122,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLabels", - "group": "users", - "weight": 86, + "method": "createIndex", + "group": "indexes", + "weight": 808, "cookies": false, "type": "", - "demo": "users\/update-labels.md", + "demo": "tablesdb\/create-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "indexes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md", "auth": { "Project": [], "Key": [] @@ -45959,12 +46156,22 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -45975,17 +46182,59 @@ "schema": { "type": "object", "properties": { - "labels": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "key", + "enum": [ + "key", + "fulltext", + "unique", + "spatial" + ], + "x-enum-name": "TablesDBIndexType", + "x-enum-keys": [] + }, + "columns": { "type": "array", - "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", "x-example": null, "items": { "type": "string" } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } } }, "required": [ - "labels" + "key", + "type", + "columns" ] } } @@ -45993,21 +46242,21 @@ } } }, - "\/users\/{userId}\/logs": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { "get": { - "summary": "List user logs", - "operationId": "usersListLogs", + "summary": "Get index", + "operationId": "tablesDBGetIndex", "tags": [ - "users" + "tablesDB" ], - "description": "Get the user activity logs list by its unique ID.", + "description": "Get index by ID.", "responses": { "200": { - "description": "Logs List", + "description": "Index", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/logList" + "$ref": "#\/components\/schemas\/columnIndex" } } } @@ -46015,23 +46264,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 82, + "method": "getIndex", + "group": "indexes", + "weight": 809, "cookies": false, "type": "", - "demo": "users\/list-logs.md", + "demo": "tablesdb\/get-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.read", + "collections.read", + "indexes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md", "auth": { "Project": [], "Key": [] @@ -46045,57 +46298,130 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, + "name": "key", + "description": "Index Key.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string" }, - "in": "query" + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "tablesDBDeleteIndex", + "tags": [ + "tablesDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 810, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "indexes.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ] } }, - "\/users\/{userId}\/memberships": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": { "get": { - "summary": "List user memberships", - "operationId": "usersListMemberships", + "summary": "List rows", + "operationId": "tablesDBListRows", "tags": [ - "users" + "tablesDB" ], - "description": "Get the user membership list by its unique ID.", + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", "responses": { "200": { - "description": "Memberships List", + "description": "Rows List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/membershipList" + "$ref": "#\/components\/schemas\/rowList" } } } @@ -46103,48 +46429,65 @@ }, "deprecated": false, "x-appwrite": { - "method": "listMemberships", - "group": "memberships", - "weight": 81, + "method": "listRows", + "group": "rows", + "weight": 899, "cookies": false, "type": "", - "demo": "users\/list-memberships.md", + "demo": "tablesdb\/list-rows.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", "required": false, "schema": { "type": "array", @@ -46156,13 +46499,12 @@ "in": "query" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", "required": false, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, "in": "query" }, @@ -46176,130 +46518,158 @@ "default": true }, "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" } ] - } - }, - "\/users\/{userId}\/mfa": { - "patch": { - "summary": "Update MFA", - "operationId": "usersUpdateMfa", + }, + "post": { + "summary": "Create row", + "operationId": "tablesDBCreateRow", "tags": [ - "users" + "tablesDB" ], - "description": "Enable or disable MFA on a user account.", + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { - "200": { - "description": "User", + "201": { + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/row" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateMfa", - "group": "users", - "weight": 96, + "method": "createRow", + "group": "rows", + "weight": 812, "cookies": false, "type": "", - "demo": "users\/update-mfa.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/create-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFA" - }, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md", "methods": [ { - "name": "updateMfa", - "namespace": "users", - "desc": "", + "name": "createRow", + "namespace": "tablesDB", + "desc": "Create row", "auth": { "Project": [], - "Key": [] + "Session": [] }, "parameters": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rowId", + "data", + "permissions", + "transactionId" ], "required": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rowId", + "data" ], "responses": [ { - "code": 200, - "model": "#\/components\/schemas\/user" + "code": 201, + "model": "#\/components\/schemas\/row" } ], - "description": "Enable or disable MFA on a user account.", - "demo": "users\/update-mfa.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFA" - } + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/create-row.md", + "public": true }, { - "name": "updateMFA", - "namespace": "users", - "desc": "", + "name": "createRows", + "namespace": "tablesDB", + "desc": "Create rows", "auth": { "Project": [], "Key": [] }, "parameters": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rows", + "transactionId" ], "required": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rows" ], "responses": [ { - "code": 200, - "model": "#\/components\/schemas\/user" + "code": 201, + "model": "#\/components\/schemas\/rowList" } ], - "description": "Enable or disable MFA on a user account.", - "demo": "users\/update-mfa.md", + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/create-rows.md", "public": true } ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -46310,110 +46680,114 @@ "schema": { "type": "object", "properties": { - "mfa": { - "type": "boolean", - "description": "Enable or disable MFA.", - "x-example": false + "rowId": { + "type": "string", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "rows": { + "type": "array", + "description": "Array of rows data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "mfa" - ] + } } } } } - } - }, - "\/users\/{userId}\/mfa\/authenticators\/{type}": { - "delete": { - "summary": "Delete authenticator", - "operationId": "usersDeleteMfaAuthenticator", + }, + "put": { + "summary": "Upsert rows", + "operationId": "tablesDBUpsertRows", "tags": [ - "users" + "tablesDB" ], - "description": "Delete an authenticator app.", + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "deleteMfaAuthenticator", - "group": "mfa", - "weight": 101, + "method": "upsertRows", + "group": "rows", + "weight": 817, "cookies": false, "type": "", - "demo": "users\/delete-mfa-authenticator.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/upsert-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.deleteMFAAuthenticator" - }, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md", "methods": [ { - "name": "deleteMfaAuthenticator", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId", - "type" - ], - "required": [ - "userId", - "type" - ], - "responses": [ - { - "code": 204 - } - ], - "description": "Delete an authenticator app.", - "demo": "users\/delete-mfa-authenticator.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.deleteMFAAuthenticator" - } - }, - { - "name": "deleteMFAAuthenticator", - "namespace": "users", + "name": "upsertRows", + "namespace": "tablesDB", "desc": "", "auth": { "Project": [], "Key": [] }, "parameters": [ - "userId", - "type" + "databaseId", + "tableId", + "rows", + "transactionId" ], "required": [ - "userId", - "type" + "databaseId", + "tableId", + "rows" ], "responses": [ { - "code": 204 + "code": 201, + "model": "#\/components\/schemas\/rowList" } ], - "description": "Delete an authenticator app.", - "demo": "users\/delete-mfa-authenticator.md", + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", + "demo": "tablesdb\/upsert-rows.md", "public": true } ], @@ -46430,130 +46804,96 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "type", - "description": "Type of authenticator.", + "name": "tableId", + "description": "Table ID.", "required": true, "schema": { "type": "string", - "x-example": "totp", - "enum": [ - "totp" - ], - "x-enum-name": "AuthenticatorType", - "x-enum-keys": [] + "x-example": "" }, "in": "path" } - ] - } - }, - "\/users\/{userId}\/mfa\/factors": { - "get": { - "summary": "List factors", - "operationId": "usersListMfaFactors", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "rows" + ] + } + } + } + } + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesDBUpdateRows", "tags": [ - "users" + "tablesDB" ], - "description": "List the factors available on the account to be used as a MFA challange.", + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", "responses": { "200": { - "description": "MFAFactors", + "description": "Rows List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/mfaFactors" + "$ref": "#\/components\/schemas\/rowList" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listMfaFactors", - "group": "mfa", - "weight": 97, + "method": "updateRows", + "group": "rows", + "weight": 815, "cookies": false, "type": "", - "demo": "users\/list-mfa-factors.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/update-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.listMFAFactors" - }, - "methods": [ - { - "name": "listMfaFactors", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaFactors" - } - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "demo": "users\/list-mfa-factors.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.listMFAFactors" - } - }, - { - "name": "listMFAFactors", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaFactors" - } - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "demo": "users\/list-mfa-factors.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", "auth": { "Project": [], "Key": [] @@ -46567,115 +46907,98 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] - } - }, - "\/users\/{userId}\/mfa\/recovery-codes": { - "get": { - "summary": "Get MFA recovery codes", - "operationId": "usersGetMfaRecoveryCodes", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDBDeleteRows", "tags": [ - "users" + "tablesDB" ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", "responses": { "200": { - "description": "MFA Recovery Codes", + "description": "Rows List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/mfaRecoveryCodes" + "$ref": "#\/components\/schemas\/rowList" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getMfaRecoveryCodes", - "group": "mfa", - "weight": 98, + "method": "deleteRows", + "group": "rows", + "weight": 819, "cookies": false, "type": "", - "demo": "users\/get-mfa-recovery-codes.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/delete-rows.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.getMFARecoveryCodes" - }, - "methods": [ - { - "name": "getMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/get-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.getMFARecoveryCodes" - } - }, - { - "name": "getMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/get-mfa-recovery-codes.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", "auth": { "Project": [], "Key": [] @@ -46689,316 +47012,283 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } - ] - }, - "put": { - "summary": "Update MFA recovery codes (regenerate)", - "operationId": "usersUpdateMfaRecoveryCodes", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "get": { + "summary": "Get row", + "operationId": "tablesDBGetRow", "tags": [ - "users" + "tablesDB" ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", "responses": { "200": { - "description": "MFA Recovery Codes", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/mfaRecoveryCodes" + "$ref": "#\/components\/schemas\/row" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateMfaRecoveryCodes", - "group": "mfa", - "weight": 100, + "method": "getRow", + "group": "rows", + "weight": 813, "cookies": false, "type": "", - "demo": "users\/update-mfa-recovery-codes.md", + "demo": "tablesdb\/get-row.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFARecoveryCodes" - }, - "methods": [ - { - "name": "updateMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/update-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFARecoveryCodes" - } - }, - { - "name": "updateMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/update-mfa-recovery-codes.md", - "public": false - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } ] }, - "patch": { - "summary": "Create MFA recovery codes", - "operationId": "usersCreateMfaRecoveryCodes", + "put": { + "summary": "Upsert a row", + "operationId": "tablesDBUpsertRow", "tags": [ - "users" + "tablesDB" ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { "201": { - "description": "MFA Recovery Codes", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/mfaRecoveryCodes" + "$ref": "#\/components\/schemas\/row" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createMfaRecoveryCodes", - "group": "mfa", - "weight": 99, + "method": "upsertRow", + "group": "rows", + "weight": 816, "cookies": false, "type": "", - "demo": "users\/create-mfa-recovery-codes.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/upsert-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.createMFARecoveryCodes" - }, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md", "methods": [ { - "name": "createMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/mfaRecoveryCodes" - } - ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", - "demo": "users\/create-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.createMFARecoveryCodes" - } - }, - { - "name": "createMFARecoveryCodes", - "namespace": "users", + "name": "upsertRow", + "namespace": "tablesDB", "desc": "", "auth": { "Project": [], - "Key": [] + "Session": [] }, "parameters": [ - "userId" + "databaseId", + "tableId", + "rowId", + "data", + "permissions", + "transactionId" ], "required": [ - "userId" + "databaseId", + "tableId", + "rowId" ], "responses": [ { "code": 201, - "model": "#\/components\/schemas\/mfaRecoveryCodes" + "model": "#\/components\/schemas\/row" } ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", - "demo": "users\/create-mfa-recovery-codes.md", + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/upsert-row.md", "public": true } ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - } - ] - } - }, - "\/users\/{userId}\/name": { - "patch": { - "summary": "Update name", - "operationId": "usersUpdateName", - "tags": [ - "users" - ], - "description": "Update the user name by its unique ID.", - "responses": { - "200": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateName", - "group": "users", - "weight": 89, - "cookies": false, - "type": "", - "demo": "users\/update-name.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ + }, { - "Project": [], - "Key": [] - } - ], - "parameters": [ + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, { - "name": "userId", - "description": "User ID.", + "name": "rowId", + "description": "Row ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -47009,36 +47299,46 @@ "schema": { "type": "object", "properties": { - "name": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "transactionId": { "type": "string", - "description": "User name. Max length: 128 chars.", - "x-example": "" + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "name" - ] + } } } } } - } - }, - "\/users\/{userId}\/password": { + }, "patch": { - "summary": "Update password", - "operationId": "usersUpdatePassword", + "summary": "Update row", + "operationId": "tablesDBUpdateRow", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user password by its unique ID.", + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { "200": { - "description": "User", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/row" } } } @@ -47046,125 +47346,182 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePassword", - "group": "users", - "weight": 90, + "method": "updateRow", + "group": "rows", + "weight": 814, "cookies": false, "type": "", - "demo": "users\/update-password.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/update-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - } - ], - "requestBody": { - "content": { + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { "application\/json": { "schema": { "type": "object", "properties": { - "password": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "transactionId": { "type": "string", - "description": "New user password. Must be at least 8 chars.", - "x-example": null + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "password" - ] + } } } } } - } - }, - "\/users\/{userId}\/phone": { - "patch": { - "summary": "Update phone", - "operationId": "usersUpdatePhone", + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDBDeleteRow", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user phone by its unique ID.", + "description": "Delete a row by its unique ID.", "responses": { - "200": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updatePhone", - "group": "users", - "weight": 92, + "method": "deleteRow", + "group": "rows", + "weight": 818, "cookies": false, "type": "", - "demo": "users\/update-phone.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/delete-row.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -47175,37 +47532,34 @@ "schema": { "type": "object", "properties": { - "number": { + "transactionId": { "type": "string", - "description": "User phone number.", - "x-example": "+12065550100", - "format": "phone" + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "number" - ] + } } } } } } }, - "\/users\/{userId}\/prefs": { - "get": { - "summary": "Get user preferences", - "operationId": "usersGetPrefs", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDBDecrementRowColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Get the user preferences by its unique ID.", + "description": "Decrement a specific column of a row by a given value.", "responses": { "200": { - "description": "Preferences", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/preferences" + "$ref": "#\/components\/schemas\/row" } } } @@ -47213,61 +47567,129 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPrefs", - "group": "users", - "weight": 78, + "method": "decrementRowColumn", + "group": "rows", + "weight": 823, "cookies": false, "type": "", - "demo": "users\/get-prefs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/decrement-row-column.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ + "client", + "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], + "Session": [], + "JWT": [], "Key": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null, + "format": "float" + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { "patch": { - "summary": "Update user preferences", - "operationId": "usersUpdatePrefs", + "summary": "Increment row column", + "operationId": "tablesDBIncrementRowColumn", "tags": [ - "users" + "tablesDB" ], - "description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.", + "description": "Increment a specific column of a row by a given value.", "responses": { "200": { - "description": "Preferences", + "description": "Row", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/preferences" + "$ref": "#\/components\/schemas\/row" } } } @@ -47275,42 +47697,78 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePrefs", - "group": "users", - "weight": 94, + "method": "incrementRowColumn", + "group": "rows", + "weight": 822, "cookies": false, "type": "", - "demo": "users\/update-prefs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/increment-row-column.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ + "client", + "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], + "Session": [], + "JWT": [], "Key": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "schema": { + "type": "string" }, "in": "path" } @@ -47321,36 +47779,47 @@ "schema": { "type": "object", "properties": { - "prefs": { - "type": "object", - "description": "Prefs key-value JSON object.", - "x-example": "{}" + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "x-example": null, + "format": "float" + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true } - }, - "required": [ - "prefs" - ] + } } } } } } }, - "\/users\/{userId}\/sessions": { + "\/teams": { "get": { - "summary": "List user sessions", - "operationId": "usersListSessions", + "summary": "List teams", + "operationId": "teamsList", "tags": [ - "users" + "teams" ], - "description": "Get the user sessions list by its unique ID.", + "description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.", "responses": { "200": { - "description": "Sessions List", + "description": "Teams List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/sessionList" + "$ref": "#\/components\/schemas\/teamList" } } } @@ -47358,44 +47827,62 @@ }, "deprecated": false, "x-appwrite": { - "method": "listSessions", - "group": "sessions", - "weight": 80, + "method": "list", + "group": "teams", + "weight": 520, "cookies": false, "type": "", - "demo": "users\/list-sessions.md", + "demo": "teams\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": "teams.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" + "in": "query" }, { "name": "total", @@ -47411,19 +47898,19 @@ ] }, "post": { - "summary": "Create session", - "operationId": "usersCreateSession", + "summary": "Create team", + "operationId": "teamsCreate", "tags": [ - "users" + "teams" ], - "description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.", + "description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.", "responses": { "201": { - "description": "Session", + "description": "Team", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/session" + "$ref": "#\/components\/schemas\/team" } } } @@ -47431,268 +47918,300 @@ }, "deprecated": false, "x-appwrite": { - "method": "createSession", - "group": "sessions", - "weight": 102, + "method": "create", + "group": "teams", + "weight": 518, "cookies": false, "type": "", - "demo": "users\/create-session.md", + "demo": "teams\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], - "parameters": [ - { - "name": "userId", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Team name. Max length: 128 chars.", + "x-example": "" + }, + "roles": { + "type": "array", + "description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } + } + }, + "required": [ + "teamId", + "name" + ] + } + } } - ] - }, - "delete": { - "summary": "Delete user sessions", - "operationId": "usersDeleteSessions", + } + } + }, + "\/teams\/{teamId}": { + "get": { + "summary": "Get team", + "operationId": "teamsGet", "tags": [ - "users" + "teams" ], - "description": "Delete all user's sessions by using the user's unique ID.", + "description": "Get a team by its ID. All team members have read access for this resource.", "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteSessions", - "group": "sessions", - "weight": 105, - "cookies": false, - "type": "", - "demo": "users\/delete-sessions.md", + "200": { + "description": "Team", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/team" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "teams", + "weight": 519, + "cookies": false, + "type": "", + "demo": "teams\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] - } - }, - "\/users\/{userId}\/sessions\/{sessionId}": { - "delete": { - "summary": "Delete user session", - "operationId": "usersDeleteSession", + }, + "put": { + "summary": "Update name", + "operationId": "teamsUpdateName", "tags": [ - "users" + "teams" ], - "description": "Delete a user sessions by its unique ID.", + "description": "Update the team's name by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Team", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/team" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteSession", - "group": "sessions", - "weight": 104, + "method": "updateName", + "group": "teams", + "weight": 522, "cookies": false, "type": "", - "demo": "users\/delete-session.md", + "demo": "teams\/update-name.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "sessionId", - "description": "Session ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] - } - }, - "\/users\/{userId}\/status": { - "patch": { - "summary": "Update user status", - "operationId": "usersUpdateStatus", - "tags": [ - "users" ], - "description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.", - "responses": { - "200": { - "description": "User", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/user" - } + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "New team name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "name" + ] } } } + } + }, + "delete": { + "summary": "Delete team", + "operationId": "teamsDelete", + "tags": [ + "teams" + ], + "description": "Delete a team using its ID. Only team members with the owner role can delete the team.", + "responses": { + "204": { + "description": "No content" + } }, "deprecated": false, "x-appwrite": { - "method": "updateStatus", - "group": "users", - "weight": 85, + "method": "delete", + "group": "teams", + "weight": 521, "cookies": false, "type": "", - "demo": "users\/update-status.md", + "demo": "teams\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "boolean", - "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", - "x-example": false - } - }, - "required": [ - "status" - ] - } - } - } - } + ] } }, - "\/users\/{userId}\/targets": { + "\/teams\/{teamId}\/memberships": { "get": { - "summary": "List user targets", - "operationId": "usersListTargets", + "summary": "List team memberships", + "operationId": "teamsListMemberships", "tags": [ - "users" + "teams" ], - "description": "List the messaging targets that are associated with a user.", + "description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.", "responses": { "200": { - "description": "Target list", + "description": "Memberships List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/targetList" + "$ref": "#\/components\/schemas\/membershipList" } } } @@ -47700,48 +48219,52 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTargets", - "group": "targets", - "weight": 83, + "method": "listMemberships", + "group": "memberships", + "weight": 527, "cookies": false, "type": "", - "demo": "users\/list-targets.md", + "demo": "teams\/list-memberships.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.read", + "scope": "teams.read", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType", + "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: userId, teamId, invited, joined, confirm, roles", "required": false, "schema": { "type": "array", @@ -47752,6 +48275,17 @@ }, "in": "query" }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -47766,19 +48300,19 @@ ] }, "post": { - "summary": "Create user target", - "operationId": "usersCreateTarget", + "summary": "Create team membership", + "operationId": "teamsCreateMembership", "tags": [ - "users" + "teams" ], - "description": "Create a messaging target.", + "description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n", "responses": { "201": { - "description": "Target", + "description": "Membership", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/target" + "$ref": "#\/components\/schemas\/membership" } } } @@ -47786,42 +48320,46 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTarget", - "group": "targets", - "weight": 75, + "method": "createMembership", + "group": "memberships", + "weight": 525, "cookies": false, "type": "", - "demo": "users\/create-target.md", - "rate-limit": 0, + "demo": "teams\/create-membership.md", + "rate-limit": 10, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.write", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -47832,43 +48370,45 @@ "schema": { "type": "object", "properties": { - "targetId": { + "email": { "type": "string", - "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "Email of the new team member.", + "x-example": "email@example.com", + "format": "email" }, - "providerType": { + "userId": { "type": "string", - "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email", - "enum": [ - "email", - "sms", - "push" - ], - "x-enum-name": "MessagingProviderType", - "x-enum-keys": [] + "description": "ID of the user to be added to a team.", + "x-example": "" }, - "identifier": { + "phone": { "type": "string", - "description": "The target identifier (token, email, phone etc.)", - "x-example": "" + "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "x-example": "+12065550100", + "format": "phone" }, - "providerId": { + "roles": { + "type": "array", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "url": { "type": "string", - "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", - "x-example": "" + "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", + "x-example": "https:\/\/example.com", + "format": "url" }, "name": { "type": "string", - "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "description": "Name of the new team member. Max length: 128 chars.", "x-example": "" } }, "required": [ - "targetId", - "providerType", - "identifier" + "roles" ] } } @@ -47876,21 +48416,21 @@ } } }, - "\/users\/{userId}\/targets\/{targetId}": { + "\/teams\/{teamId}\/memberships\/{membershipId}": { "get": { - "summary": "Get user target", - "operationId": "usersGetTarget", + "summary": "Get team membership", + "operationId": "teamsGetMembership", "tags": [ - "users" + "teams" ], - "description": "Get a user's push notification target by ID.", + "description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.", "responses": { "200": { - "description": "Target", + "description": "Membership", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/target" + "$ref": "#\/components\/schemas\/membership" } } } @@ -47898,71 +48438,75 @@ }, "deprecated": false, "x-appwrite": { - "method": "getTarget", - "group": "targets", - "weight": 79, + "method": "getMembership", + "group": "memberships", + "weight": 526, "cookies": false, "type": "", - "demo": "users\/get-target.md", + "demo": "teams\/get-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.read", + "scope": "teams.read", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "targetId", - "description": "Target ID.", + "name": "membershipId", + "description": "Membership ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, "patch": { - "summary": "Update user target", - "operationId": "usersUpdateTarget", + "summary": "Update team membership", + "operationId": "teamsUpdateMembership", "tags": [ - "users" + "teams" ], - "description": "Update a messaging target.", + "description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n", "responses": { "200": { - "description": "Target", + "description": "Membership", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/target" + "$ref": "#\/components\/schemas\/membership" } } } @@ -47970,52 +48514,56 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTarget", - "group": "targets", - "weight": 95, + "method": "updateMembership", + "group": "memberships", + "weight": 528, "cookies": false, "type": "", - "demo": "users\/update-target.md", + "demo": "teams\/update-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.write", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "targetId", - "description": "Target ID.", + "name": "membershipId", + "description": "Membership ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -48026,34 +48574,30 @@ "schema": { "type": "object", "properties": { - "identifier": { - "type": "string", - "description": "The target identifier (token, email, phone etc.)", - "x-example": "" - }, - "providerId": { - "type": "string", - "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", - "x-example": "" + "roles": { + "type": "array", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "x-example": null, + "items": { + "type": "string" + } } - } + }, + "required": [ + "roles" + ] } } } } }, "delete": { - "summary": "Delete user target", - "operationId": "usersDeleteTarget", + "summary": "Delete team membership", + "operationId": "teamsDeleteMembership", "tags": [ - "users" + "teams" ], - "description": "Delete a messaging target.", + "description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.", "responses": { "204": { "description": "No content" @@ -48061,73 +48605,77 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTarget", - "group": "targets", - "weight": 107, + "method": "deleteMembership", + "group": "memberships", + "weight": 1187, "cookies": false, "type": "", - "demo": "users\/delete-target.md", + "demo": "teams\/delete-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.write", "platforms": [ + "console", + "client", "server", - "console" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "targetId", - "description": "Target ID.", + "name": "membershipId", + "description": "Membership ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/users\/{userId}\/tokens": { - "post": { - "summary": "Create token", - "operationId": "usersCreateToken", + "\/teams\/{teamId}\/memberships\/{membershipId}\/status": { + "patch": { + "summary": "Update team membership status", + "operationId": "teamsUpdateMembershipStatus", "tags": [ - "users" + "teams" ], - "description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n", + "description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n", "responses": { - "201": { - "description": "Token", + "200": { + "description": "Membership", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/token" + "$ref": "#\/components\/schemas\/membership" } } } @@ -48135,42 +48683,54 @@ }, "deprecated": false, "x-appwrite": { - "method": "createToken", - "group": "sessions", - "weight": 103, - "cookies": false, + "method": "updateMembershipStatus", + "group": "memberships", + "weight": 530, + "cookies": false, "type": "", - "demo": "users\/create-token.md", + "demo": "teams\/update-membership-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "public", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -48181,40 +48741,42 @@ "schema": { "type": "object", "properties": { - "length": { - "type": "integer", - "description": "Token length in characters. The default length is 6 characters", - "x-example": 4, - "format": "int32" + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "" }, - "expire": { - "type": "integer", - "description": "Token expiration period in seconds. The default expiration is 15 minutes.", - "x-example": 60, - "format": "int32" + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "" } - } + }, + "required": [ + "userId", + "secret" + ] } } } } } }, - "\/users\/{userId}\/verification": { - "patch": { - "summary": "Update email verification", - "operationId": "usersUpdateEmailVerification", + "\/teams\/{teamId}\/prefs": { + "get": { + "summary": "Get team preferences", + "operationId": "teamsGetPrefs", "tags": [ - "users" + "teams" ], - "description": "Update the user email verification status by its unique ID.", + "description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).", "responses": { "200": { - "description": "User", + "description": "Preferences", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/preferences" } } } @@ -48222,82 +48784,63 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailVerification", - "group": "users", - "weight": 93, + "method": "getPrefs", + "group": "teams", + "weight": 523, "cookies": false, "type": "", - "demo": "users\/update-email-verification.md", + "demo": "teams\/get-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "emailVerification": { - "type": "boolean", - "description": "User email verification status.", - "x-example": false - } - }, - "required": [ - "emailVerification" - ] - } - } - } - } - } - }, - "\/users\/{userId}\/verification\/phone": { - "patch": { - "summary": "Update phone verification", - "operationId": "usersUpdatePhoneVerification", + ] + }, + "put": { + "summary": "Update team preferences", + "operationId": "teamsUpdatePrefs", "tags": [ - "users" + "teams" ], - "description": "Update the user phone verification status by its unique ID.", + "description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.", "responses": { "200": { - "description": "User", + "description": "Preferences", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/user" + "$ref": "#\/components\/schemas\/preferences" } } } @@ -48305,42 +48848,44 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePhoneVerification", - "group": "users", - "weight": 88, + "method": "updatePrefs", + "group": "teams", + "weight": 524, "cookies": false, "type": "", - "demo": "users\/update-phone-verification.md", + "demo": "teams\/update-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -48351,14 +48896,14 @@ "schema": { "type": "object", "properties": { - "phoneVerification": { - "type": "boolean", - "description": "User phone verification status.", - "x-example": false + "prefs": { + "type": "object", + "description": "Prefs key-value JSON object.", + "x-example": "{}" } }, "required": [ - "phoneVerification" + "prefs" ] } } @@ -48366,21 +48911,21 @@ } } }, - "\/vectorsdb": { + "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { "get": { - "summary": "List databases", - "operationId": "vectorsDBList", + "summary": "List tokens", + "operationId": "tokensList", "tags": [ - "vectorsDB" + "tokens" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", "responses": { "200": { - "description": "Databases List", + "description": "Resource Tokens List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/databaseList" + "$ref": "#\/components\/schemas\/resourceTokenList" } } } @@ -48389,22 +48934,21 @@ "deprecated": false, "x-appwrite": { "method": "list", - "group": "vectorsdb", - "weight": 816, + "group": "files", + "weight": 534, "cookies": false, "type": "", - "demo": "vectorsdb\/list.md", + "demo": "tokens\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "tokens.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list.md", "auth": { "Project": [], "Key": [] @@ -48417,9 +48961,29 @@ } ], "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "fileId", + "description": "File unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name", + "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: expire", "required": false, "schema": { "type": "array", @@ -48430,17 +48994,6 @@ }, "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -48455,19 +49008,19 @@ ] }, "post": { - "summary": "Create database", - "operationId": "vectorsDBCreate", + "summary": "Create file token", + "operationId": "tokensCreateFileToken", "tags": [ - "vectorsDB" + "tokens" ], - "description": "Create a new Database.\n", + "description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.", "responses": { "201": { - "description": "Database", + "description": "ResourceToken", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/resourceToken" } } } @@ -48475,23 +49028,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "vectorsdb", - "weight": 812, + "method": "createFileToken", + "group": "files", + "weight": 532, "cookies": false, "type": "", - "demo": "vectorsdb\/create.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "demo": "tokens\/create-file-token.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create.md", "auth": { "Project": [], "Key": [] @@ -48503,115 +49055,26 @@ "Key": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "databaseId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "x-example": false - } - }, - "required": [ - "databaseId", - "name" - ] - } - } - } - } - } - }, - "\/vectorsdb\/embeddings\/text": { - "post": { - "summary": "Create Text Embeddings", - "operationId": "vectorsDBCreateTextEmbeddings", - "tags": [ - "vectorsDB" - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "responses": { - "200": { - "description": "Embedding list", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/embeddingList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createTextEmbeddings", - "group": "documents", - "weight": 838, - "cookies": false, - "type": "", - "demo": "vectorsdb\/create-text-embeddings.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "console", - "server", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", - "methods": [ - { - "name": "createTextEmbeddings", - "namespace": "vectorsDB", - "desc": "Create Text Embedding", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "texts", - "model" - ], - "required": [ - "texts" - ], - "responses": [ - { - "code": 200, - "model": "#\/components\/schemas\/embeddingList" - } - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-text-embeddings.md", - "public": true - } - ], - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ + "parameters": [ { - "Project": [], - "Key": [], - "JWT": [] + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "fileId", + "description": "File unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -48620,49 +49083,35 @@ "schema": { "type": "object", "properties": { - "texts": { - "type": "array", - "description": "Array of text to generate embeddings.", - "x-example": null, - "items": { - "type": "string" - } - }, - "model": { + "expire": { "type": "string", - "description": "The embedding model to use for generating vector embeddings.", - "x-example": "embeddinggemma", - "enum": [ - "embeddinggemma" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "Token expiry date", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } - }, - "required": [ - "texts" - ] + } } } } } } }, - "\/vectorsdb\/transactions": { + "\/tokens\/{tokenId}": { "get": { - "summary": "List transactions", - "operationId": "vectorsDBListTransactions", + "summary": "Get token", + "operationId": "tokensGet", "tags": [ - "vectorsDB" + "tokens" ], - "description": "List transactions across all databases.", + "description": "Get a token by its unique ID.", "responses": { "200": { - "description": "Transaction List", + "description": "ResourceToken", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transactionList" + "$ref": "#\/components\/schemas\/resourceToken" } } } @@ -48670,25 +49119,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 843, + "method": "get", + "group": "tokens", + "weight": 533, "cookies": false, "type": "", - "demo": "vectorsdb\/list-transactions.md", + "demo": "tokens\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "tokens.read", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-transactions.md", "auth": { "Project": [], "Key": [] @@ -48697,41 +49143,36 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "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).", - "required": false, + "name": "tokenId", + "description": "Token ID.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" } ] }, - "post": { - "summary": "Create transaction", - "operationId": "vectorsDBCreateTransaction", + "patch": { + "summary": "Update token", + "operationId": "tokensUpdate", "tags": [ - "vectorsDB" + "tokens" ], - "description": "Create a new transaction.", + "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "ResourceToken", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/resourceToken" } } } @@ -48739,25 +49180,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 839, + "method": "update", + "group": "tokens", + "weight": 535, "cookies": false, "type": "", - "demo": "vectorsdb\/create-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "demo": "tokens\/update.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-transaction.md", "auth": { "Project": [], "Key": [] @@ -48766,9 +49204,19 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] + } + ], + "parameters": [ + { + "name": "tokenId", + "description": "Token unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -48777,60 +49225,49 @@ "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "x-example": 60, - "format": "int32" + "expire": { + "type": "string", + "description": "File token expiry date", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } } } } } } - } - }, - "\/vectorsdb\/transactions\/{transactionId}": { - "get": { - "summary": "Get transaction", - "operationId": "vectorsDBGetTransaction", + }, + "delete": { + "summary": "Delete token", + "operationId": "tokensDelete", "tags": [ - "vectorsDB" + "tokens" ], - "description": "Get a transaction by its unique ID.", + "description": "Delete a token by its unique ID.", "responses": { - "200": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 840, + "method": "delete", + "group": "tokens", + "weight": 536, "cookies": false, "type": "", - "demo": "vectorsdb\/get-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "tokens\/delete.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-transaction.md", "auth": { "Project": [], "Key": [] @@ -48839,38 +49276,38 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "tokenId", + "description": "Token ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "vectorsDBUpdateTransaction", + } + }, + "\/users": { + "get": { + "summary": "List users", + "operationId": "usersList", "tags": [ - "vectorsDB" + "users" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Get a list of all the project's users. You can use the query params to filter your results.", "responses": { "200": { - "description": "Transaction", + "description": "Users List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/userList" } } } @@ -48878,25 +49315,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 841, + "method": "list", + "group": "users", + "weight": 71, "cookies": false, "type": "", - "demo": "vectorsdb\/update-transaction.md", + "demo": "users\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.read", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md", "auth": { "Project": [], "Key": [] @@ -48905,78 +49340,85 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "x-example": false - } - } - } - } + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } + ] }, - "delete": { - "summary": "Delete transaction", - "operationId": "vectorsDBDeleteTransaction", + "post": { + "summary": "Create user", + "operationId": "usersCreate", "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a transaction by its unique ID.", + "description": "Create a new user.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 842, + "method": "create", + "group": "users", + "weight": 62, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-transaction.md", + "demo": "users\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md", "auth": { "Project": [], "Key": [] @@ -48985,40 +49427,69 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "phone": { + "type": "string", + "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "x-example": "+12065550100", + "format": "phone", + "x-nullable": true + }, + "password": { + "type": "string", + "description": "Plain text user password. Must be at least 8 chars.", + "x-example": null + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId" + ] + } + } } - ] + } } }, - "\/vectorsdb\/transactions\/{transactionId}\/operations": { + "\/users\/argon2": { "post": { - "summary": "Create operations", - "operationId": "vectorsDBCreateOperations", + "summary": "Create user with Argon2 password", + "operationId": "usersCreateArgon2User", "tags": [ - "vectorsDB" + "users" ], - "description": "Create multiple operations in a single transaction.", + "description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { "201": { - "description": "Transaction", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/user" } } } @@ -49026,25 +49497,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 844, + "method": "createArgon2User", + "group": "users", + "weight": 65, "cookies": false, "type": "", - "demo": "vectorsdb\/create-operations.md", + "demo": "users\/create-argon-2-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.write", "platforms": [ "console", - "server", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md", "auth": { "Project": [], "Key": [] @@ -49053,21 +49522,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Key": [] } ], "requestBody": { @@ -49076,36 +49531,55 @@ "schema": { "type": "object", "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Argon2.", + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" } - } + }, + "required": [ + "userId", + "email", + "password" + ] } } } } } }, - "\/vectorsdb\/{databaseId}": { - "get": { - "summary": "Get database", - "operationId": "vectorsDBGet", + "\/users\/bcrypt": { + "post": { + "summary": "Create user with bcrypt password", + "operationId": "usersCreateBcryptUser", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Database", + "201": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/user" } } } @@ -49113,23 +49587,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "vectorsdb", - "weight": 813, + "method": "createBcryptUser", + "group": "users", + "weight": 63, "cookies": false, "type": "", - "demo": "vectorsdb\/get.md", + "demo": "users\/create-bcrypt-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md", "auth": { "Project": [], "Key": [] @@ -49141,33 +49615,61 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Bcrypt.", + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } + } } - ] - }, - "put": { - "summary": "Update database", - "operationId": "vectorsDBUpdate", + } + } + }, + "\/users\/identities": { + "get": { + "summary": "List identities", + "operationId": "usersListIdentities", "tags": [ - "vectorsDB" + "users" ], - "description": "Update a database by its unique ID.", + "description": "Get identities for all users.", "responses": { "200": { - "description": "Database", + "description": "Identities List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/identityList" } } } @@ -49175,23 +49677,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "vectorsdb", - "weight": 814, + "method": "listIdentities", + "group": "identities", + "weight": 79, "cookies": false, "type": "", - "demo": "vectorsdb\/update.md", + "demo": "users\/list-identities.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md", "auth": { "Project": [], "Key": [] @@ -49205,48 +49707,51 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "x-example": false - } - }, - "required": [ - "name" - ] - } - } + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } - }, + ] + } + }, + "\/users\/identities\/{identityId}": { "delete": { - "summary": "Delete database", - "operationId": "vectorsDBDelete", + "summary": "Delete identity", + "operationId": "usersDeleteIdentity", "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "description": "Delete an identity by its unique ID.", "responses": { "204": { "description": "No content" @@ -49254,23 +49759,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "vectorsdb", - "weight": 815, + "method": "deleteIdentity", + "group": "identities", + "weight": 103, "cookies": false, "type": "", - "demo": "vectorsdb\/delete.md", + "demo": "users\/delete-identity.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md", "auth": { "Project": [], "Key": [] @@ -49284,33 +49789,33 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "identityId", + "description": "Identity ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] } }, - "\/vectorsdb\/{databaseId}\/collections": { - "get": { - "summary": "List collections", - "operationId": "vectorsDBListCollections", + "\/users\/md5": { + "post": { + "summary": "Create user with MD5 password", + "operationId": "usersCreateMD5User", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "VectorsDB Collections List", + "201": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/vectorsdbCollectionList" + "$ref": "#\/components\/schemas\/user" } } } @@ -49318,23 +49823,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "listCollections", - "group": "collections", - "weight": 823, + "method": "createMD5User", + "group": "users", + "weight": 64, "cookies": false, "type": "", - "demo": "vectorsdb\/list-collections.md", + "demo": "users\/create-md-5-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-collections.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md", "auth": { "Project": [], "Key": [] @@ -49346,68 +49851,61 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "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", - "x-example": false, - "default": true - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using MD5.", + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } + } } - ] - }, + } + } + }, + "\/users\/phpass": { "post": { - "summary": "Create collection", - "operationId": "vectorsDBCreateCollection", + "summary": "Create user with PHPass password", + "operationId": "usersCreatePHPassUser", "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { "201": { - "description": "VectorsDB Collection", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/vectorsdbCollection" + "$ref": "#\/components\/schemas\/user" } } } @@ -49415,23 +49913,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createCollection", - "group": "collections", - "weight": 819, + "method": "createPHPassUser", + "group": "users", + "weight": 67, "cookies": false, "type": "", - "demo": "vectorsdb\/create-collection.md", + "demo": "users\/create-ph-pass-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md", "auth": { "Project": [], "Key": [] @@ -49443,63 +49941,39 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "collectionId": { + "userId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" + "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "name": { + "email": { "type": "string", - "description": "Collection name. Max length: 128 chars.", - "x-example": "" - }, - "dimension": { - "type": "integer", - "description": "Embedding dimension.", - "x-example": 1, - "format": "int32" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } + "description": "User email.", + "x-example": "email@example.com", + "format": "email" }, - "documentSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false + "password": { + "type": "string", + "description": "User password hashed using PHPass.", + "x-example": "password", + "format": "password" }, - "enabled": { - "type": "boolean", - "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", - "x-example": false + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" } }, "required": [ - "collectionId", - "name", - "dimension" + "userId", + "email", + "password" ] } } @@ -49507,21 +49981,21 @@ } } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}": { - "get": { - "summary": "Get collection", - "operationId": "vectorsDBGetCollection", + "\/users\/scrypt": { + "post": { + "summary": "Create user with Scrypt password", + "operationId": "usersCreateScryptUser", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "VectorsDB Collection", + "201": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/vectorsdbCollection" + "$ref": "#\/components\/schemas\/user" } } } @@ -49529,23 +50003,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "getCollection", - "group": "collections", - "weight": 820, + "method": "createScryptUser", + "group": "users", + "weight": 68, "cookies": false, "type": "", - "demo": "vectorsdb\/get-collection.md", + "demo": "users\/create-scrypt-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md", "auth": { "Project": [], "Key": [] @@ -49557,43 +50031,95 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Scrypt.", + "x-example": "password", + "format": "password" + }, + "passwordSalt": { + "type": "string", + "description": "Optional salt used to hash password.", + "x-example": "" + }, + "passwordCpu": { + "type": "integer", + "description": "Optional CPU cost used to hash password.", + "x-example": null, + "format": "int32" + }, + "passwordMemory": { + "type": "integer", + "description": "Optional memory cost used to hash password.", + "x-example": null, + "format": "int32" + }, + "passwordParallel": { + "type": "integer", + "description": "Optional parallelization cost used to hash password.", + "x-example": null, + "format": "int32" + }, + "passwordLength": { + "type": "integer", + "description": "Optional hash length used to hash password.", + "x-example": null, + "format": "int32" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password", + "passwordSalt", + "passwordCpu", + "passwordMemory", + "passwordParallel", + "passwordLength" + ] + } + } } - ] - }, - "put": { - "summary": "Update collection", - "operationId": "vectorsDBUpdateCollection", + } + } + }, + "\/users\/scrypt-modified": { + "post": { + "summary": "Create user with Scrypt modified password", + "operationId": "usersCreateScryptModifiedUser", "tags": [ - "vectorsDB" + "users" ], - "description": "Update a collection by its unique ID.", + "description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "VectorsDB Collection", + "201": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/vectorsdbCollection" + "$ref": "#\/components\/schemas\/user" } } } @@ -49601,23 +50127,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateCollection", - "group": "collections", - "weight": 821, + "method": "createScryptModifiedUser", + "group": "users", + "weight": 69, "cookies": false, "type": "", - "demo": "vectorsdb\/update-collection.md", + "demo": "users\/create-scrypt-modified-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md", "auth": { "Project": [], "Key": [] @@ -49629,103 +50155,103 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "name": { + "userId": { "type": "string", - "description": "Collection name. Max length: 128 chars.", - "x-example": "" + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" }, - "dimension": { - "type": "integer", - "description": "Embedding dimensions.", - "x-example": 1, - "format": "int32" + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } + "password": { + "type": "string", + "description": "User password hashed using Scrypt Modified.", + "x-example": "password", + "format": "password" }, - "documentSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": false + "passwordSalt": { + "type": "string", + "description": "Salt used to hash password.", + "x-example": "" }, - "enabled": { - "type": "boolean", - "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", - "x-example": false + "passwordSaltSeparator": { + "type": "string", + "description": "Salt separator used to hash password.", + "x-example": "" + }, + "passwordSignerKey": { + "type": "string", + "description": "Signer key used to hash password.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" } }, "required": [ - "name" + "userId", + "email", + "password", + "passwordSalt", + "passwordSaltSeparator", + "passwordSignerKey" ] } } } } - }, - "delete": { - "summary": "Delete collection", - "operationId": "vectorsDBDeleteCollection", + } + }, + "\/users\/sha": { + "post": { + "summary": "Create user with SHA password", + "operationId": "usersCreateSHAUser", "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteCollection", - "group": "collections", - "weight": 822, + "method": "createSHAUser", + "group": "users", + "weight": 66, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-collection.md", + "demo": "users\/create-sha-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md", "auth": { "Project": [], "Key": [] @@ -49737,167 +50263,200 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents": { - "get": { - "summary": "List documents", - "operationId": "vectorsDBListDocuments", - "tags": [ - "vectorsDB" - ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Documents List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/documentList" - } - } - } + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using SHA.", + "x-example": "password", + "format": "password" + }, + "passwordVersion": { + "type": "string", + "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", + "x-example": "sha1", + "enum": [ + "sha1", + "sha224", + "sha256", + "sha384", + "sha512\/224", + "sha512\/256", + "sha512", + "sha3-224", + "sha3-256", + "sha3-384", + "sha3-512" + ], + "x-enum-name": "PasswordHash", + "x-enum-keys": [] + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } + } + } + } + } + }, + "\/users\/{userId}": { + "get": { + "summary": "Get user", + "operationId": "usersGet", + "tags": [ + "users" + ], + "description": "Get a user by its unique ID.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "listDocuments", - "group": "documents", - "weight": 833, + "method": "get", + "group": "users", + "weight": 72, "cookies": false, "type": "", - "demo": "vectorsdb\/list-documents.md", + "demo": "users\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.read", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, + } + ] + }, + "delete": { + "summary": "Delete user", + "operationId": "usersDelete", + "tags": [ + "users" + ], + "description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "users", + "weight": 101, + "cookies": false, + "type": "", + "demo": "users\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "schema": { - "type": "string", - "x-example": "" - }, - "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", - "x-example": false, - "default": true - }, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" } ] - }, - "post": { - "summary": "Create document", - "operationId": "vectorsDBCreateDocument", + } + }, + "\/users\/{userId}\/email": { + "patch": { + "summary": "Update email", + "operationId": "usersUpdateEmail", "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Update the user email by its unique ID.", "responses": { - "201": { - "description": "Document", + "200": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/user" } } } @@ -49905,117 +50464,42 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDocument", - "group": "documents", - "weight": 829, + "method": "updateEmail", + "group": "users", + "weight": 86, "cookies": false, "type": "", - "demo": "vectorsdb\/create-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-email.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", - "methods": [ - { - "name": "createDocument", - "namespace": "vectorsDB", - "desc": "Create document", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions" - ], - "required": [ - "databaseId", - "collectionId", - "documentId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/document" - } - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-document.md", - "public": true - }, - { - "name": "createDocuments", - "namespace": "vectorsDB", - "desc": "Create documents", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/documentList" - } - ], - "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-documents.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -50026,57 +50510,37 @@ "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { + "email": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" + "description": "User email.", + "x-example": "email@example.com", + "format": "email" } - } + }, + "required": [ + "email" + ] } } } } - }, - "put": { - "summary": "Upsert documents", - "operationId": "vectorsDBUpsertDocuments", + } + }, + "\/users\/{userId}\/impersonator": { + "patch": { + "summary": "Update user impersonator capability", + "operationId": "usersUpdateImpersonator", "tags": [ - "vectorsDB" + "users" ], - "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "description": "Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.\n", "responses": { - "201": { - "description": "Documents List", + "200": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/user" } } } @@ -50084,54 +50548,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "upsertDocuments", - "group": "documents", - "weight": 836, + "method": "updateImpersonator", + "group": "users", + "weight": 82, "cookies": false, "type": "", - "demo": "vectorsdb\/upsert-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-impersonator.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-documents.md", - "methods": [ - { - "name": "upsertDocuments", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/documentList" - } - ], - "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", - "demo": "vectorsdb\/upsert-documents.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-impersonator.md", "auth": { "Project": [], "Key": [] @@ -50145,22 +50578,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -50171,42 +50594,36 @@ "schema": { "type": "object", "properties": { - "documents": { - "type": "array", - "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" + "impersonator": { + "type": "boolean", + "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", + "x-example": false } }, "required": [ - "documents" + "impersonator" ] } } } } - }, - "patch": { - "summary": "Update documents", - "operationId": "vectorsDBUpdateDocuments", + } + }, + "\/users\/{userId}\/jwts": { + "post": { + "summary": "Create user JWT", + "operationId": "usersCreateJWT", "tags": [ - "vectorsDB" + "users" ], - "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.", "responses": { - "200": { - "description": "Documents List", + "201": { + "description": "JWT", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/jwt" } } } @@ -50214,23 +50631,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDocuments", - "group": "documents", - "weight": 835, + "method": "createJWT", + "group": "sessions", + "weight": 104, "cookies": false, "type": "", - "demo": "vectorsdb\/update-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/create-jwt.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md", "auth": { "Project": [], "Key": [] @@ -50244,22 +50661,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -50270,44 +50677,39 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "x-example": "{}" - }, - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { + "sessionId": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" + "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", + "x-example": "" + }, + "duration": { + "type": "integer", + "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", + "x-example": 0, + "format": "int32" } } } } } } - }, - "delete": { - "summary": "Delete documents", - "operationId": "vectorsDBDeleteDocuments", + } + }, + "\/users\/{userId}\/labels": { + "put": { + "summary": "Update user labels", + "operationId": "usersUpdateLabels", "tags": [ - "vectorsDB" + "users" ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.", "responses": { "200": { - "description": "Documents List", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/user" } } } @@ -50315,23 +50717,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteDocuments", - "group": "documents", - "weight": 837, + "method": "updateLabels", + "group": "users", + "weight": 81, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-documents.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-labels.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md", "auth": { "Project": [], "Key": [] @@ -50345,22 +50747,12 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -50371,41 +50763,39 @@ "schema": { "type": "object", "properties": { - "queries": { + "labels": { "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", "x-example": null, "items": { "type": "string" } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" } - } + }, + "required": [ + "labels" + ] } } } } } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "\/users\/{userId}\/logs": { "get": { - "summary": "Get document", - "operationId": "vectorsDBGetDocument", + "summary": "List user logs", + "operationId": "usersListLogs", "tags": [ - "vectorsDB" + "users" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Get the user activity logs list by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Logs List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/logList" } } } @@ -50413,72 +50803,48 @@ }, "deprecated": false, "x-appwrite": { - "method": "getDocument", - "group": "documents", - "weight": 832, + "method": "listLogs", + "group": "logs", + "weight": 77, "cookies": false, "type": "", - "demo": "vectorsdb\/get-document.md", + "demo": "users\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.read", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "schema": { "type": "array", @@ -50490,31 +50856,34 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "boolean", + "x-example": false, + "default": true }, "in": "query" } ] - }, - "put": { - "summary": "Upsert a document", - "operationId": "vectorsDBUpsertDocument", + } + }, + "\/users\/{userId}\/memberships": { + "get": { + "summary": "List user memberships", + "operationId": "usersListMemberships", "tags": [ - "vectorsDB" + "users" ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Get the user membership list by its unique ID.", "responses": { - "201": { - "description": "Document", + "200": { + "description": "Memberships List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/membershipList" } } } @@ -50522,214 +50891,203 @@ }, "deprecated": false, "x-appwrite": { - "method": "upsertDocument", - "group": "documents", - "weight": 831, + "method": "listMemberships", + "group": "memberships", + "weight": 76, "cookies": false, "type": "", - "demo": "vectorsdb\/upsert-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/list-memberships.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.read", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-document.md", - "methods": [ - { - "name": "upsertDocument", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/components\/schemas\/document" - } - ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/upsert-document.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "documentId", - "description": "Document ID.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } + "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", + "x-example": false, + "default": true + }, + "in": "query" } - } - }, + ] + } + }, + "\/users\/{userId}\/mfa": { "patch": { - "summary": "Update document", - "operationId": "vectorsDBUpdateDocument", + "summary": "Update MFA", + "operationId": "usersUpdateMfa", "tags": [ - "vectorsDB" + "users" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Enable or disable MFA on a user account.", "responses": { "200": { - "description": "Document", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/user" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateDocument", - "group": "documents", - "weight": 830, + "method": "updateMfa", + "group": "users", + "weight": 91, "cookies": false, "type": "", - "demo": "vectorsdb\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-mfa.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-document.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFA" + }, + "methods": [ + { + "name": "updateMfa", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId", + "mfa" + ], + "required": [ + "userId", + "mfa" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/user" + } + ], + "description": "Enable or disable MFA on a user account.", + "demo": "users\/update-mfa.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFA" + } + }, + { + "name": "updateMFA", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId", + "mfa" + ], + "required": [ + "userId", + "mfa" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/user" + } + ], + "description": "Enable or disable MFA on a user account.", + "demo": "users\/update-mfa.md", + "public": true + } + ], "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -50740,165 +51098,250 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" + "mfa": { + "type": "boolean", + "description": "Enable or disable MFA.", + "x-example": false } - } + }, + "required": [ + "mfa" + ] } } } } - }, + } + }, + "\/users\/{userId}\/mfa\/authenticators\/{type}": { "delete": { - "summary": "Delete document", - "operationId": "vectorsDBDeleteDocument", + "summary": "Delete authenticator", + "operationId": "usersDeleteMfaAuthenticator", "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a document by its unique ID.", + "description": "Delete an authenticator app.", "responses": { "204": { "description": "No content" } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", - "weight": 834, + "method": "deleteMfaAuthenticator", + "group": "mfa", + "weight": 96, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/delete-mfa-authenticator.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-document.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.deleteMFAAuthenticator" + }, + "methods": [ + { + "name": "deleteMfaAuthenticator", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId", + "type" + ], + "required": [ + "userId", + "type" + ], + "responses": [ + { + "code": 204 + } + ], + "description": "Delete an authenticator app.", + "demo": "users\/delete-mfa-authenticator.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.deleteMFAAuthenticator" + } + }, + { + "name": "deleteMFAAuthenticator", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId", + "type" + ], + "required": [ + "userId", + "type" + ], + "responses": [ + { + "code": 204 + } + ], + "description": "Delete an authenticator app.", + "demo": "users\/delete-mfa-authenticator.md", + "public": true + } + ], "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "type", + "description": "Type of authenticator.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "totp", + "enum": [ + "totp" + ], + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [] }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "\/users\/{userId}\/mfa\/factors": { "get": { - "summary": "List indexes", - "operationId": "vectorsDBListIndexes", + "summary": "List factors", + "operationId": "usersListMfaFactors", "tags": [ - "vectorsDB" + "users" ], - "description": "List indexes in the collection.", + "description": "List the factors available on the account to be used as a MFA challange.", "responses": { "200": { - "description": "Indexes List", + "description": "MFAFactors", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/indexList" + "$ref": "#\/components\/schemas\/mfaFactors" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 828, + "method": "listMfaFactors", + "group": "mfa", + "weight": 92, "cookies": false, "type": "", - "demo": "vectorsdb\/list-indexes.md", + "demo": "users\/list-mfa-factors.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-indexes.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.listMFAFactors" + }, + "methods": [ + { + "name": "listMfaFactors", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaFactors" + } + ], + "description": "List the factors available on the account to be used as a MFA challange.", + "demo": "users\/list-mfa-factors.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.listMFAFactors" + } + }, + { + "name": "listMFAFactors", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaFactors" + } + ], + "description": "List the factors available on the account to be used as a MFA challange.", + "demo": "users\/list-mfa-factors.md", + "public": true + } + ], "auth": { "Project": [], "Key": [] @@ -50912,89 +51355,115 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", - "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", - "x-example": false, - "default": true - }, - "in": "query" } ] - }, - "post": { - "summary": "Create index", - "operationId": "vectorsDBCreateIndex", + } + }, + "\/users\/{userId}\/mfa\/recovery-codes": { + "get": { + "summary": "Get MFA recovery codes", + "operationId": "usersGetMfaRecoveryCodes", "tags": [ - "vectorsDB" + "users" ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", "responses": { - "202": { - "description": "Index", + "200": { + "description": "MFA Recovery Codes", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/mfaRecoveryCodes" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 825, + "method": "getMfaRecoveryCodes", + "group": "mfa", + "weight": 93, "cookies": false, "type": "", - "demo": "vectorsdb\/create-index.md", + "demo": "users\/get-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-index.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.getMFARecoveryCodes" + }, + "methods": [ + { + "name": "getMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/get-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.getMFARecoveryCodes" + } + }, + { + "name": "getMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/get-mfa-recovery-codes.md", + "public": true + } + ], "auth": { "Project": [], "Key": [] @@ -51008,207 +51477,113 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Index Key.", - "x-example": null - }, - "type": { - "type": "string", - "description": "Index type.", - "x-example": "hnsw_euclidean", - "enum": [ - "hnsw_euclidean", - "hnsw_dot", - "hnsw_cosine", - "object", - "key", - "unique" - ], - "x-enum-name": "VectorsDBIndexType", - "x-enum-keys": [] - }, - "attributes": { - "type": "array", - "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } - }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "x-example": null, - "items": { - "type": "integer" - } - } - }, - "required": [ - "key", - "type", - "attributes" - ] - } - } - } - } - } - }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { - "get": { - "summary": "Get index", - "operationId": "vectorsDBGetIndex", + ] + }, + "put": { + "summary": "Update MFA recovery codes (regenerate)", + "operationId": "usersUpdateMfaRecoveryCodes", "tags": [ - "vectorsDB" + "users" ], - "description": "Get index by ID.", + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", "responses": { "200": { - "description": "Index", + "description": "MFA Recovery Codes", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/mfaRecoveryCodes" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 826, + "method": "updateMfaRecoveryCodes", + "group": "mfa", + "weight": 95, "cookies": false, "type": "", - "demo": "vectorsdb\/get-index.md", + "demo": "users\/update-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-index.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFARecoveryCodes" }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete index", - "operationId": "vectorsDBDeleteIndex", - "tags": [ - "vectorsDB" - ], - "description": "Delete an index.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 827, - "cookies": false, - "type": "", - "demo": "vectorsdb\/delete-index.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" + "methods": [ + { + "name": "updateMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/update-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFARecoveryCodes" + } + }, + { + "name": "updateMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/update-mfa-recovery-codes.md", + "public": false + } ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-index.md", "auth": { "Project": [], "Key": [] @@ -51222,75 +51597,113 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } ] - } - }, - "\/webhooks": { - "get": { - "summary": "List webhooks", - "operationId": "webhooksList", + }, + "patch": { + "summary": "Create MFA recovery codes", + "operationId": "usersCreateMfaRecoveryCodes", "tags": [ - "webhooks" + "users" ], - "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", "responses": { - "200": { - "description": "Webhooks List", + "201": { + "description": "MFA Recovery Codes", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhookList" + "$ref": "#\/components\/schemas\/mfaRecoveryCodes" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "list", - "group": null, - "weight": 586, + "method": "createMfaRecoveryCodes", + "group": "mfa", + "weight": 94, "cookies": false, "type": "", - "demo": "webhooks\/list.md", + "demo": "users\/create-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, - "public": true, + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.createMFARecoveryCodes" + }, + "methods": [ + { + "name": "createMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "demo": "users\/create-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.createMFARecoveryCodes" + } + }, + { + "name": "createMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/mfaRecoveryCodes" + } + ], + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "demo": "users\/create-mfa-recovery-codes.md", + "public": true + } + ], "auth": { "Project": [], "Key": [] @@ -51304,45 +51717,33 @@ ], "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: name, url, authUsername, tls, events, enabled, logs, attempts", - "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, + "name": "userId", + "description": "User ID.", + "required": true, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" } ] - }, - "post": { - "summary": "Create webhook", - "operationId": "webhooksCreate", + } + }, + "\/users\/{userId}\/name": { + "patch": { + "summary": "Update name", + "operationId": "usersUpdateName", "tags": [ - "webhooks" + "users" ], - "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "description": "Update the user name by its unique ID.", "responses": { - "201": { - "description": "Webhook", + "200": { + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/user" } } } @@ -51350,22 +51751,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": null, - "weight": 585, + "method": "updateName", + "group": "users", + "weight": 84, "cookies": false, "type": "", - "demo": "webhooks\/create.md", + "demo": "users\/update-name.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md", "auth": { "Project": [], "Key": [] @@ -51377,67 +51779,32 @@ "Key": [] } ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { - "webhookId": { - "type": "string", - "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Webhook URL.", - "x-example": null - }, "name": { "type": "string", - "description": "Webhook name. Max length: 128 chars.", + "description": "User name. Max length: 128 chars.", "x-example": "" - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "x-example": false - }, - "tls": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "x-example": false - }, - "authUsername": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "x-example": "" - }, - "authPassword": { - "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "x-example": "" - }, - "secret": { - "type": "string", - "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", - "x-example": "", - "x-nullable": true } }, "required": [ - "webhookId", - "url", - "name", - "events" + "name" ] } } @@ -51445,21 +51812,21 @@ } } }, - "\/webhooks\/{webhookId}": { - "get": { - "summary": "Get webhook", - "operationId": "webhooksGet", + "\/users\/{userId}\/password": { + "patch": { + "summary": "Update password", + "operationId": "usersUpdatePassword", "tags": [ - "webhooks" + "users" ], - "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "description": "Update the user password by its unique ID.", "responses": { "200": { - "description": "Webhook", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/user" } } } @@ -51467,22 +51834,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": null, - "weight": 587, + "method": "updatePassword", + "group": "users", + "weight": 85, "cookies": false, "type": "", - "demo": "webhooks\/get.md", + "demo": "users\/update-password.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md", "auth": { "Project": [], "Key": [] @@ -51496,31 +51864,52 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] - }, - "put": { - "summary": "Update webhook", - "operationId": "webhooksUpdate", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "New user password. Must be at least 8 chars.", + "x-example": null + } + }, + "required": [ + "password" + ] + } + } + } + } + } + }, + "\/users\/{userId}\/phone": { + "patch": { + "summary": "Update phone", + "operationId": "usersUpdatePhone", "tags": [ - "webhooks" + "users" ], - "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "description": "Update the user phone by its unique ID.", "responses": { "200": { - "description": "Webhook", + "description": "User", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/user" } } } @@ -51528,22 +51917,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": null, - "weight": 589, + "method": "updatePhone", + "group": "users", + "weight": 87, "cookies": false, "type": "", - "demo": "webhooks\/update.md", + "demo": "users\/update-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md", "auth": { "Project": [], "Key": [] @@ -51557,12 +51947,12 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -51573,85 +51963,61 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Webhook URL.", - "x-example": null - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "x-example": false - }, - "tls": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "x-example": false - }, - "authUsername": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "x-example": "" - }, - "authPassword": { + "number": { "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "x-example": "" + "description": "User phone number.", + "x-example": "+12065550100", + "format": "phone" } }, "required": [ - "name", - "url", - "events" + "number" ] } } } } - }, - "delete": { - "summary": "Delete webhook", - "operationId": "webhooksDelete", + } + }, + "\/users\/{userId}\/prefs": { + "get": { + "summary": "Get user preferences", + "operationId": "usersGetPrefs", "tags": [ - "webhooks" + "users" ], - "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "description": "Get the user preferences by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Preferences", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/preferences" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": null, - "weight": 588, + "method": "getPrefs", + "group": "users", + "weight": 73, "cookies": false, "type": "", - "demo": "webhooks\/delete.md", + "demo": "users\/get-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md", "auth": { "Project": [], "Key": [] @@ -51665,33 +52031,31 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] - } - }, - "\/webhooks\/{webhookId}\/secret": { + }, "patch": { - "summary": "Update webhook secret key", - "operationId": "webhooksUpdateSecret", + "summary": "Update user preferences", + "operationId": "usersUpdatePrefs", "tags": [ - "webhooks" + "users" ], - "description": "Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.", + "description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.", "responses": { "200": { - "description": "Webhook", + "description": "Preferences", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/webhook" + "$ref": "#\/components\/schemas\/preferences" } } } @@ -51699,22 +52063,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateSecret", - "group": null, - "weight": 590, + "method": "updatePrefs", + "group": "users", + "weight": 89, "cookies": false, "type": "", - "demo": "webhooks\/update-secret.md", + "demo": "users\/update-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md", "auth": { "Project": [], "Key": [] @@ -51728,12 +52093,4447 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "prefs": { + "type": "object", + "description": "Prefs key-value JSON object.", + "x-example": "{}" + } + }, + "required": [ + "prefs" + ] + } + } + } + } + } + }, + "\/users\/{userId}\/sessions": { + "get": { + "summary": "List user sessions", + "operationId": "usersListSessions", + "tags": [ + "users" + ], + "description": "Get the user sessions list by its unique ID.", + "responses": { + "200": { + "description": "Sessions List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/sessionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listSessions", + "group": "sessions", + "weight": 75, + "cookies": false, + "type": "", + "demo": "users\/list-sessions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.read", + "sessions.read" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create session", + "operationId": "usersCreateSession", + "tags": [ + "users" + ], + "description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.", + "responses": { + "201": { + "description": "Session", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/session" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSession", + "group": "sessions", + "weight": 97, + "cookies": false, + "type": "", + "demo": "users\/create-session.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete user sessions", + "operationId": "usersDeleteSessions", + "tags": [ + "users" + ], + "description": "Delete all user's sessions by using the user's unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSessions", + "group": "sessions", + "weight": 100, + "cookies": false, + "type": "", + "demo": "users\/delete-sessions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/users\/{userId}\/sessions\/{sessionId}": { + "delete": { + "summary": "Delete user session", + "operationId": "usersDeleteSession", + "tags": [ + "users" + ], + "description": "Delete a user sessions by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSession", + "group": "sessions", + "weight": 99, + "cookies": false, + "type": "", + "demo": "users\/delete-session.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "sessionId", + "description": "Session ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/users\/{userId}\/status": { + "patch": { + "summary": "Update user status", + "operationId": "usersUpdateStatus", + "tags": [ + "users" + ], + "description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateStatus", + "group": "users", + "weight": 80, + "cookies": false, + "type": "", + "demo": "users\/update-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", + "x-example": false + } + }, + "required": [ + "status" + ] + } + } + } + } + } + }, + "\/users\/{userId}\/targets": { + "get": { + "summary": "List user targets", + "operationId": "usersListTargets", + "tags": [ + "users" + ], + "description": "List the messaging targets that are associated with a user.", + "responses": { + "200": { + "description": "Target list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/targetList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTargets", + "group": "targets", + "weight": 78, + "cookies": false, + "type": "", + "demo": "users\/list-targets.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.read", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create user target", + "operationId": "usersCreateTarget", + "tags": [ + "users" + ], + "description": "Create a messaging target.", + "responses": { + "201": { + "description": "Target", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/target" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTarget", + "group": "targets", + "weight": 70, + "cookies": false, + "type": "", + "demo": "users\/create-target.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.write", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "targetId": { + "type": "string", + "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "providerType": { + "type": "string", + "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", + "x-example": "email", + "enum": [ + "email", + "sms", + "push" + ], + "x-enum-name": "MessagingProviderType", + "x-enum-keys": [] + }, + "identifier": { + "type": "string", + "description": "The target identifier (token, email, phone etc.)", + "x-example": "" + }, + "providerId": { + "type": "string", + "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "x-example": "" + } + }, + "required": [ + "targetId", + "providerType", + "identifier" + ] + } + } + } + } + } + }, + "\/users\/{userId}\/targets\/{targetId}": { + "get": { + "summary": "Get user target", + "operationId": "usersGetTarget", + "tags": [ + "users" + ], + "description": "Get a user's push notification target by ID.", + "responses": { + "200": { + "description": "Target", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/target" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTarget", + "group": "targets", + "weight": 74, + "cookies": false, + "type": "", + "demo": "users\/get-target.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.read", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "patch": { + "summary": "Update user target", + "operationId": "usersUpdateTarget", + "tags": [ + "users" + ], + "description": "Update a messaging target.", + "responses": { + "200": { + "description": "Target", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/target" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTarget", + "group": "targets", + "weight": 90, + "cookies": false, + "type": "", + "demo": "users\/update-target.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.write", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "description": "The target identifier (token, email, phone etc.)", + "x-example": "" + }, + "providerId": { + "type": "string", + "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "x-example": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete user target", + "operationId": "usersDeleteTarget", + "tags": [ + "users" + ], + "description": "Delete a messaging target.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTarget", + "group": "targets", + "weight": 102, + "cookies": false, + "type": "", + "demo": "users\/delete-target.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.write", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/users\/{userId}\/tokens": { + "post": { + "summary": "Create token", + "operationId": "usersCreateToken", + "tags": [ + "users" + ], + "description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n", + "responses": { + "201": { + "description": "Token", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/token" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createToken", + "group": "sessions", + "weight": 98, + "cookies": false, + "type": "", + "demo": "users\/create-token.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "length": { + "type": "integer", + "description": "Token length in characters. The default length is 6 characters", + "x-example": 4, + "format": "int32" + }, + "expire": { + "type": "integer", + "description": "Token expiration period in seconds. The default expiration is 15 minutes.", + "x-example": 60, + "format": "int32" + } + } + } + } + } + } + } + }, + "\/users\/{userId}\/verification": { + "patch": { + "summary": "Update email verification", + "operationId": "usersUpdateEmailVerification", + "tags": [ + "users" + ], + "description": "Update the user email verification status by its unique ID.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateEmailVerification", + "group": "users", + "weight": 88, + "cookies": false, + "type": "", + "demo": "users\/update-email-verification.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "emailVerification": { + "type": "boolean", + "description": "User email verification status.", + "x-example": false + } + }, + "required": [ + "emailVerification" + ] + } + } + } + } + } + }, + "\/users\/{userId}\/verification\/phone": { + "patch": { + "summary": "Update phone verification", + "operationId": "usersUpdatePhoneVerification", + "tags": [ + "users" + ], + "description": "Update the user phone verification status by its unique ID.", + "responses": { + "200": { + "description": "User", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/user" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePhoneVerification", + "group": "users", + "weight": 83, + "cookies": false, + "type": "", + "demo": "users\/update-phone-verification.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "phoneVerification": { + "type": "boolean", + "description": "User phone verification status.", + "x-example": false + } + }, + "required": [ + "phoneVerification" + ] + } + } + } + } + } + }, + "\/vectorsdb": { + "get": { + "summary": "List databases", + "operationId": "vectorsDBList", + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Databases List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/databaseList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": "vectorsdb", + "weight": 868, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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 columns: name", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create database", + "operationId": "vectorsDBCreate", + "tags": [ + "vectorsDB" + ], + "description": "Create a new Database.\n", + "responses": { + "201": { + "description": "Database", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/database" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": "vectorsdb", + "weight": 864, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "databaseId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "databaseId", + "name" + ] + } + } + } + } + } + }, + "\/vectorsdb\/embeddings\/text": { + "post": { + "summary": "Create Text Embeddings", + "operationId": "vectorsDBCreateTextEmbeddings", + "tags": [ + "vectorsDB" + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "200": { + "description": "Embedding list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/embeddingList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTextEmbeddings", + "group": "documents", + "weight": 890, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-text-embeddings.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "methods": [ + { + "name": "createTextEmbeddings", + "namespace": "vectorsDB", + "desc": "Create Text Embedding", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "texts", + "model" + ], + "required": [ + "texts" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/embeddingList" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-text-embeddings.md", + "public": true + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "texts": { + "type": "array", + "description": "Array of text to generate embeddings.", + "x-example": null, + "items": { + "type": "string" + } + }, + "model": { + "type": "string", + "description": "The embedding model to use for generating vector embeddings.", + "x-example": "embeddinggemma", + "enum": [ + "embeddinggemma" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "texts" + ] + } + } + } + } + } + }, + "\/vectorsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "vectorsDBListTransactions", + "tags": [ + "vectorsDB" + ], + "description": "List transactions across all databases.", + "responses": { + "200": { + "description": "Transaction List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transactionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "weight": 895, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-transactions.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "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).", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create transaction", + "operationId": "vectorsDBCreateTransaction", + "tags": [ + "vectorsDB" + ], + "description": "Create a new transaction.", + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 891, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "x-example": 60, + "format": "int32" + } + } + } + } + } + } + } + }, + "\/vectorsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "vectorsDBGetTransaction", + "tags": [ + "vectorsDB" + ], + "description": "Get a transaction by its unique ID.", + "responses": { + "200": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransaction", + "group": "transactions", + "weight": 892, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "patch": { + "summary": "Update transaction", + "operationId": "vectorsDBUpdateTransaction", + "tags": [ + "vectorsDB" + ], + "description": "Update a transaction, to either commit or roll back its operations.", + "responses": { + "200": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "weight": 893, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "x-example": false + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete transaction", + "operationId": "vectorsDBDeleteTransaction", + "tags": [ + "vectorsDB" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 894, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "vectorsDBCreateOperations", + "tags": [ + "vectorsDB" + ], + "description": "Create multiple operations in a single transaction.", + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 896, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-operations.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "operations": { + "type": "array", + "description": "Array of staged operations.", + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "vectorsDBGet", + "tags": [ + "vectorsDB" + ], + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "responses": { + "200": { + "description": "Database", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/database" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "vectorsdb", + "weight": 865, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update database", + "operationId": "vectorsDBUpdate", + "tags": [ + "vectorsDB" + ], + "description": "Update a database by its unique ID.", + "responses": { + "200": { + "description": "Database", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/database" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": "vectorsdb", + "weight": 866, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete database", + "operationId": "vectorsDBDelete", + "tags": [ + "vectorsDB" + ], + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "vectorsdb", + "weight": 867, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections": { + "get": { + "summary": "List collections", + "operationId": "vectorsDBListCollections", + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "VectorsDB Collections List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vectorsdbCollectionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollections", + "group": "collections", + "weight": 875, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-collections.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-collections.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create collection", + "operationId": "vectorsDBCreateCollection", + "tags": [ + "vectorsDB" + ], + "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "VectorsDB Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vectorsdbCollection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createCollection", + "group": "collections", + "weight": 871, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "collectionId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Collection name. Max length: 128 chars.", + "x-example": "" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimension.", + "x-example": 1, + "format": "int32" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "collectionId", + "name", + "dimension" + ] + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}": { + "get": { + "summary": "Get collection", + "operationId": "vectorsDBGetCollection", + "tags": [ + "vectorsDB" + ], + "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "responses": { + "200": { + "description": "VectorsDB Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vectorsdbCollection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollection", + "group": "collections", + "weight": 872, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update collection", + "operationId": "vectorsDBUpdateCollection", + "tags": [ + "vectorsDB" + ], + "description": "Update a collection by its unique ID.", + "responses": { + "200": { + "description": "VectorsDB Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/vectorsdbCollection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateCollection", + "group": "collections", + "weight": 873, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Collection name. Max length: 128 chars.", + "x-example": "" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimensions.", + "x-example": 1, + "format": "int32" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete collection", + "operationId": "vectorsDBDeleteCollection", + "tags": [ + "vectorsDB" + ], + "description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteCollection", + "group": "collections", + "weight": 874, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "vectorsDBListDocuments", + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDocuments", + "group": "documents", + "weight": 885, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-documents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-documents.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "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", + "x-example": false, + "default": true + }, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "vectorsDBCreateDocument", + "tags": [ + "vectorsDB" + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 881, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "vectorsDB", + "desc": "Create document", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-document.md", + "public": true + }, + { + "name": "createDocuments", + "namespace": "vectorsDB", + "desc": "Create documents", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-documents.md", + "public": true + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "documentId": { + "type": "string", + "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "put": { + "summary": "Upsert documents", + "operationId": "vectorsDBUpsertDocuments", + "tags": [ + "vectorsDB" + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 888, + "cookies": false, + "type": "", + "demo": "vectorsdb\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-documents.md", + "methods": [ + { + "name": "upsertDocuments", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "demo": "vectorsdb\/upsert-documents.md", + "public": true + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + }, + "required": [ + "documents" + ] + } + } + } + } + }, + "patch": { + "summary": "Update documents", + "operationId": "vectorsDBUpdateDocuments", + "tags": [ + "vectorsDB" + ], + "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 887, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-documents.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete documents", + "operationId": "vectorsDBDeleteDocuments", + "tags": [ + "vectorsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 889, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-documents.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "vectorsDBGetDocument", + "tags": [ + "vectorsDB" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 884, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + } + ] + }, + "put": { + "summary": "Upsert a document", + "operationId": "vectorsDBUpsertDocument", + "tags": [ + "vectorsDB" + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 883, + "cookies": false, + "type": "", + "demo": "vectorsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "responses": [ + { + "code": 201, + "model": "#\/components\/schemas\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/upsert-document.md", + "public": true + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "patch": { + "summary": "Update document", + "operationId": "vectorsDBUpdateDocument", + "tags": [ + "vectorsDB" + ], + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 882, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete document", + "operationId": "vectorsDBDeleteDocument", + "tags": [ + "vectorsDB" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 886, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "vectorsDBListIndexes", + "tags": [ + "vectorsDB" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/indexList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 880, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-indexes.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "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: key, type, status, attributes, error", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "vectorsDBCreateIndex", + "tags": [ + "vectorsDB" + ], + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "responses": { + "202": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/index" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 877, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-index.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "hnsw_euclidean", + "enum": [ + "hnsw_euclidean", + "hnsw_dot", + "hnsw_cosine", + "object", + "key", + "unique" + ], + "x-enum-name": "VectorsDBIndexType", + "x-enum-keys": [] + }, + "attributes": { + "type": "array", + "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "attributes" + ] + } + } + } + } + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "vectorsDBGetIndex", + "tags": [ + "vectorsDB" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/index" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 878, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-index.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "vectorsDBDeleteIndex", + "tags": [ + "vectorsDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 879, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-index.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/webhooks": { + "get": { + "summary": "List webhooks", + "operationId": "webhooksList", + "tags": [ + "webhooks" + ], + "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Webhooks List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhookList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 567, + "cookies": false, + "type": "", + "demo": "webhooks\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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: name, url, authUsername, tls, events, enabled, logs, attempts", + "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", + "x-example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create webhook", + "operationId": "webhooksCreate", + "tags": [ + "webhooks" + ], + "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "responses": { + "201": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 566, + "cookies": false, + "type": "", + "demo": "webhooks\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "webhookId": { + "type": "string", + "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "x-example": null + }, + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "x-example": "" + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "x-example": false + }, + "tls": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "x-example": false + }, + "authUsername": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "x-example": "" + }, + "authPassword": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "x-example": "" + }, + "secret": { + "type": "string", + "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "webhookId", + "url", + "name", + "events" + ] + } + } + } + } + } + }, + "\/webhooks\/{webhookId}": { + "get": { + "summary": "Get webhook", + "operationId": "webhooksGet", + "tags": [ + "webhooks" + ], + "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 568, + "cookies": false, + "type": "", + "demo": "webhooks\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update webhook", + "operationId": "webhooksUpdate", + "tags": [ + "webhooks" + ], + "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 570, + "cookies": false, + "type": "", + "demo": "webhooks\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "x-example": "" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "x-example": null + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "x-example": false + }, + "tls": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "x-example": false + }, + "authUsername": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "x-example": "" + }, + "authPassword": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "x-example": "" + } + }, + "required": [ + "name", + "url", + "events" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete webhook", + "operationId": "webhooksDelete", + "tags": [ + "webhooks" + ], + "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 569, + "cookies": false, + "type": "", + "demo": "webhooks\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/webhooks\/{webhookId}\/secret": { + "patch": { + "summary": "Update webhook secret key", + "operationId": "webhooksUpdateSecret", + "tags": [ + "webhooks" + ], + "description": "Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.", + "responses": { + "200": { + "description": "Webhook", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/webhook" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSecret", + "group": null, + "weight": 571, + "cookies": false, + "type": "", + "demo": "webhooks\/update-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -52718,6 +57518,132 @@ "variables": "" } }, + "mockNumberList": { + "description": "Mock Numbers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of mockNumbers that matched your query.", + "x-example": 5, + "format": "int32" + }, + "mockNumbers": { + "type": "array", + "description": "List of mockNumbers.", + "items": { + "$ref": "#\/components\/schemas\/mockNumber" + }, + "x-example": "" + } + }, + "required": [ + "total", + "mockNumbers" + ], + "example": { + "total": 5, + "mockNumbers": "" + } + }, + "policyList": { + "description": "Policies List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of policies in the given project.", + "x-example": 9, + "format": "int32" + }, + "policies": { + "type": "array", + "description": "List of policies.", + "items": { + "anyOf": [ + { + "$ref": "#\/components\/schemas\/policyPasswordDictionary" + }, + { + "$ref": "#\/components\/schemas\/policyPasswordHistory" + }, + { + "$ref": "#\/components\/schemas\/policyPasswordPersonalData" + }, + { + "$ref": "#\/components\/schemas\/policySessionAlert" + }, + { + "$ref": "#\/components\/schemas\/policySessionDuration" + }, + { + "$ref": "#\/components\/schemas\/policySessionInvalidation" + }, + { + "$ref": "#\/components\/schemas\/policySessionLimit" + }, + { + "$ref": "#\/components\/schemas\/policyUserLimit" + }, + { + "$ref": "#\/components\/schemas\/policyMembershipPrivacy" + } + ], + "discriminator": { + "propertyName": "$id", + "mapping": { + "password-dictionary": "#\/components\/schemas\/policyPasswordDictionary", + "password-history": "#\/components\/schemas\/policyPasswordHistory", + "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", + "session-alert": "#\/components\/schemas\/policySessionAlert", + "session-duration": "#\/components\/schemas\/policySessionDuration", + "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", + "session-limit": "#\/components\/schemas\/policySessionLimit", + "user-limit": "#\/components\/schemas\/policyUserLimit", + "membership-privacy": "#\/components\/schemas\/policyMembershipPrivacy" + } + } + }, + "x-example": "" + } + }, + "required": [ + "total", + "policies" + ], + "example": { + "total": 9, + "policies": "" + } + }, + "emailTemplateList": { + "description": "Email Templates List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of templates that matched your query.", + "x-example": 5, + "format": "int32" + }, + "templates": { + "type": "array", + "description": "List of templates.", + "items": { + "$ref": "#\/components\/schemas\/emailTemplate" + }, + "x-example": "" + } + }, + "required": [ + "total", + "templates" + ], + "example": { + "total": 5, + "templates": "" + } + }, "healthStatusList": { "description": "Status List", "type": "object", @@ -57192,340 +62118,929 @@ "encrypt": false } }, - "columnText": { - "description": "ColumnText", + "columnText": { + "description": "ColumnText", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false + } + }, + "columnMediumtext": { + "description": "ColumnMediumtext", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false + } + }, + "columnLongtext": { + "description": "ColumnLongtext", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false + } + }, + "index": { + "description": "Index", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Index ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "key": { + "type": "string", + "description": "Index key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ] + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "attributes": { + "type": "array", + "description": "Index attributes.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index attributes length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "key", + "type", + "status", + "error", + "attributes", + "lengths" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "key": "index1", + "type": "primary", + "status": "available", + "error": "string", + "attributes": [], + "lengths": [], + "orders": [] + } + }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Index ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "key": { + "type": "string", + "description": "Index Key.", + "x-example": "index1" + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "key", + "type", + "status", + "error", + "columns", + "lengths" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "key": "index1", + "type": "primary", + "status": "available", + "error": "string", + "columns": [], + "lengths": [], + "orders": [] + } + }, + "row": { + "description": "Row", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Row ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$sequence": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Row sequence ID.", + "x-example": "1", + "readOnly": true }, - "status": { + "$tableId": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Table ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, - "error": { + "$databaseId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "Database ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Row creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Row update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] } }, + "additionalProperties": true, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", + "$sequence", + "$tableId", + "$databaseId", "$createdAt", - "$updatedAt" + "$updatedAt", + "$permissions" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$tableId": "5e5ea5c15117e", + "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "$permissions": [ + "read(\"any\")" + ] } }, - "columnMediumtext": { - "description": "ColumnMediumtext", + "document": { + "description": "Document", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Document ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$sequence": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Document sequence ID.", + "x-example": "1", + "readOnly": true }, - "status": { + "$collectionId": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Collection ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, - "error": { + "$databaseId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "description": "Database ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Document creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Document update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "$permissions": { + "type": "array", + "description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] } }, + "additionalProperties": true, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", + "$sequence", + "$collectionId", + "$databaseId", "$createdAt", - "$updatedAt" + "$updatedAt", + "$permissions" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$collectionId": "5e5ea5c15117e", + "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "$permissions": [ + "read(\"any\")" + ], + "username": "john.doe", + "email": "john.doe@example.com", + "fullName": "John Doe", + "age": 30, + "isAdmin": false } }, - "columnLongtext": { - "description": "ColumnLongtext", + "log": { + "description": "Log", "type": "object", "properties": { - "key": { + "event": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Event name.", + "x-example": "account.sessions.create" }, - "type": { + "userId": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", + "x-example": "610fc2f985ee0" }, - "status": { + "userEmail": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", + "x-example": "john@appwrite.io" }, - "error": { + "userName": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", + "x-example": "John Doe" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "mode": { + "type": "string", + "description": "API mode when event triggered.", + "x-example": "admin" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "nullable": true + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" }, - "$createdAt": { + "ip": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "IP session in use when the session was created.", + "x-example": "127.0.0.1" }, - "$updatedAt": { + "time": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Log creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "osCode": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true + "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", + "x-example": "Mac" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "osName": { + "type": "string", + "description": "Operating system name.", + "x-example": "Mac" + }, + "osVersion": { + "type": "string", + "description": "Operating system version.", + "x-example": "Mac" + }, + "clientType": { + "type": "string", + "description": "Client type.", + "x-example": "browser" + }, + "clientCode": { + "type": "string", + "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", + "x-example": "CM" + }, + "clientName": { + "type": "string", + "description": "Client name.", + "x-example": "Chrome Mobile iOS" + }, + "clientVersion": { + "type": "string", + "description": "Client version.", + "x-example": "84.0" + }, + "clientEngine": { + "type": "string", + "description": "Client engine name.", + "x-example": "WebKit" + }, + "clientEngineVersion": { + "type": "string", + "description": "Client engine name.", + "x-example": "605.1.15" + }, + "deviceName": { + "type": "string", + "description": "Device name.", + "x-example": "smartphone" + }, + "deviceBrand": { + "type": "string", + "description": "Device brand name.", + "x-example": "Google" + }, + "deviceModel": { + "type": "string", + "description": "Device model name.", + "x-example": "Nexus 5" + }, + "countryCode": { + "type": "string", + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" + }, + "countryName": { + "type": "string", + "description": "Country name.", + "x-example": "United States" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "event", + "userId", + "userEmail", + "userName", + "mode", + "userType", + "ip", + "time", + "osCode", + "osName", + "osVersion", + "clientType", + "clientCode", + "clientName", + "clientVersion", + "clientEngine", + "clientEngineVersion", + "deviceName", + "deviceBrand", + "deviceModel", + "countryCode", + "countryName" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "event": "account.sessions.create", + "userId": "610fc2f985ee0", + "userEmail": "john@appwrite.io", + "userName": "John Doe", + "mode": "admin", + "userType": "user", + "ip": "127.0.0.1", + "time": "2020-10-15T06:38:00.000+00:00", + "osCode": "Mac", + "osName": "Mac", + "osVersion": "Mac", + "clientType": "browser", + "clientCode": "CM", + "clientName": "Chrome Mobile iOS", + "clientVersion": "84.0", + "clientEngine": "WebKit", + "clientEngineVersion": "605.1.15", + "deviceName": "smartphone", + "deviceBrand": "Google", + "deviceModel": "Nexus 5", + "countryCode": "US", + "countryName": "United States" } }, - "index": { - "description": "Index", + "user": { + "description": "User", "type": "object", "properties": { "$id": { "type": "string", - "description": "Index ID.", + "description": "User ID.", "x-example": "5e5ea5c16897e" }, - "$createdAt": { + "$createdAt": { + "type": "string", + "description": "User creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "User update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "User name.", + "x-example": "John Doe" + }, + "password": { + "type": "string", + "description": "Hashed user password.", + "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "nullable": true + }, + "hash": { + "type": "string", + "description": "Password hashing algorithm.", + "x-example": "argon2", + "nullable": true + }, + "hashOptions": { + "type": "object", + "description": "Password hashing algorithm configuration.", + "x-example": {}, + "items": { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/algoArgon2" + }, + { + "$ref": "#\/components\/schemas\/algoScrypt" + }, + { + "$ref": "#\/components\/schemas\/algoScryptModified" + }, + { + "$ref": "#\/components\/schemas\/algoBcrypt" + }, + { + "$ref": "#\/components\/schemas\/algoPhpass" + }, + { + "$ref": "#\/components\/schemas\/algoSha" + }, + { + "$ref": "#\/components\/schemas\/algoMd5" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/components\/schemas\/algoArgon2", + "scrypt": "#\/components\/schemas\/algoScrypt", + "scryptMod": "#\/components\/schemas\/algoScryptModified", + "bcrypt": "#\/components\/schemas\/algoBcrypt", + "phpass": "#\/components\/schemas\/algoPhpass", + "sha": "#\/components\/schemas\/algoSha", + "md5": "#\/components\/schemas\/algoMd5" + } + } + }, + "nullable": true + }, + "registration": { + "type": "string", + "description": "User registration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "status": { + "type": "boolean", + "description": "User status. Pass `true` for enabled and `false` for disabled.", + "x-example": true + }, + "labels": { + "type": "array", + "description": "Labels for the user.", + "items": { + "type": "string" + }, + "x-example": [ + "vip" + ] + }, + "passwordUpdate": { "type": "string", - "description": "Index creation date in ISO 8601 format.", + "description": "Password update time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$updatedAt": { + "email": { "type": "string", - "description": "Index update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "User email address.", + "x-example": "john@appwrite.io" }, - "key": { + "phone": { "type": "string", - "description": "Index key.", - "x-example": "index1" + "description": "User phone number in E.164 format.", + "x-example": "+4930901820" }, - "type": { - "type": "string", - "description": "Index type.", - "x-example": "primary" + "emailVerification": { + "type": "boolean", + "description": "Email verification status.", + "x-example": true }, - "status": { - "type": "string", - "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ] + "phoneVerification": { + "type": "boolean", + "description": "Phone verification status.", + "x-example": true }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "mfa": { + "type": "boolean", + "description": "Multi factor authentication status.", + "x-example": true }, - "attributes": { - "type": "array", - "description": "Index attributes.", - "items": { - "type": "string" + "prefs": { + "type": "object", + "description": "User preferences as a key-value object", + "x-example": { + "theme": "pink", + "timezone": "UTC" }, - "x-example": [] + "items": { + "$ref": "#\/components\/schemas\/preferences" + } }, - "lengths": { + "targets": { "type": "array", - "description": "Index attributes length.", + "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", "items": { - "type": "integer", - "format": "int32" + "$ref": "#\/components\/schemas\/target" }, "x-example": [] }, - "orders": { - "type": "array", - "description": "Index orders.", - "items": { - "type": "string" - }, - "x-example": [], + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "impersonator": { + "type": "boolean", + "description": "Whether the user can impersonate other users.", + "x-example": false, + "nullable": true + }, + "impersonatorUserId": { + "type": "string", + "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", + "x-example": "5e5ea5c16897e", "nullable": true } }, @@ -57533,305 +63048,314 @@ "$id", "$createdAt", "$updatedAt", - "key", - "type", + "name", + "registration", "status", - "error", - "attributes", - "lengths" + "labels", + "passwordUpdate", + "email", + "phone", + "emailVerification", + "phoneVerification", + "mfa", + "prefs", + "targets", + "accessedAt" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "key": "index1", - "type": "primary", - "status": "available", - "error": "string", - "attributes": [], - "lengths": [], - "orders": [] + "name": "John Doe", + "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "hash": "argon2", + "hashOptions": {}, + "registration": "2020-10-15T06:38:00.000+00:00", + "status": true, + "labels": [ + "vip" + ], + "passwordUpdate": "2020-10-15T06:38:00.000+00:00", + "email": "john@appwrite.io", + "phone": "+4930901820", + "emailVerification": true, + "phoneVerification": true, + "mfa": true, + "prefs": { + "theme": "pink", + "timezone": "UTC" + }, + "targets": [], + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "impersonator": false, + "impersonatorUserId": "5e5ea5c16897e" } }, - "columnIndex": { - "description": "Index", + "algoMd5": { + "description": "AlgoMD5", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Index ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { + "type": { "type": "string", - "description": "Index creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { + "description": "Algo type.", + "x-example": "md5" + } + }, + "required": [ + "type" + ], + "example": { + "type": "md5" + } + }, + "algoSha": { + "description": "AlgoSHA", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Index update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "key": { + "description": "Algo type.", + "x-example": "sha" + } + }, + "required": [ + "type" + ], + "example": { + "type": "sha" + } + }, + "algoPhpass": { + "description": "AlgoPHPass", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Index Key.", - "x-example": "index1" - }, + "description": "Algo type.", + "x-example": "phpass" + } + }, + "required": [ + "type" + ], + "example": { + "type": "phpass" + } + }, + "algoBcrypt": { + "description": "AlgoBcrypt", + "type": "object", + "properties": { "type": { "type": "string", - "description": "Index type.", - "x-example": "primary" - }, - "status": { + "description": "Algo type.", + "x-example": "bcrypt" + } + }, + "required": [ + "type" + ], + "example": { + "type": "bcrypt" + } + }, + "algoScrypt": { + "description": "AlgoScrypt", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available" + "description": "Algo type.", + "x-example": "scrypt" }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "costCpu": { + "type": "integer", + "description": "CPU complexity of computed hash.", + "x-example": 8, + "format": "int32" }, - "columns": { - "type": "array", - "description": "Index columns.", - "items": { - "type": "string" - }, - "x-example": [] + "costMemory": { + "type": "integer", + "description": "Memory complexity of computed hash.", + "x-example": 14, + "format": "int32" }, - "lengths": { - "type": "array", - "description": "Index columns length.", - "items": { - "type": "integer", - "format": "int32" - }, - "x-example": [] + "costParallel": { + "type": "integer", + "description": "Parallelization of computed hash.", + "x-example": 1, + "format": "int32" }, - "orders": { - "type": "array", - "description": "Index orders.", - "items": { - "type": "string" - }, - "x-example": [], - "nullable": true + "length": { + "type": "integer", + "description": "Length used to compute hash.", + "x-example": 64, + "format": "int32" } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "key", "type", - "status", - "error", - "columns", - "lengths" + "costCpu", + "costMemory", + "costParallel", + "length" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "key": "index1", - "type": "primary", - "status": "available", - "error": "string", - "columns": [], - "lengths": [], - "orders": [] + "type": "scrypt", + "costCpu": 8, + "costMemory": 14, + "costParallel": 1, + "length": 64 } }, - "row": { - "description": "Row", + "algoScryptModified": { + "description": "AlgoScryptModified", "type": "object", "properties": { - "$id": { + "type": { "type": "string", - "description": "Row ID.", - "x-example": "5e5ea5c16897e" + "description": "Algo type.", + "x-example": "scryptMod" }, - "$sequence": { + "salt": { "type": "string", - "description": "Row sequence ID.", - "x-example": "1", - "readOnly": true + "description": "Salt used to compute hash.", + "x-example": "UxLMreBr6tYyjQ==" }, - "$tableId": { + "saltSeparator": { "type": "string", - "description": "Table ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "Separator used to compute hash.", + "x-example": "Bw==" }, - "$databaseId": { + "signerKey": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true - }, - "$createdAt": { + "description": "Key used to compute hash.", + "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + } + }, + "required": [ + "type", + "salt", + "saltSeparator", + "signerKey" + ], + "example": { + "type": "scryptMod", + "salt": "UxLMreBr6tYyjQ==", + "saltSeparator": "Bw==", + "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + } + }, + "algoArgon2": { + "description": "AlgoArgon2", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Row creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Algo type.", + "x-example": "argon2" }, - "$updatedAt": { - "type": "string", - "description": "Row update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "memoryCost": { + "type": "integer", + "description": "Memory used to compute hash.", + "x-example": 65536, + "format": "int32" }, - "$permissions": { - "type": "array", - "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "timeCost": { + "type": "integer", + "description": "Amount of time consumed to compute hash", + "x-example": 4, + "format": "int32" + }, + "threads": { + "type": "integer", + "description": "Number of threads used to compute hash.", + "x-example": 3, + "format": "int32" } }, - "additionalProperties": true, "required": [ - "$id", - "$sequence", - "$tableId", - "$databaseId", - "$createdAt", - "$updatedAt", - "$permissions" + "type", + "memoryCost", + "timeCost", + "threads" ], "example": { - "$id": "5e5ea5c16897e", - "$sequence": "1", - "$tableId": "5e5ea5c15117e", - "$databaseId": "5e5ea5c15117e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ] + "type": "argon2", + "memoryCost": 65536, + "timeCost": 4, + "threads": 3 } }, - "document": { - "description": "Document", + "preferences": { + "description": "Preferences", + "type": "object", + "additionalProperties": true, + "example": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } + }, + "session": { + "description": "Session", "type": "object", "properties": { "$id": { "type": "string", - "description": "Document ID.", + "description": "Session ID.", "x-example": "5e5ea5c16897e" }, - "$sequence": { - "type": "string", - "description": "Document sequence ID.", - "x-example": "1", - "readOnly": true - }, - "$collectionId": { - "type": "string", - "description": "Collection ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true - }, - "$databaseId": { - "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true - }, "$createdAt": { "type": "string", - "description": "Document creation date in ISO 8601 format.", + "description": "Session creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Document update date in ISO 8601 format.", + "description": "Session update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$permissions": { - "type": "array", - "description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - } - }, - "additionalProperties": true, - "required": [ - "$id", - "$sequence", - "$collectionId", - "$databaseId", - "$createdAt", - "$updatedAt", - "$permissions" - ], - "example": { - "$id": "5e5ea5c16897e", - "$sequence": "1", - "$collectionId": "5e5ea5c15117e", - "$databaseId": "5e5ea5c15117e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "username": "john.doe", - "email": "john.doe@example.com", - "fullName": "John Doe", - "age": 30, - "isAdmin": false - } - }, - "log": { - "description": "Log", - "type": "object", - "properties": { - "event": { + "userId": { "type": "string", - "description": "Event name.", - "x-example": "account.sessions.create" + "description": "User ID.", + "x-example": "5e5bb8c16897e" }, - "userId": { + "expire": { "type": "string", - "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", - "x-example": "610fc2f985ee0" + "description": "Session expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "provider": { + "type": "string", + "description": "Session Provider.", + "x-example": "email" }, - "userEmail": { + "providerUid": { "type": "string", - "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "john@appwrite.io" + "description": "Session Provider User ID.", + "x-example": "user@example.com" }, - "userName": { + "providerAccessToken": { "type": "string", - "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "John Doe" + "description": "Session Provider Access Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, - "mode": { + "providerAccessTokenExpiry": { "type": "string", - "description": "API mode when event triggered.", - "x-example": "admin" + "description": "The date of when the access token expires in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "userType": { + "providerRefreshToken": { "type": "string", - "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", - "x-example": "user" + "description": "Session Provider Refresh Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "ip": { "type": "string", - "description": "IP session in use when the session was created.", + "description": "IP in use when the session was created.", "x-example": "127.0.0.1" }, - "time": { - "type": "string", - "description": "Log creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, "osCode": { "type": "string", "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", @@ -57901,17 +63425,45 @@ "type": "string", "description": "Country name.", "x-example": "United States" + }, + "current": { + "type": "boolean", + "description": "Returns true if this the current user session.", + "x-example": true + }, + "factors": { + "type": "array", + "description": "Returns a list of active session factors.", + "items": { + "type": "string" + }, + "x-example": [ + "email" + ] + }, + "secret": { + "type": "string", + "description": "Secret used to authenticate the user. Only included if the request was made with an API key", + "x-example": "5e5bb8c16897e" + }, + "mfaUpdatedAt": { + "type": "string", + "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "event", + "$id", + "$createdAt", + "$updatedAt", "userId", - "userEmail", - "userName", - "mode", - "userType", + "expire", + "provider", + "providerUid", + "providerAccessToken", + "providerAccessTokenExpiry", + "providerRefreshToken", "ip", - "time", "osCode", "osName", "osVersion", @@ -57925,17 +63477,24 @@ "deviceBrand", "deviceModel", "countryCode", - "countryName" + "countryName", + "current", + "factors", + "secret", + "mfaUpdatedAt" ], "example": { - "event": "account.sessions.create", - "userId": "610fc2f985ee0", - "userEmail": "john@appwrite.io", - "userName": "John Doe", - "mode": "admin", - "userType": "user", + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5bb8c16897e", + "expire": "2020-10-15T06:38:00.000+00:00", + "provider": "email", + "providerUid": "user@example.com", + "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", + "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", "ip": "127.0.0.1", - "time": "2020-10-15T06:38:00.000+00:00", "osCode": "Mac", "osName": "Mac", "osVersion": "Mac", @@ -57949,1077 +63508,1718 @@ "deviceBrand": "Google", "deviceModel": "Nexus 5", "countryCode": "US", - "countryName": "United States" + "countryName": "United States", + "current": true, + "factors": [ + "email" + ], + "secret": "5e5bb8c16897e", + "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "user": { - "description": "User", + "identity": { + "description": "Identity", "type": "object", "properties": { "$id": { "type": "string", - "description": "User ID.", + "description": "Identity ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "User creation date in ISO 8601 format.", + "description": "Identity creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "User update date in ISO 8601 format.", + "description": "Identity update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "userId": { "type": "string", - "description": "User name.", - "x-example": "John Doe" + "description": "User ID.", + "x-example": "5e5bb8c16897e" }, - "password": { + "provider": { "type": "string", - "description": "Hashed user password.", - "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", - "nullable": true + "description": "Identity Provider.", + "x-example": "email" }, - "hash": { + "providerUid": { "type": "string", - "description": "Password hashing algorithm.", - "x-example": "argon2", - "nullable": true + "description": "ID of the User in the Identity Provider.", + "x-example": "5e5bb8c16897e" }, - "hashOptions": { - "type": "object", - "description": "Password hashing algorithm configuration.", - "x-example": {}, - "items": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/algoArgon2" - }, - { - "$ref": "#\/components\/schemas\/algoScrypt" - }, - { - "$ref": "#\/components\/schemas\/algoScryptModified" - }, - { - "$ref": "#\/components\/schemas\/algoBcrypt" - }, - { - "$ref": "#\/components\/schemas\/algoPhpass" - }, - { - "$ref": "#\/components\/schemas\/algoSha" - }, - { - "$ref": "#\/components\/schemas\/algoMd5" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/components\/schemas\/algoArgon2", - "scrypt": "#\/components\/schemas\/algoScrypt", - "scryptMod": "#\/components\/schemas\/algoScryptModified", - "bcrypt": "#\/components\/schemas\/algoBcrypt", - "phpass": "#\/components\/schemas\/algoPhpass", - "sha": "#\/components\/schemas\/algoSha", - "md5": "#\/components\/schemas\/algoMd5" - } - } - }, - "nullable": true + "providerEmail": { + "type": "string", + "description": "Email of the User in the Identity Provider.", + "x-example": "user@example.com" }, - "registration": { + "providerAccessToken": { "type": "string", - "description": "User registration date in ISO 8601 format.", + "description": "Identity Provider Access Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + }, + "providerAccessTokenExpiry": { + "type": "string", + "description": "The date of when the access token expires in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "providerRefreshToken": { + "type": "string", + "description": "Identity Provider Refresh Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "userId", + "provider", + "providerUid", + "providerEmail", + "providerAccessToken", + "providerAccessTokenExpiry", + "providerRefreshToken" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5bb8c16897e", + "provider": "email", + "providerUid": "5e5bb8c16897e", + "providerEmail": "user@example.com", + "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", + "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + } + }, + "token": { + "description": "Token", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Token ID.", + "x-example": "bb8ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Token creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "userId": { + "type": "string", + "description": "User ID.", + "x-example": "5e5ea5c168bb8" + }, + "secret": { + "type": "string", + "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" + }, + "expire": { + "type": "string", + "description": "Token expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "phrase": { + "type": "string", + "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", + "x-example": "Golden Fox" + } + }, + "required": [ + "$id", + "$createdAt", + "userId", + "secret", + "expire", + "phrase" + ], + "example": { + "$id": "bb8ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5ea5c168bb8", + "secret": "", + "expire": "2020-10-15T06:38:00.000+00:00", + "phrase": "Golden Fox" + } + }, + "jwt": { + "description": "JWT", + "type": "object", + "properties": { + "jwt": { + "type": "string", + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + }, + "required": [ + "jwt" + ], + "example": { + "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + }, + "locale": { + "description": "Locale", + "type": "object", + "properties": { + "ip": { + "type": "string", + "description": "User IP address.", + "x-example": "127.0.0.1" + }, + "countryCode": { + "type": "string", + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", + "x-example": "US" + }, + "country": { + "type": "string", + "description": "Country name. This field support localization.", + "x-example": "United States" + }, + "continentCode": { + "type": "string", + "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", + "x-example": "NA" + }, + "continent": { + "type": "string", + "description": "Continent name. This field support localization.", + "x-example": "North America" + }, + "eu": { "type": "boolean", - "description": "User status. Pass `true` for enabled and `false` for disabled.", - "x-example": true + "description": "True if country is part of the European Union.", + "x-example": false }, - "labels": { + "currency": { + "type": "string", + "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", + "x-example": "USD" + } + }, + "required": [ + "ip", + "countryCode", + "country", + "continentCode", + "continent", + "eu", + "currency" + ], + "example": { + "ip": "127.0.0.1", + "countryCode": "US", + "country": "United States", + "continentCode": "NA", + "continent": "North America", + "eu": false, + "currency": "USD" + } + }, + "localeCode": { + "description": "LocaleCode", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", + "x-example": "en-us" + }, + "name": { + "type": "string", + "description": "Locale name", + "x-example": "US" + } + }, + "required": [ + "code", + "name" + ], + "example": { + "code": "en-us", + "name": "US" + } + }, + "file": { + "description": "File", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "File ID.", + "x-example": "5e5ea5c16897e" + }, + "bucketId": { + "type": "string", + "description": "Bucket ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "File creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "File update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { "type": "array", - "description": "Labels for the user.", + "description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "items": { "type": "string" }, "x-example": [ - "vip" + "read(\"any\")" ] }, - "passwordUpdate": { + "name": { "type": "string", - "description": "Password update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "File name.", + "x-example": "Pink.png" }, - "email": { + "signature": { "type": "string", - "description": "User email address.", - "x-example": "john@appwrite.io" + "description": "File MD5 signature.", + "x-example": "5d529fd02b544198ae075bd57c1762bb" }, - "phone": { + "mimeType": { "type": "string", - "description": "User phone number in E.164 format.", - "x-example": "+4930901820" + "description": "File mime type.", + "x-example": "image\/png" }, - "emailVerification": { + "sizeOriginal": { + "type": "integer", + "description": "File original size in bytes.", + "x-example": 17890, + "format": "int32" + }, + "chunksTotal": { + "type": "integer", + "description": "Total number of chunks available", + "x-example": 17890, + "format": "int32" + }, + "chunksUploaded": { + "type": "integer", + "description": "Total number of chunks uploaded", + "x-example": 17890, + "format": "int32" + }, + "encryption": { "type": "boolean", - "description": "Email verification status.", + "description": "Whether file contents are encrypted at rest.", "x-example": true }, - "phoneVerification": { + "compression": { + "type": "string", + "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", + "x-example": "gzip" + } + }, + "required": [ + "$id", + "bucketId", + "$createdAt", + "$updatedAt", + "$permissions", + "name", + "signature", + "mimeType", + "sizeOriginal", + "chunksTotal", + "chunksUploaded", + "encryption", + "compression" + ], + "example": { + "$id": "5e5ea5c16897e", + "bucketId": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "name": "Pink.png", + "signature": "5d529fd02b544198ae075bd57c1762bb", + "mimeType": "image\/png", + "sizeOriginal": 17890, + "chunksTotal": 17890, + "chunksUploaded": 17890, + "encryption": true, + "compression": "gzip" + } + }, + "bucket": { + "description": "Bucket", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Bucket ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Bucket creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Bucket update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "fileSecurity": { "type": "boolean", - "description": "Phone verification status.", + "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": true }, - "mfa": { + "name": { + "type": "string", + "description": "Bucket name.", + "x-example": "Documents" + }, + "enabled": { "type": "boolean", - "description": "Multi factor authentication status.", - "x-example": true + "description": "Bucket enabled.", + "x-example": false }, - "prefs": { - "type": "object", - "description": "User preferences as a key-value object", - "x-example": { - "theme": "pink", - "timezone": "UTC" - }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size supported.", + "x-example": 100, + "format": "int32" }, - "targets": { + "allowedFileExtensions": { "type": "array", - "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", + "description": "Allowed file extensions.", "items": { - "$ref": "#\/components\/schemas\/target" + "type": "string" }, - "x-example": [] + "x-example": [ + "jpg", + "png" + ] }, - "accessedAt": { + "compression": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", + "x-example": "gzip" }, - "impersonator": { + "encryption": { "type": "boolean", - "description": "Whether the user can impersonate other users.", - "x-example": false, - "nullable": true + "description": "Bucket is encrypted.", + "x-example": false }, - "impersonatorUserId": { - "type": "string", - "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", - "x-example": "5e5ea5c16897e", - "nullable": true + "antivirus": { + "type": "boolean", + "description": "Virus scanning is enabled.", + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Image transformations are enabled.", + "x-example": false + }, + "totalSize": { + "type": "integer", + "description": "Total size of this bucket in bytes.", + "x-example": 128, + "format": "int32" } }, "required": [ "$id", "$createdAt", "$updatedAt", + "$permissions", + "fileSecurity", "name", - "registration", - "status", - "labels", - "passwordUpdate", - "email", - "phone", - "emailVerification", - "phoneVerification", - "mfa", - "prefs", - "targets", - "accessedAt" + "enabled", + "maximumFileSize", + "allowedFileExtensions", + "compression", + "encryption", + "antivirus", + "transformations", + "totalSize" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "John Doe", - "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", - "hash": "argon2", - "hashOptions": {}, - "registration": "2020-10-15T06:38:00.000+00:00", - "status": true, - "labels": [ - "vip" + "$permissions": [ + "read(\"any\")" ], - "passwordUpdate": "2020-10-15T06:38:00.000+00:00", - "email": "john@appwrite.io", - "phone": "+4930901820", - "emailVerification": true, - "phoneVerification": true, - "mfa": true, - "prefs": { - "theme": "pink", - "timezone": "UTC" - }, - "targets": [], - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "impersonator": false, - "impersonatorUserId": "5e5ea5c16897e" + "fileSecurity": true, + "name": "Documents", + "enabled": false, + "maximumFileSize": 100, + "allowedFileExtensions": [ + "jpg", + "png" + ], + "compression": "gzip", + "encryption": false, + "antivirus": false, + "transformations": false, + "totalSize": 128 } }, - "algoMd5": { - "description": "AlgoMD5", + "resourceToken": { + "description": "ResourceToken", "type": "object", "properties": { - "type": { + "$id": { "type": "string", - "description": "Algo type.", - "x-example": "md5" - } - }, - "required": [ - "type" - ], - "example": { - "type": "md5" - } - }, - "algoSha": { - "description": "AlgoSHA", - "type": "object", - "properties": { - "type": { + "description": "Token ID.", + "x-example": "bb8ea5c16897e" + }, + "$createdAt": { "type": "string", - "description": "Algo type.", - "x-example": "sha" - } - }, - "required": [ - "type" - ], - "example": { - "type": "sha" - } - }, - "algoPhpass": { - "description": "AlgoPHPass", - "type": "object", - "properties": { - "type": { + "description": "Token creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "resourceId": { "type": "string", - "description": "Algo type.", - "x-example": "phpass" - } - }, - "required": [ - "type" - ], - "example": { - "type": "phpass" - } - }, - "algoBcrypt": { - "description": "AlgoBcrypt", - "type": "object", - "properties": { - "type": { + "description": "Resource ID.", + "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" + }, + "resourceType": { "type": "string", - "description": "Algo type.", - "x-example": "bcrypt" + "description": "Resource type.", + "x-example": "files" + }, + "expire": { + "type": "string", + "description": "Token expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "secret": { + "type": "string", + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + }, + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "type" + "$id", + "$createdAt", + "resourceId", + "resourceType", + "expire", + "secret", + "accessedAt" ], "example": { - "type": "bcrypt" + "$id": "bb8ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8", + "resourceType": "files", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "accessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "algoScrypt": { - "description": "AlgoScrypt", + "team": { + "description": "Team", "type": "object", "properties": { - "type": { + "$id": { "type": "string", - "description": "Algo type.", - "x-example": "scrypt" + "description": "Team ID.", + "x-example": "5e5ea5c16897e" }, - "costCpu": { - "type": "integer", - "description": "CPU complexity of computed hash.", - "x-example": 8, - "format": "int32" + "$createdAt": { + "type": "string", + "description": "Team creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "costMemory": { - "type": "integer", - "description": "Memory complexity of computed hash.", - "x-example": 14, - "format": "int32" + "$updatedAt": { + "type": "string", + "description": "Team update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "costParallel": { - "type": "integer", - "description": "Parallelization of computed hash.", - "x-example": 1, - "format": "int32" + "name": { + "type": "string", + "description": "Team name.", + "x-example": "VIP" }, - "length": { + "total": { "type": "integer", - "description": "Length used to compute hash.", - "x-example": 64, + "description": "Total number of team members.", + "x-example": 7, "format": "int32" + }, + "prefs": { + "type": "object", + "description": "Team preferences as a key-value object", + "x-example": { + "theme": "pink", + "timezone": "UTC" + }, + "items": { + "$ref": "#\/components\/schemas\/preferences" + } } }, "required": [ - "type", - "costCpu", - "costMemory", - "costParallel", - "length" + "$id", + "$createdAt", + "$updatedAt", + "name", + "total", + "prefs" ], "example": { - "type": "scrypt", - "costCpu": 8, - "costMemory": 14, - "costParallel": 1, - "length": 64 + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "VIP", + "total": 7, + "prefs": { + "theme": "pink", + "timezone": "UTC" + } } }, - "algoScryptModified": { - "description": "AlgoScryptModified", + "membership": { + "description": "Membership", "type": "object", "properties": { - "type": { + "$id": { "type": "string", - "description": "Algo type.", - "x-example": "scryptMod" + "description": "Membership ID.", + "x-example": "5e5ea5c16897e" }, - "salt": { + "$createdAt": { "type": "string", - "description": "Salt used to compute hash.", - "x-example": "UxLMreBr6tYyjQ==" + "description": "Membership creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "saltSeparator": { + "$updatedAt": { "type": "string", - "description": "Separator used to compute hash.", - "x-example": "Bw==" + "description": "Membership update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "signerKey": { + "userId": { "type": "string", - "description": "Key used to compute hash.", - "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" - } - }, - "required": [ - "type", - "salt", - "saltSeparator", - "signerKey" - ], - "example": { - "type": "scryptMod", - "salt": "UxLMreBr6tYyjQ==", - "saltSeparator": "Bw==", - "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" - } - }, - "algoArgon2": { - "description": "AlgoArgon2", - "type": "object", - "properties": { - "type": { + "description": "User ID.", + "x-example": "5e5ea5c16897e" + }, + "userName": { "type": "string", - "description": "Algo type.", - "x-example": "argon2" + "description": "User name. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "John Doe" }, - "memoryCost": { - "type": "integer", - "description": "Memory used to compute hash.", - "x-example": 65536, - "format": "int32" + "userEmail": { + "type": "string", + "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "john@appwrite.io" }, - "timeCost": { - "type": "integer", - "description": "Amount of time consumed to compute hash", - "x-example": 4, - "format": "int32" + "userPhone": { + "type": "string", + "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "+1 555 555 5555" }, - "threads": { - "type": "integer", - "description": "Number of threads used to compute hash.", - "x-example": 3, - "format": "int32" + "teamId": { + "type": "string", + "description": "Team ID.", + "x-example": "5e5ea5c16897e" + }, + "teamName": { + "type": "string", + "description": "Team name.", + "x-example": "VIP" + }, + "invited": { + "type": "string", + "description": "Date, the user has been invited to join the team in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "joined": { + "type": "string", + "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "confirm": { + "type": "boolean", + "description": "User confirmation status, true if the user has joined the team or false otherwise.", + "x-example": false + }, + "mfa": { + "type": "boolean", + "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", + "x-example": false + }, + "roles": { + "type": "array", + "description": "User list of roles", + "items": { + "type": "string" + }, + "x-example": [ + "owner" + ] } }, "required": [ - "type", - "memoryCost", - "timeCost", - "threads" + "$id", + "$createdAt", + "$updatedAt", + "userId", + "userName", + "userEmail", + "userPhone", + "teamId", + "teamName", + "invited", + "joined", + "confirm", + "mfa", + "roles" ], "example": { - "type": "argon2", - "memoryCost": 65536, - "timeCost": 4, - "threads": 3 - } - }, - "preferences": { - "description": "Preferences", - "type": "object", - "additionalProperties": true, - "example": { - "language": "en", - "timezone": "UTC", - "darkTheme": true + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5ea5c16897e", + "userName": "John Doe", + "userEmail": "john@appwrite.io", + "userPhone": "+1 555 555 5555", + "teamId": "5e5ea5c16897e", + "teamName": "VIP", + "invited": "2020-10-15T06:38:00.000+00:00", + "joined": "2020-10-15T06:38:00.000+00:00", + "confirm": false, + "mfa": false, + "roles": [ + "owner" + ] } }, - "session": { - "description": "Session", + "site": { + "description": "Site", "type": "object", "properties": { "$id": { "type": "string", - "description": "Session ID.", + "description": "Site ID.", "x-example": "5e5ea5c16897e" }, - "$createdAt": { + "$createdAt": { + "type": "string", + "description": "Site creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Site update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Site name.", + "x-example": "My Site" + }, + "enabled": { + "type": "boolean", + "description": "Site enabled.", + "x-example": false + }, + "live": { + "type": "boolean", + "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "x-example": false + }, + "framework": { "type": "string", - "description": "Session creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site framework.", + "x-example": "react" }, - "$updatedAt": { - "type": "string", - "description": "Session update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" }, - "userId": { + "deploymentId": { "type": "string", - "description": "User ID.", - "x-example": "5e5bb8c16897e" + "description": "Site's active deployment ID.", + "x-example": "5e5ea5c16897e" }, - "expire": { + "deploymentCreatedAt": { "type": "string", - "description": "Session expiration date in ISO 8601 format.", + "description": "Active deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "provider": { + "deploymentScreenshotLight": { "type": "string", - "description": "Session Provider.", - "x-example": "email" + "description": "Screenshot of active deployment with light theme preference file ID.", + "x-example": "5e5ea5c16897e" }, - "providerUid": { + "deploymentScreenshotDark": { "type": "string", - "description": "Session Provider User ID.", - "x-example": "user@example.com" + "description": "Screenshot of active deployment with dark theme preference file ID.", + "x-example": "5e5ea5c16897e" }, - "providerAccessToken": { + "latestDeploymentId": { "type": "string", - "description": "Session Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Site's latest deployment ID.", + "x-example": "5e5ea5c16897e" }, - "providerAccessTokenExpiry": { + "latestDeploymentCreatedAt": { "type": "string", - "description": "The date of when the access token expires in ISO 8601 format.", + "description": "Latest deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerRefreshToken": { - "type": "string", - "description": "Session Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" - }, - "ip": { + "latestDeploymentStatus": { "type": "string", - "description": "IP in use when the session was created.", - "x-example": "127.0.0.1" + "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", + "x-example": "ready" }, - "osCode": { - "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "vars": { + "type": "array", + "description": "Site variables.", + "items": { + "$ref": "#\/components\/schemas\/variable" + }, + "x-example": [] }, - "osName": { - "type": "string", - "description": "Operating system name.", - "x-example": "Mac" + "timeout": { + "type": "integer", + "description": "Site request timeout in seconds.", + "x-example": 300, + "format": "int32" }, - "osVersion": { + "installCommand": { "type": "string", - "description": "Operating system version.", - "x-example": "Mac" + "description": "The install command used to install the site dependencies.", + "x-example": "npm install" }, - "clientType": { + "buildCommand": { "type": "string", - "description": "Client type.", - "x-example": "browser" + "description": "The build command used to build the site.", + "x-example": "npm run build" }, - "clientCode": { + "startCommand": { "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "description": "Custom command to use when starting site runtime.", + "x-example": "node custom-server.mjs" }, - "clientName": { + "outputDirectory": { "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "description": "The directory where the site build output is located.", + "x-example": "build" }, - "clientVersion": { + "installationId": { "type": "string", - "description": "Client version.", - "x-example": "84.0" + "description": "Site VCS (Version Control System) installation id.", + "x-example": "6m40at4ejk5h2u9s1hboo" }, - "clientEngine": { + "providerRepositoryId": { "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" + "description": "VCS (Version Control System) Repository ID", + "x-example": "appwrite" }, - "clientEngineVersion": { + "providerBranch": { "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" + "description": "VCS (Version Control System) branch name", + "x-example": "main" }, - "deviceName": { + "providerRootDirectory": { "type": "string", - "description": "Device name.", - "x-example": "smartphone" + "description": "Path to site in VCS (Version Control System) repository", + "x-example": "sites\/helloWorld" }, - "deviceBrand": { - "type": "string", - "description": "Device brand name.", - "x-example": "Google" + "providerSilentMode": { + "type": "boolean", + "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", + "x-example": false }, - "deviceModel": { + "buildSpecification": { "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" }, - "countryCode": { + "runtimeSpecification": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "Machine specification for SSR executions.", + "x-example": "s-1vcpu-512mb" }, - "countryName": { + "buildRuntime": { "type": "string", - "description": "Country name.", - "x-example": "United States" - }, - "current": { - "type": "boolean", - "description": "Returns true if this the current user session.", - "x-example": true - }, - "factors": { - "type": "array", - "description": "Returns a list of active session factors.", - "items": { - "type": "string" - }, - "x-example": [ - "email" - ] + "description": "Site build runtime.", + "x-example": "node-22" }, - "secret": { + "adapter": { "type": "string", - "description": "Secret used to authenticate the user. Only included if the request was made with an API key", - "x-example": "5e5bb8c16897e" + "description": "Site framework adapter.", + "x-example": "static" }, - "mfaUpdatedAt": { + "fallbackFile": { "type": "string", - "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", + "x-example": "index.html" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "userId", - "expire", - "provider", - "providerUid", - "providerAccessToken", - "providerAccessTokenExpiry", - "providerRefreshToken", - "ip", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", - "countryCode", - "countryName", - "current", - "factors", - "secret", - "mfaUpdatedAt" + "name", + "enabled", + "live", + "logging", + "framework", + "deploymentRetention", + "deploymentId", + "deploymentCreatedAt", + "deploymentScreenshotLight", + "deploymentScreenshotDark", + "latestDeploymentId", + "latestDeploymentCreatedAt", + "latestDeploymentStatus", + "vars", + "timeout", + "installCommand", + "buildCommand", + "startCommand", + "outputDirectory", + "installationId", + "providerRepositoryId", + "providerBranch", + "providerRootDirectory", + "providerSilentMode", + "buildSpecification", + "runtimeSpecification", + "buildRuntime", + "adapter", + "fallbackFile" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5bb8c16897e", - "expire": "2020-10-15T06:38:00.000+00:00", - "provider": "email", - "providerUid": "user@example.com", - "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", - "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "ip": "127.0.0.1", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", - "countryCode": "US", - "countryName": "United States", - "current": true, - "factors": [ - "email" - ], - "secret": "5e5bb8c16897e", - "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00" + "name": "My Site", + "enabled": false, + "live": false, + "logging": false, + "framework": "react", + "deploymentRetention": 7, + "deploymentId": "5e5ea5c16897e", + "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "deploymentScreenshotLight": "5e5ea5c16897e", + "deploymentScreenshotDark": "5e5ea5c16897e", + "latestDeploymentId": "5e5ea5c16897e", + "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentStatus": "ready", + "vars": [], + "timeout": 300, + "installCommand": "npm install", + "buildCommand": "npm run build", + "startCommand": "node custom-server.mjs", + "outputDirectory": "build", + "installationId": "6m40at4ejk5h2u9s1hboo", + "providerRepositoryId": "appwrite", + "providerBranch": "main", + "providerRootDirectory": "sites\/helloWorld", + "providerSilentMode": false, + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb", + "buildRuntime": "node-22", + "adapter": "static", + "fallbackFile": "index.html" } }, - "identity": { - "description": "Identity", + "function": { + "description": "Function", "type": "object", "properties": { "$id": { "type": "string", - "description": "Identity ID.", + "description": "Function ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Identity creation date in ISO 8601 format.", + "description": "Function creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Identity update date in ISO 8601 format.", + "description": "Function update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "userId": { + "execute": { + "type": "array", + "description": "Execution permissions.", + "items": { + "type": "string" + }, + "x-example": "users" + }, + "name": { "type": "string", - "description": "User ID.", - "x-example": "5e5bb8c16897e" + "description": "Function name.", + "x-example": "My Function" }, - "provider": { + "enabled": { + "type": "boolean", + "description": "Function enabled.", + "x-example": false + }, + "live": { + "type": "boolean", + "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", + "x-example": false + }, + "runtime": { "type": "string", - "description": "Identity Provider.", - "x-example": "email" + "description": "Function execution and build runtime.", + "x-example": "python-3.8" }, - "providerUid": { + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, + "deploymentId": { "type": "string", - "description": "ID of the User in the Identity Provider.", - "x-example": "5e5bb8c16897e" + "description": "Function's active deployment ID.", + "x-example": "5e5ea5c16897e" }, - "providerEmail": { + "deploymentCreatedAt": { "type": "string", - "description": "Email of the User in the Identity Provider.", - "x-example": "user@example.com" + "description": "Active deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerAccessToken": { + "latestDeploymentId": { "type": "string", - "description": "Identity Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Function's latest deployment ID.", + "x-example": "5e5ea5c16897e" }, - "providerAccessTokenExpiry": { + "latestDeploymentCreatedAt": { "type": "string", - "description": "The date of when the access token expires in ISO 8601 format.", + "description": "Latest deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerRefreshToken": { + "latestDeploymentStatus": { "type": "string", - "description": "Identity Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", + "x-example": "ready" + }, + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" + }, + "vars": { + "type": "array", + "description": "Function variables.", + "items": { + "$ref": "#\/components\/schemas\/variable" + }, + "x-example": [] + }, + "events": { + "type": "array", + "description": "Function trigger events.", + "items": { + "type": "string" + }, + "x-example": "account.create" + }, + "schedule": { + "type": "string", + "description": "Function execution schedule in CRON format.", + "x-example": "5 4 * * *" + }, + "timeout": { + "type": "integer", + "description": "Function execution timeout in seconds.", + "x-example": 300, + "format": "int32" + }, + "entrypoint": { + "type": "string", + "description": "The entrypoint file used to execute the deployment.", + "x-example": "index.js" + }, + "commands": { + "type": "string", + "description": "The build command used to build the deployment.", + "x-example": "npm install" + }, + "version": { + "type": "string", + "description": "Version of Open Runtimes used for the function.", + "x-example": "v2" + }, + "installationId": { + "type": "string", + "description": "Function VCS (Version Control System) installation id.", + "x-example": "6m40at4ejk5h2u9s1hboo" + }, + "providerRepositoryId": { + "type": "string", + "description": "VCS (Version Control System) Repository ID", + "x-example": "appwrite" + }, + "providerBranch": { + "type": "string", + "description": "VCS (Version Control System) branch name", + "x-example": "main" + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to function in VCS (Version Control System) repository", + "x-example": "functions\/helloWorld" + }, + "providerSilentMode": { + "type": "boolean", + "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", + "x-example": false + }, + "buildSpecification": { + "type": "string", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { + "type": "string", + "description": "Machine specification for executions.", + "x-example": "s-1vcpu-512mb" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "userId", - "provider", - "providerUid", - "providerEmail", - "providerAccessToken", - "providerAccessTokenExpiry", - "providerRefreshToken" + "execute", + "name", + "enabled", + "live", + "logging", + "runtime", + "deploymentRetention", + "deploymentId", + "deploymentCreatedAt", + "latestDeploymentId", + "latestDeploymentCreatedAt", + "latestDeploymentStatus", + "scopes", + "vars", + "events", + "schedule", + "timeout", + "entrypoint", + "commands", + "version", + "installationId", + "providerRepositoryId", + "providerBranch", + "providerRootDirectory", + "providerSilentMode", + "buildSpecification", + "runtimeSpecification" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5bb8c16897e", - "provider": "email", - "providerUid": "5e5bb8c16897e", - "providerEmail": "user@example.com", - "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", - "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "execute": "users", + "name": "My Function", + "enabled": false, + "live": false, + "logging": false, + "runtime": "python-3.8", + "deploymentRetention": 7, + "deploymentId": "5e5ea5c16897e", + "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentId": "5e5ea5c16897e", + "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentStatus": "ready", + "scopes": "users.read", + "vars": [], + "events": "account.create", + "schedule": "5 4 * * *", + "timeout": 300, + "entrypoint": "index.js", + "commands": "npm install", + "version": "v2", + "installationId": "6m40at4ejk5h2u9s1hboo", + "providerRepositoryId": "appwrite", + "providerBranch": "main", + "providerRootDirectory": "functions\/helloWorld", + "providerSilentMode": false, + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb" } }, - "token": { - "description": "Token", + "runtime": { + "description": "Runtime", "type": "object", "properties": { "$id": { "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "description": "Runtime ID.", + "x-example": "python-3.8" }, - "$createdAt": { + "key": { "type": "string", - "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Parent runtime key.", + "x-example": "python" }, - "userId": { + "name": { "type": "string", - "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "description": "Runtime Name.", + "x-example": "Python" }, - "secret": { + "version": { "type": "string", - "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "description": "Runtime version.", + "x-example": "3.8" }, - "expire": { + "base": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Base Docker image used to build the runtime.", + "x-example": "python:3.8-alpine" }, - "phrase": { + "image": { "type": "string", - "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", - "x-example": "Golden Fox" - } - }, - "required": [ - "$id", - "$createdAt", - "userId", - "secret", - "expire", - "phrase" - ], - "example": { - "$id": "bb8ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c168bb8", - "secret": "", - "expire": "2020-10-15T06:38:00.000+00:00", - "phrase": "Golden Fox" - } - }, - "jwt": { - "description": "JWT", - "type": "object", - "properties": { - "jwt": { + "description": "Image name of Docker Hub.", + "x-example": "appwrite\\\/runtime-for-python:3.8" + }, + "logo": { "type": "string", - "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "description": "Name of the logo image.", + "x-example": "python.png" + }, + "supports": { + "type": "array", + "description": "List of supported architectures.", + "items": { + "type": "string" + }, + "x-example": "amd64" } }, "required": [ - "jwt" + "$id", + "key", + "name", + "version", + "base", + "image", + "logo", + "supports" ], "example": { - "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "$id": "python-3.8", + "key": "python", + "name": "Python", + "version": "3.8", + "base": "python:3.8-alpine", + "image": "appwrite\\\/runtime-for-python:3.8", + "logo": "python.png", + "supports": "amd64" } }, - "locale": { - "description": "Locale", + "framework": { + "description": "Framework", "type": "object", "properties": { - "ip": { - "type": "string", - "description": "User IP address.", - "x-example": "127.0.0.1" - }, - "countryCode": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", - "x-example": "US" - }, - "country": { + "key": { "type": "string", - "description": "Country name. This field support localization.", - "x-example": "United States" + "description": "Framework key.", + "x-example": "sveltekit" }, - "continentCode": { + "name": { "type": "string", - "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", - "x-example": "NA" + "description": "Framework Name.", + "x-example": "SvelteKit" }, - "continent": { + "buildRuntime": { "type": "string", - "description": "Continent name. This field support localization.", - "x-example": "North America" + "description": "Default runtime version.", + "x-example": "node-22" }, - "eu": { - "type": "boolean", - "description": "True if country is part of the European Union.", - "x-example": false + "runtimes": { + "type": "array", + "description": "List of supported runtime versions.", + "items": { + "type": "string" + }, + "x-example": [ + "static-1", + "node-22" + ] }, - "currency": { - "type": "string", - "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", - "x-example": "USD" + "adapters": { + "type": "array", + "description": "List of supported adapters.", + "items": { + "$ref": "#\/components\/schemas\/frameworkAdapter" + }, + "x-example": [ + { + "key": "static", + "buildRuntime": "node-22", + "buildCommand": "npm run build", + "installCommand": "npm install", + "outputDirectory": ".\/dist" + } + ] } }, "required": [ - "ip", - "countryCode", - "country", - "continentCode", - "continent", - "eu", - "currency" + "key", + "name", + "buildRuntime", + "runtimes", + "adapters" ], "example": { - "ip": "127.0.0.1", - "countryCode": "US", - "country": "United States", - "continentCode": "NA", - "continent": "North America", - "eu": false, - "currency": "USD" + "key": "sveltekit", + "name": "SvelteKit", + "buildRuntime": "node-22", + "runtimes": [ + "static-1", + "node-22" + ], + "adapters": [ + { + "key": "static", + "buildRuntime": "node-22", + "buildCommand": "npm run build", + "installCommand": "npm install", + "outputDirectory": ".\/dist" + } + ] } }, - "localeCode": { - "description": "LocaleCode", + "frameworkAdapter": { + "description": "Framework Adapter", "type": "object", "properties": { - "code": { + "key": { "type": "string", - "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", - "x-example": "en-us" + "description": "Adapter key.", + "x-example": "static" }, - "name": { + "installCommand": { "type": "string", - "description": "Locale name", - "x-example": "US" + "description": "Default command to download dependencies.", + "x-example": "npm install" + }, + "buildCommand": { + "type": "string", + "description": "Default command to build site into output directory.", + "x-example": "npm run build" + }, + "outputDirectory": { + "type": "string", + "description": "Default output directory of build.", + "x-example": ".\/dist" + }, + "fallbackFile": { + "type": "string", + "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", + "x-example": "index.html" } }, "required": [ - "code", - "name" + "key", + "installCommand", + "buildCommand", + "outputDirectory", + "fallbackFile" ], "example": { - "code": "en-us", - "name": "US" + "key": "static", + "installCommand": "npm install", + "buildCommand": "npm run build", + "outputDirectory": ".\/dist", + "fallbackFile": "index.html" } }, - "file": { - "description": "File", + "deployment": { + "description": "Deployment", "type": "object", "properties": { "$id": { "type": "string", - "description": "File ID.", - "x-example": "5e5ea5c16897e" - }, - "bucketId": { - "type": "string", - "description": "Bucket ID.", + "description": "Deployment ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "File creation date in ISO 8601 format.", + "description": "Deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "File update date in ISO 8601 format.", + "description": "Deployment update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$permissions": { - "type": "array", - "description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "type": { + "type": "string", + "description": "Type of deployment.", + "x-example": "vcs" }, - "name": { + "resourceId": { "type": "string", - "description": "File name.", - "x-example": "Pink.png" + "description": "Resource ID.", + "x-example": "5e5ea6g16897e" }, - "signature": { + "resourceType": { "type": "string", - "description": "File MD5 signature.", - "x-example": "5d529fd02b544198ae075bd57c1762bb" + "description": "Resource type.", + "x-example": "functions" }, - "mimeType": { + "entrypoint": { "type": "string", - "description": "File mime type.", - "x-example": "image\/png" + "description": "The entrypoint file to use to execute the deployment code.", + "x-example": "index.js" }, - "sizeOriginal": { + "sourceSize": { "type": "integer", - "description": "File original size in bytes.", - "x-example": 17890, + "description": "The code size in bytes.", + "x-example": 128, "format": "int32" }, - "chunksTotal": { + "buildSize": { "type": "integer", - "description": "Total number of chunks available", - "x-example": 17890, + "description": "The build output size in bytes.", + "x-example": 128, "format": "int32" }, - "chunksUploaded": { + "totalSize": { "type": "integer", - "description": "Total number of chunks uploaded", - "x-example": 17890, + "description": "The total size in bytes (source and build output).", + "x-example": 128, "format": "int32" }, - "encryption": { + "buildId": { + "type": "string", + "description": "The current build ID.", + "x-example": "5e5ea5c16897e" + }, + "activate": { "type": "boolean", - "description": "Whether file contents are encrypted at rest.", + "description": "Whether the deployment should be automatically activated.", "x-example": true }, - "compression": { + "screenshotLight": { "type": "string", - "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "description": "Screenshot with light theme preference file ID.", + "x-example": "5e5ea5c16897e" + }, + "screenshotDark": { + "type": "string", + "description": "Screenshot with dark theme preference file ID.", + "x-example": "5e5ea5c16897e" + }, + "status": { + "type": "string", + "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", + "x-example": "ready", + "enum": [ + "waiting", + "processing", + "building", + "ready", + "canceled", + "failed" + ] + }, + "buildLogs": { + "type": "string", + "description": "The build logs.", + "x-example": "Compiling source files..." + }, + "buildDuration": { + "type": "integer", + "description": "The current build time in seconds.", + "x-example": 128, + "format": "int32" + }, + "providerRepositoryName": { + "type": "string", + "description": "The name of the vcs provider repository", + "x-example": "database" + }, + "providerRepositoryOwner": { + "type": "string", + "description": "The name of the vcs provider repository owner", + "x-example": "utopia" + }, + "providerRepositoryUrl": { + "type": "string", + "description": "The url of the vcs provider repository", + "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + }, + "providerCommitHash": { + "type": "string", + "description": "The commit hash of the vcs commit", + "x-example": "7c3f25d" + }, + "providerCommitAuthorUrl": { + "type": "string", + "description": "The url of vcs commit author", + "x-example": "https:\/\/github.com\/vermakhushboo" + }, + "providerCommitAuthor": { + "type": "string", + "description": "The name of vcs commit author", + "x-example": "Khushboo Verma" + }, + "providerCommitMessage": { + "type": "string", + "description": "The commit message", + "x-example": "Update index.js" + }, + "providerCommitUrl": { + "type": "string", + "description": "The url of the vcs commit", + "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + }, + "providerBranch": { + "type": "string", + "description": "The branch of the vcs repository", + "x-example": "0.7.x" + }, + "providerBranchUrl": { + "type": "string", + "description": "The branch of the vcs repository", + "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, "required": [ "$id", - "bucketId", "$createdAt", "$updatedAt", - "$permissions", - "name", - "signature", - "mimeType", - "sizeOriginal", - "chunksTotal", - "chunksUploaded", - "encryption", - "compression" + "type", + "resourceId", + "resourceType", + "entrypoint", + "sourceSize", + "buildSize", + "totalSize", + "buildId", + "activate", + "screenshotLight", + "screenshotDark", + "status", + "buildLogs", + "buildDuration", + "providerRepositoryName", + "providerRepositoryOwner", + "providerRepositoryUrl", + "providerCommitHash", + "providerCommitAuthorUrl", + "providerCommitAuthor", + "providerCommitMessage", + "providerCommitUrl", + "providerBranch", + "providerBranchUrl" ], "example": { "$id": "5e5ea5c16897e", - "bucketId": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "name": "Pink.png", - "signature": "5d529fd02b544198ae075bd57c1762bb", - "mimeType": "image\/png", - "sizeOriginal": 17890, - "chunksTotal": 17890, - "chunksUploaded": 17890, - "encryption": true, - "compression": "gzip" + "type": "vcs", + "resourceId": "5e5ea6g16897e", + "resourceType": "functions", + "entrypoint": "index.js", + "sourceSize": 128, + "buildSize": 128, + "totalSize": 128, + "buildId": "5e5ea5c16897e", + "activate": true, + "screenshotLight": "5e5ea5c16897e", + "screenshotDark": "5e5ea5c16897e", + "status": "ready", + "buildLogs": "Compiling source files...", + "buildDuration": 128, + "providerRepositoryName": "database", + "providerRepositoryOwner": "utopia", + "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function", + "providerCommitHash": "7c3f25d", + "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo", + "providerCommitAuthor": "Khushboo Verma", + "providerCommitMessage": "Update index.js", + "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", + "providerBranch": "0.7.x", + "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, - "bucket": { - "description": "Bucket", + "execution": { + "description": "Execution", "type": "object", "properties": { "$id": { "type": "string", - "description": "Bucket ID.", + "description": "Execution ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Execution creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Execution update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Execution roles.", + "items": { + "type": "string" + }, + "x-example": [ + "any" + ] + }, + "functionId": { + "type": "string", + "description": "Function ID.", + "x-example": "5e5ea6g16897e" + }, + "deploymentId": { + "type": "string", + "description": "Function's deployment ID used to create the execution.", "x-example": "5e5ea5c16897e" }, - "$createdAt": { + "trigger": { "type": "string", - "description": "Bucket creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.", + "x-example": "http", + "enum": [ + "http", + "schedule", + "event" + ] }, - "$updatedAt": { + "status": { "type": "string", - "description": "Bucket update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", + "x-example": "processing", + "enum": [ + "waiting", + "processing", + "completed", + "failed", + "scheduled" + ] }, - "$permissions": { + "requestMethod": { + "type": "string", + "description": "HTTP request method type.", + "x-example": "GET" + }, + "requestPath": { + "type": "string", + "description": "HTTP request path and query.", + "x-example": "\/articles?id=5" + }, + "requestHeaders": { "type": "array", - "description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", "items": { - "type": "string" + "$ref": "#\/components\/schemas\/headers" }, "x-example": [ - "read(\"any\")" + { + "Content-Type": "application\/json" + } ] }, - "fileSecurity": { - "type": "boolean", - "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true - }, - "name": { - "type": "string", - "description": "Bucket name.", - "x-example": "Documents" - }, - "enabled": { - "type": "boolean", - "description": "Bucket enabled.", - "x-example": false - }, - "maximumFileSize": { + "responseStatusCode": { "type": "integer", - "description": "Maximum file size supported.", - "x-example": 100, + "description": "HTTP response status code.", + "x-example": 200, "format": "int32" }, - "allowedFileExtensions": { + "responseBody": { + "type": "string", + "description": "HTTP response body. This will return empty unless execution is created as synchronous.", + "x-example": "" + }, + "responseHeaders": { "type": "array", - "description": "Allowed file extensions.", + "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", "items": { - "type": "string" + "$ref": "#\/components\/schemas\/headers" }, "x-example": [ - "jpg", - "png" + { + "Content-Type": "application\/json" + } ] }, - "compression": { + "logs": { "type": "string", - "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" - }, - "encryption": { - "type": "boolean", - "description": "Bucket is encrypted.", - "x-example": false + "description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" }, - "antivirus": { - "type": "boolean", - "description": "Virus scanning is enabled.", - "x-example": false + "errors": { + "type": "string", + "description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" }, - "transformations": { - "type": "boolean", - "description": "Image transformations are enabled.", - "x-example": false + "duration": { + "type": "number", + "description": "Resource(function\/site) execution duration in seconds.", + "x-example": 0.4, + "format": "double" }, - "totalSize": { - "type": "integer", - "description": "Total size of this bucket in bytes.", - "x-example": 128, - "format": "int32" + "scheduledAt": { + "type": "string", + "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "nullable": true } }, "required": [ @@ -59027,443 +65227,774 @@ "$createdAt", "$updatedAt", "$permissions", - "fileSecurity", - "name", - "enabled", - "maximumFileSize", - "allowedFileExtensions", - "compression", - "encryption", - "antivirus", - "transformations", - "totalSize" + "functionId", + "deploymentId", + "trigger", + "status", + "requestMethod", + "requestPath", + "requestHeaders", + "responseStatusCode", + "responseBody", + "responseHeaders", + "logs", + "errors", + "duration" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "$permissions": [ - "read(\"any\")" + "any" ], - "fileSecurity": true, - "name": "Documents", - "enabled": false, - "maximumFileSize": 100, - "allowedFileExtensions": [ - "jpg", - "png" + "functionId": "5e5ea6g16897e", + "deploymentId": "5e5ea5c16897e", + "trigger": "http", + "status": "processing", + "requestMethod": "GET", + "requestPath": "\/articles?id=5", + "requestHeaders": [ + { + "Content-Type": "application\/json" + } ], - "compression": "gzip", - "encryption": false, - "antivirus": false, - "transformations": false, - "totalSize": 128 + "responseStatusCode": 200, + "responseBody": "", + "responseHeaders": [ + { + "Content-Type": "application\/json" + } + ], + "logs": "", + "errors": "", + "duration": 0.4, + "scheduledAt": "2020-10-15T06:38:00.000+00:00" } }, - "resourceToken": { - "description": "ResourceToken", + "project": { + "description": "Project", "type": "object", "properties": { "$id": { "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "description": "Project ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Token creation date in ISO 8601 format.", + "description": "Project creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "resourceId": { + "$updatedAt": { "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" + "description": "Project update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "resourceType": { + "name": { "type": "string", - "description": "Resource type.", - "x-example": "files" + "description": "Project name.", + "x-example": "New Project" }, - "expire": { + "description": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Project description.", + "x-example": "This is a new project." }, - "secret": { + "teamId": { "type": "string", - "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "description": "Project team ID.", + "x-example": "1592981250" }, - "accessedAt": { + "logo": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" - } - }, - "required": [ - "$id", - "$createdAt", - "resourceId", - "resourceType", - "expire", - "secret", - "accessedAt" - ], - "example": { - "$id": "bb8ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8", - "resourceType": "files", - "expire": "2020-10-15T06:38:00.000+00:00", - "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", - "accessedAt": "2020-10-15T06:38:00.000+00:00" - } - }, - "team": { - "description": "Team", - "type": "object", - "properties": { - "$id": { + "description": "Project logo file ID.", + "x-example": "5f5c451b403cb" + }, + "url": { "type": "string", - "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "description": "Project website URL.", + "x-example": "5f5c451b403cb" }, - "$createdAt": { + "legalName": { "type": "string", - "description": "Team creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Company legal name.", + "x-example": "Company LTD." }, - "$updatedAt": { + "legalCountry": { "type": "string", - "description": "Team update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", + "x-example": "US" }, - "name": { + "legalState": { "type": "string", - "description": "Team name.", - "x-example": "VIP" + "description": "State name.", + "x-example": "New York" }, - "total": { + "legalCity": { + "type": "string", + "description": "City name.", + "x-example": "New York City." + }, + "legalAddress": { + "type": "string", + "description": "Company Address.", + "x-example": "620 Eighth Avenue, New York, NY 10018" + }, + "legalTaxId": { + "type": "string", + "description": "Company Tax ID.", + "x-example": "131102020" + }, + "authDuration": { "type": "integer", - "description": "Total number of team members.", - "x-example": 7, + "description": "Session duration in seconds.", + "x-example": 60, "format": "int32" }, - "prefs": { - "type": "object", - "description": "Team preferences as a key-value object", - "x-example": { - "theme": "pink", - "timezone": "UTC" + "authLimit": { + "type": "integer", + "description": "Max users allowed. 0 is unlimited.", + "x-example": 100, + "format": "int32" + }, + "authSessionsLimit": { + "type": "integer", + "description": "Max sessions allowed per user. 100 maximum.", + "x-example": 10, + "format": "int32" + }, + "authPasswordHistory": { + "type": "integer", + "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", + "x-example": 5, + "format": "int32" + }, + "authPasswordDictionary": { + "type": "boolean", + "description": "Whether or not to check user's password against most commonly used passwords.", + "x-example": true + }, + "authPersonalDataCheck": { + "type": "boolean", + "description": "Whether or not to check the user password for similarity with their personal data.", + "x-example": true + }, + "authDisposableEmails": { + "type": "boolean", + "description": "Whether or not to disallow disposable email addresses during signup and email updates.", + "x-example": true + }, + "authCanonicalEmails": { + "type": "boolean", + "description": "Whether or not to require canonical email addresses during signup and email updates.", + "x-example": true + }, + "authFreeEmails": { + "type": "boolean", + "description": "Whether or not to disallow free email addresses during signup and email updates.", + "x-example": true + }, + "authMockNumbers": { + "type": "array", + "description": "An array of mock numbers and their corresponding verification codes (OTPs).", + "items": { + "$ref": "#\/components\/schemas\/mockNumber" + }, + "x-example": [ + {} + ] + }, + "authSessionAlerts": { + "type": "boolean", + "description": "Whether or not to send session alert emails to users.", + "x-example": true + }, + "authMembershipsUserName": { + "type": "boolean", + "description": "Whether or not to show user names in the teams membership response.", + "x-example": true + }, + "authMembershipsUserEmail": { + "type": "boolean", + "description": "Whether or not to show user emails in the teams membership response.", + "x-example": true + }, + "authMembershipsMfa": { + "type": "boolean", + "description": "Whether or not to show user MFA status in the teams membership response.", + "x-example": true + }, + "authMembershipsUserId": { + "type": "boolean", + "description": "Whether or not to show user IDs in the teams membership response.", + "x-example": true + }, + "authMembershipsUserPhone": { + "type": "boolean", + "description": "Whether or not to show user phone numbers in the teams membership response.", + "x-example": true + }, + "authInvalidateSessions": { + "type": "boolean", + "description": "Whether or not all existing sessions should be invalidated on password change", + "x-example": true + }, + "oAuthProviders": { + "type": "array", + "description": "List of Auth Providers.", + "items": { + "$ref": "#\/components\/schemas\/authProvider" }, + "x-example": [ + {} + ] + }, + "platforms": { + "type": "array", + "description": "List of Platforms.", "items": { - "$ref": "#\/components\/schemas\/preferences" - } - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "name", - "total", - "prefs" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "VIP", - "total": 7, - "prefs": { - "theme": "pink", - "timezone": "UTC" - } - } - }, - "membership": { - "description": "Membership", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Membership ID.", - "x-example": "5e5ea5c16897e" + "anyOf": [ + { + "$ref": "#\/components\/schemas\/platformWeb" + }, + { + "$ref": "#\/components\/schemas\/platformApple" + }, + { + "$ref": "#\/components\/schemas\/platformAndroid" + }, + { + "$ref": "#\/components\/schemas\/platformWindows" + }, + { + "$ref": "#\/components\/schemas\/platformLinux" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "web": "#\/components\/schemas\/platformWeb", + "apple": "#\/components\/schemas\/platformApple", + "android": "#\/components\/schemas\/platformAndroid", + "windows": "#\/components\/schemas\/platformWindows", + "linux": "#\/components\/schemas\/platformLinux" + } + } + }, + "x-example": {} }, - "$createdAt": { - "type": "string", - "description": "Membership creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "webhooks": { + "type": "array", + "description": "List of Webhooks.", + "items": { + "$ref": "#\/components\/schemas\/webhook" + }, + "x-example": {} }, - "$updatedAt": { - "type": "string", - "description": "Membership update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "keys": { + "type": "array", + "description": "List of API Keys.", + "items": { + "$ref": "#\/components\/schemas\/key" + }, + "x-example": {} }, - "userId": { - "type": "string", - "description": "User ID.", - "x-example": "5e5ea5c16897e" + "devKeys": { + "type": "array", + "description": "List of dev keys.", + "items": { + "$ref": "#\/components\/schemas\/devKey" + }, + "x-example": {} }, - "userName": { + "smtpEnabled": { + "type": "boolean", + "description": "Status for custom SMTP", + "x-example": false + }, + "smtpSenderName": { "type": "string", - "description": "User name. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "John Doe" + "description": "SMTP sender name", + "x-example": "John Appwrite" }, - "userEmail": { + "smtpSenderEmail": { "type": "string", - "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", + "description": "SMTP sender email", "x-example": "john@appwrite.io" }, - "userPhone": { + "smtpReplyToName": { + "type": "string", + "description": "SMTP reply to name", + "x-example": "Support Team" + }, + "smtpReplyToEmail": { "type": "string", - "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "+1 555 555 5555" + "description": "SMTP reply to email", + "x-example": "support@appwrite.io" }, - "teamId": { + "smtpHost": { "type": "string", - "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "description": "SMTP server host name", + "x-example": "mail.appwrite.io" }, - "teamName": { + "smtpPort": { + "type": "integer", + "description": "SMTP server port", + "x-example": 25, + "format": "int32" + }, + "smtpUsername": { "type": "string", - "description": "Team name.", - "x-example": "VIP" + "description": "SMTP server username", + "x-example": "emailuser" }, - "invited": { + "smtpPassword": { "type": "string", - "description": "Date, the user has been invited to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "SMTP server password. This property is write-only and always returned empty.", + "x-example": "" }, - "joined": { + "smtpSecure": { "type": "string", - "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "SMTP server secure protocol", + "x-example": "tls" }, - "confirm": { - "type": "boolean", - "description": "User confirmation status, true if the user has joined the team or false otherwise.", - "x-example": false + "pingCount": { + "type": "integer", + "description": "Number of times the ping was received for this project.", + "x-example": 1, + "format": "int32" }, - "mfa": { - "type": "boolean", - "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", - "x-example": false + "pingedAt": { + "type": "string", + "description": "Last ping datetime in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "roles": { + "labels": { "type": "array", - "description": "User list of roles", + "description": "Labels for the project.", "items": { "type": "string" }, "x-example": [ - "owner" + "vip" ] - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "userId", - "userName", - "userEmail", - "userPhone", - "teamId", - "teamName", - "invited", - "joined", - "confirm", - "mfa", - "roles" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c16897e", - "userName": "John Doe", - "userEmail": "john@appwrite.io", - "userPhone": "+1 555 555 5555", - "teamId": "5e5ea5c16897e", - "teamName": "VIP", - "invited": "2020-10-15T06:38:00.000+00:00", - "joined": "2020-10-15T06:38:00.000+00:00", - "confirm": false, - "mfa": false, - "roles": [ - "owner" - ] - } - }, - "site": { - "description": "Site", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Site ID.", - "x-example": "5e5ea5c16897e" }, - "$createdAt": { + "status": { "type": "string", - "description": "Site creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Project status", + "x-example": "active" }, - "$updatedAt": { - "type": "string", - "description": "Site update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authEmailPassword": { + "type": "boolean", + "description": "Email\/Password auth method status", + "x-example": true }, - "name": { - "type": "string", - "description": "Site name.", - "x-example": "My Site" + "authUsersAuthMagicURL": { + "type": "boolean", + "description": "Magic URL auth method status", + "x-example": true }, - "enabled": { + "authEmailOtp": { "type": "boolean", - "description": "Site enabled.", - "x-example": false + "description": "Email (OTP) auth method status", + "x-example": true }, - "live": { + "authAnonymous": { "type": "boolean", - "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", - "x-example": false + "description": "Anonymous auth method status", + "x-example": true }, - "logging": { + "authInvites": { "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false + "description": "Invites auth method status", + "x-example": true }, - "framework": { - "type": "string", - "description": "Site framework.", - "x-example": "react" + "authJWT": { + "type": "boolean", + "description": "JWT auth method status", + "x-example": true }, - "deploymentRetention": { - "type": "integer", - "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" + "authPhone": { + "type": "boolean", + "description": "Phone auth method status", + "x-example": true }, - "deploymentId": { - "type": "string", - "description": "Site's active deployment ID.", - "x-example": "5e5ea5c16897e" + "serviceStatusForAccount": { + "type": "boolean", + "description": "Account service status", + "x-example": true }, - "deploymentCreatedAt": { - "type": "string", - "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "serviceStatusForAvatars": { + "type": "boolean", + "description": "Avatars service status", + "x-example": true }, - "deploymentScreenshotLight": { - "type": "string", - "description": "Screenshot of active deployment with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "serviceStatusForDatabases": { + "type": "boolean", + "description": "Databases (legacy) service status", + "x-example": true }, - "deploymentScreenshotDark": { - "type": "string", - "description": "Screenshot of active deployment with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "serviceStatusForTablesdb": { + "type": "boolean", + "description": "TablesDB service status", + "x-example": true }, - "latestDeploymentId": { - "type": "string", - "description": "Site's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "serviceStatusForLocale": { + "type": "boolean", + "description": "Locale service status", + "x-example": true }, - "latestDeploymentCreatedAt": { - "type": "string", - "description": "Latest deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "serviceStatusForHealth": { + "type": "boolean", + "description": "Health service status", + "x-example": true }, - "latestDeploymentStatus": { - "type": "string", - "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" + "serviceStatusForProject": { + "type": "boolean", + "description": "Project service status", + "x-example": true }, - "vars": { - "type": "array", - "description": "Site variables.", - "items": { - "$ref": "#\/components\/schemas\/variable" - }, - "x-example": [] + "serviceStatusForStorage": { + "type": "boolean", + "description": "Storage service status", + "x-example": true }, - "timeout": { - "type": "integer", - "description": "Site request timeout in seconds.", - "x-example": 300, - "format": "int32" + "serviceStatusForTeams": { + "type": "boolean", + "description": "Teams service status", + "x-example": true }, - "installCommand": { - "type": "string", - "description": "The install command used to install the site dependencies.", - "x-example": "npm install" + "serviceStatusForUsers": { + "type": "boolean", + "description": "Users service status", + "x-example": true }, - "buildCommand": { - "type": "string", - "description": "The build command used to build the site.", - "x-example": "npm run build" + "serviceStatusForVcs": { + "type": "boolean", + "description": "VCS service status", + "x-example": true }, - "startCommand": { + "serviceStatusForSites": { + "type": "boolean", + "description": "Sites service status", + "x-example": true + }, + "serviceStatusForFunctions": { + "type": "boolean", + "description": "Functions service status", + "x-example": true + }, + "serviceStatusForProxy": { + "type": "boolean", + "description": "Proxy service status", + "x-example": true + }, + "serviceStatusForGraphql": { + "type": "boolean", + "description": "GraphQL service status", + "x-example": true + }, + "serviceStatusForMigrations": { + "type": "boolean", + "description": "Migrations service status", + "x-example": true + }, + "serviceStatusForMessaging": { + "type": "boolean", + "description": "Messaging service status", + "x-example": true + }, + "protocolStatusForRest": { + "type": "boolean", + "description": "REST protocol status", + "x-example": true + }, + "protocolStatusForGraphql": { + "type": "boolean", + "description": "GraphQL protocol status", + "x-example": true + }, + "protocolStatusForWebsocket": { + "type": "boolean", + "description": "Websocket protocol status", + "x-example": true + }, + "region": { "type": "string", - "description": "Custom command to use when starting site runtime.", - "x-example": "node custom-server.mjs" + "description": "Project region", + "x-example": "fra" }, - "outputDirectory": { + "billingLimits": { + "type": "object", + "description": "Billing limits reached", + "x-example": "", + "items": { + "$ref": "#\/components\/schemas\/billingLimits" + } + }, + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "$ref": "#\/components\/schemas\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { "type": "string", - "description": "The directory where the site build output is located.", - "x-example": "build" + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "description", + "teamId", + "logo", + "url", + "legalName", + "legalCountry", + "legalState", + "legalCity", + "legalAddress", + "legalTaxId", + "authDuration", + "authLimit", + "authSessionsLimit", + "authPasswordHistory", + "authPasswordDictionary", + "authPersonalDataCheck", + "authDisposableEmails", + "authCanonicalEmails", + "authFreeEmails", + "authMockNumbers", + "authSessionAlerts", + "authMembershipsUserName", + "authMembershipsUserEmail", + "authMembershipsMfa", + "authMembershipsUserId", + "authMembershipsUserPhone", + "authInvalidateSessions", + "oAuthProviders", + "platforms", + "webhooks", + "keys", + "devKeys", + "smtpEnabled", + "smtpSenderName", + "smtpSenderEmail", + "smtpReplyToName", + "smtpReplyToEmail", + "smtpHost", + "smtpPort", + "smtpUsername", + "smtpPassword", + "smtpSecure", + "pingCount", + "pingedAt", + "labels", + "status", + "authEmailPassword", + "authUsersAuthMagicURL", + "authEmailOtp", + "authAnonymous", + "authInvites", + "authJWT", + "authPhone", + "serviceStatusForAccount", + "serviceStatusForAvatars", + "serviceStatusForDatabases", + "serviceStatusForTablesdb", + "serviceStatusForLocale", + "serviceStatusForHealth", + "serviceStatusForProject", + "serviceStatusForStorage", + "serviceStatusForTeams", + "serviceStatusForUsers", + "serviceStatusForVcs", + "serviceStatusForSites", + "serviceStatusForFunctions", + "serviceStatusForProxy", + "serviceStatusForGraphql", + "serviceStatusForMigrations", + "serviceStatusForMessaging", + "protocolStatusForRest", + "protocolStatusForGraphql", + "protocolStatusForWebsocket", + "region", + "billingLimits", + "blocks", + "consoleAccessedAt" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "New Project", + "description": "This is a new project.", + "teamId": "1592981250", + "logo": "5f5c451b403cb", + "url": "5f5c451b403cb", + "legalName": "Company LTD.", + "legalCountry": "US", + "legalState": "New York", + "legalCity": "New York City.", + "legalAddress": "620 Eighth Avenue, New York, NY 10018", + "legalTaxId": "131102020", + "authDuration": 60, + "authLimit": 100, + "authSessionsLimit": 10, + "authPasswordHistory": 5, + "authPasswordDictionary": true, + "authPersonalDataCheck": true, + "authDisposableEmails": true, + "authCanonicalEmails": true, + "authFreeEmails": true, + "authMockNumbers": [ + {} + ], + "authSessionAlerts": true, + "authMembershipsUserName": true, + "authMembershipsUserEmail": true, + "authMembershipsMfa": true, + "authMembershipsUserId": true, + "authMembershipsUserPhone": true, + "authInvalidateSessions": true, + "oAuthProviders": [ + {} + ], + "platforms": {}, + "webhooks": {}, + "keys": {}, + "devKeys": {}, + "smtpEnabled": false, + "smtpSenderName": "John Appwrite", + "smtpSenderEmail": "john@appwrite.io", + "smtpReplyToName": "Support Team", + "smtpReplyToEmail": "support@appwrite.io", + "smtpHost": "mail.appwrite.io", + "smtpPort": 25, + "smtpUsername": "emailuser", + "smtpPassword": "", + "smtpSecure": "tls", + "pingCount": 1, + "pingedAt": "2020-10-15T06:38:00.000+00:00", + "labels": [ + "vip" + ], + "status": "active", + "authEmailPassword": true, + "authUsersAuthMagicURL": true, + "authEmailOtp": true, + "authAnonymous": true, + "authInvites": true, + "authJWT": true, + "authPhone": true, + "serviceStatusForAccount": true, + "serviceStatusForAvatars": true, + "serviceStatusForDatabases": true, + "serviceStatusForTablesdb": true, + "serviceStatusForLocale": true, + "serviceStatusForHealth": true, + "serviceStatusForProject": true, + "serviceStatusForStorage": true, + "serviceStatusForTeams": true, + "serviceStatusForUsers": true, + "serviceStatusForVcs": true, + "serviceStatusForSites": true, + "serviceStatusForFunctions": true, + "serviceStatusForProxy": true, + "serviceStatusForGraphql": true, + "serviceStatusForMigrations": true, + "serviceStatusForMessaging": true, + "protocolStatusForRest": true, + "protocolStatusForGraphql": true, + "protocolStatusForWebsocket": true, + "region": "fra", + "billingLimits": "", + "blocks": "", + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + } + }, + "webhook": { + "description": "Webhook", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Webhook ID.", + "x-example": "5e5ea5c16897e" }, - "installationId": { + "$createdAt": { "type": "string", - "description": "Site VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "description": "Webhook creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerRepositoryId": { + "$updatedAt": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "description": "Webhook update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerBranch": { + "name": { "type": "string", - "description": "VCS (Version Control System) branch name", - "x-example": "main" + "description": "Webhook name.", + "x-example": "My Webhook" }, - "providerRootDirectory": { + "url": { "type": "string", - "description": "Path to site in VCS (Version Control System) repository", - "x-example": "sites\/helloWorld" + "description": "Webhook URL endpoint.", + "x-example": "https:\/\/example.com\/webhook" }, - "providerSilentMode": { + "events": { + "type": "array", + "description": "Webhook trigger events.", + "items": { + "type": "string" + }, + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] + }, + "tls": { "type": "boolean", - "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "description": "Indicates if SSL \/ TLS certificate verification is enabled.", + "x-example": true }, - "buildSpecification": { + "authUsername": { "type": "string", - "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "description": "HTTP basic authentication username.", + "x-example": "username" }, - "runtimeSpecification": { + "authPassword": { "type": "string", - "description": "Machine specification for SSR executions.", - "x-example": "s-1vcpu-512mb" + "description": "HTTP basic authentication password.", + "x-example": "password" }, - "buildRuntime": { + "secret": { "type": "string", - "description": "Site build runtime.", - "x-example": "node-22" + "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", + "x-example": "ad3d581ca230e2b7059c545e5a" }, - "adapter": { - "type": "string", - "description": "Site framework adapter.", - "x-example": "static" + "enabled": { + "type": "boolean", + "description": "Indicates if this webhook is enabled.", + "x-example": true }, - "fallbackFile": { + "logs": { "type": "string", - "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "description": "Webhook error logs from the most recent failure.", + "x-example": "Failed to connect to remote server." + }, + "attempts": { + "type": "integer", + "description": "Number of consecutive failed webhook attempts.", + "x-example": 10, + "format": "int32" } }, "required": [ @@ -59471,153 +66002,64 @@ "$createdAt", "$updatedAt", "name", + "url", + "events", + "tls", + "authUsername", + "authPassword", + "secret", "enabled", - "live", - "logging", - "framework", - "deploymentRetention", - "deploymentId", - "deploymentCreatedAt", - "deploymentScreenshotLight", - "deploymentScreenshotDark", - "latestDeploymentId", - "latestDeploymentCreatedAt", - "latestDeploymentStatus", - "vars", - "timeout", - "installCommand", - "buildCommand", - "startCommand", - "outputDirectory", - "installationId", - "providerRepositoryId", - "providerBranch", - "providerRootDirectory", - "providerSilentMode", - "buildSpecification", - "runtimeSpecification", - "buildRuntime", - "adapter", - "fallbackFile" + "logs", + "attempts" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My Site", - "enabled": false, - "live": false, - "logging": false, - "framework": "react", - "deploymentRetention": 7, - "deploymentId": "5e5ea5c16897e", - "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "deploymentScreenshotLight": "5e5ea5c16897e", - "deploymentScreenshotDark": "5e5ea5c16897e", - "latestDeploymentId": "5e5ea5c16897e", - "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentStatus": "ready", - "vars": [], - "timeout": 300, - "installCommand": "npm install", - "buildCommand": "npm run build", - "startCommand": "node custom-server.mjs", - "outputDirectory": "build", - "installationId": "6m40at4ejk5h2u9s1hboo", - "providerRepositoryId": "appwrite", - "providerBranch": "main", - "providerRootDirectory": "sites\/helloWorld", - "providerSilentMode": false, - "buildSpecification": "s-1vcpu-512mb", - "runtimeSpecification": "s-1vcpu-512mb", - "buildRuntime": "node-22", - "adapter": "static", - "fallbackFile": "index.html" + "name": "My Webhook", + "url": "https:\/\/example.com\/webhook", + "events": [ + "databases.tables.update", + "databases.collections.update" + ], + "tls": true, + "authUsername": "username", + "authPassword": "password", + "secret": "ad3d581ca230e2b7059c545e5a", + "enabled": true, + "logs": "Failed to connect to remote server.", + "attempts": 10 } }, - "function": { - "description": "Function", + "key": { + "description": "Key", "type": "object", "properties": { "$id": { "type": "string", - "description": "Function ID.", + "description": "Key ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Function creation date in ISO 8601 format.", + "description": "Key creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Function update date in ISO 8601 format.", + "description": "Key update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "execute": { - "type": "array", - "description": "Execution permissions.", - "items": { - "type": "string" - }, - "x-example": "users" - }, "name": { "type": "string", - "description": "Function name.", - "x-example": "My Function" - }, - "enabled": { - "type": "boolean", - "description": "Function enabled.", - "x-example": false - }, - "live": { - "type": "boolean", - "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", - "x-example": false - }, - "runtime": { - "type": "string", - "description": "Function execution and build runtime.", - "x-example": "python-3.8" - }, - "deploymentRetention": { - "type": "integer", - "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" - }, - "deploymentId": { - "type": "string", - "description": "Function's active deployment ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentCreatedAt": { - "type": "string", - "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "latestDeploymentId": { - "type": "string", - "description": "Function's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "description": "Key name.", + "x-example": "My API Key" }, - "latestDeploymentCreatedAt": { + "expire": { "type": "string", - "description": "Latest deployment creation date in ISO 8601 format.", + "description": "Key expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "latestDeploymentStatus": { - "type": "string", - "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" - }, "scopes": { "type": "array", "description": "Allowed permission scopes.", @@ -59626,1655 +66068,2301 @@ }, "x-example": "users.read" }, - "vars": { - "type": "array", - "description": "Function variables.", - "items": { - "$ref": "#\/components\/schemas\/variable" - }, - "x-example": [] + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "events": { + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "sdks": { "type": "array", - "description": "Function trigger events.", + "description": "List of SDK user agents that used this key.", "items": { "type": "string" }, - "x-example": "account.create" - }, - "schedule": { - "type": "string", - "description": "Function execution schedule in CRON format.", - "x-example": "5 4 * * *" - }, - "timeout": { - "type": "integer", - "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" - }, - "entrypoint": { + "x-example": "appwrite:flutter" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "expire", + "scopes", + "secret", + "accessedAt", + "sdks" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "scopes": "users.read", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" + } + }, + "ephemeralKey": { + "description": "Ephemeral Key", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "description": "Key ID.", + "x-example": "5e5ea5c16897e" }, - "commands": { + "$createdAt": { "type": "string", - "description": "The build command used to build the deployment.", - "x-example": "npm install" + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "version": { + "$updatedAt": { "type": "string", - "description": "Version of Open Runtimes used for the function.", - "x-example": "v2" + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "installationId": { + "name": { "type": "string", - "description": "Function VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "description": "Key name.", + "x-example": "My API Key" }, - "providerRepositoryId": { + "expire": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerBranch": { - "type": "string", - "description": "VCS (Version Control System) branch name", - "x-example": "main" + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" }, - "providerRootDirectory": { + "secret": { "type": "string", - "description": "Path to function in VCS (Version Control System) repository", - "x-example": "functions\/helloWorld" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "buildSpecification": { + "accessedAt": { "type": "string", - "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "runtimeSpecification": { - "type": "string", - "description": "Machine specification for executions.", - "x-example": "s-1vcpu-512mb" + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "execute", "name", - "enabled", - "live", - "logging", - "runtime", - "deploymentRetention", - "deploymentId", - "deploymentCreatedAt", - "latestDeploymentId", - "latestDeploymentCreatedAt", - "latestDeploymentStatus", + "expire", "scopes", - "vars", - "events", - "schedule", - "timeout", - "entrypoint", - "commands", - "version", - "installationId", - "providerRepositoryId", - "providerBranch", - "providerRootDirectory", - "providerSilentMode", - "buildSpecification", - "runtimeSpecification" + "secret", + "accessedAt", + "sdks" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "execute": "users", - "name": "My Function", - "enabled": false, - "live": false, - "logging": false, - "runtime": "python-3.8", - "deploymentRetention": 7, - "deploymentId": "5e5ea5c16897e", - "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentId": "5e5ea5c16897e", - "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentStatus": "ready", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", "scopes": "users.read", - "vars": [], - "events": "account.create", - "schedule": "5 4 * * *", - "timeout": 300, - "entrypoint": "index.js", - "commands": "npm install", - "version": "v2", - "installationId": "6m40at4ejk5h2u9s1hboo", - "providerRepositoryId": "appwrite", - "providerBranch": "main", - "providerRootDirectory": "functions\/helloWorld", - "providerSilentMode": false, - "buildSpecification": "s-1vcpu-512mb", - "runtimeSpecification": "s-1vcpu-512mb" + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" } }, - "runtime": { - "description": "Runtime", + "devKey": { + "description": "DevKey", "type": "object", "properties": { "$id": { "type": "string", - "description": "Runtime ID.", - "x-example": "python-3.8" + "description": "Key ID.", + "x-example": "5e5ea5c16897e" }, - "key": { + "$createdAt": { "type": "string", - "description": "Parent runtime key.", - "x-example": "python" + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "$updatedAt": { "type": "string", - "description": "Runtime Name.", - "x-example": "Python" + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "version": { + "name": { "type": "string", - "description": "Runtime version.", - "x-example": "3.8" + "description": "Key name.", + "x-example": "Dev API Key" }, - "base": { + "expire": { "type": "string", - "description": "Base Docker image used to build the runtime.", - "x-example": "python:3.8-alpine" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "image": { + "secret": { "type": "string", - "description": "Image name of Docker Hub.", - "x-example": "appwrite\\\/runtime-for-python:3.8" + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "logo": { + "accessedAt": { "type": "string", - "description": "Name of the logo image.", - "x-example": "python.png" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "supports": { + "sdks": { "type": "array", - "description": "List of supported architectures.", + "description": "List of SDK user agents that used this key.", "items": { "type": "string" }, - "x-example": "amd64" + "x-example": "appwrite:flutter" } }, "required": [ "$id", - "key", + "$createdAt", + "$updatedAt", "name", - "version", - "base", - "image", - "logo", - "supports" + "expire", + "secret", + "accessedAt", + "sdks" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Dev API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" + } + }, + "mockNumber": { + "description": "Mock Number", + "type": "object", + "properties": { + "number": { + "type": "string", + "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", + "x-example": "+1612842323" + }, + "otp": { + "type": "string", + "description": "Mock OTP for the number. ", + "x-example": "123456" + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "number", + "otp", + "$createdAt", + "$updatedAt" ], "example": { - "$id": "python-3.8", - "key": "python", - "name": "Python", - "version": "3.8", - "base": "python:3.8-alpine", - "image": "appwrite\\\/runtime-for-python:3.8", - "logo": "python.png", - "supports": "amd64" + "number": "+1612842323", + "otp": "123456", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "framework": { - "description": "Framework", + "oAuth2Github": { + "description": "OAuth2GitHub", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Framework key.", - "x-example": "sveltekit" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "name": { - "type": "string", - "description": "Framework Name.", - "x-example": "SvelteKit" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "buildRuntime": { + "clientId": { "type": "string", - "description": "Default runtime version.", - "x-example": "node-22" - }, - "runtimes": { - "type": "array", - "description": "List of supported runtime versions.", - "items": { - "type": "string" - }, - "x-example": [ - "static-1", - "node-22" - ] + "description": "GitHub OAuth2 client ID. For GitHub Apps, use the \"App ID\" when both an App ID and client ID are available.", + "x-example": "e4d87900000000540733" }, - "adapters": { - "type": "array", - "description": "List of supported adapters.", - "items": { - "$ref": "#\/components\/schemas\/frameworkAdapter" - }, - "x-example": [ - { - "key": "static", - "buildRuntime": "node-22", - "buildCommand": "npm run build", - "installCommand": "npm install", - "outputDirectory": ".\/dist" - } - ] + "clientSecret": { + "type": "string", + "description": "GitHub OAuth2 client secret.", + "x-example": "5e07c00000000000000000000000000000198bcc" } }, "required": [ - "key", - "name", - "buildRuntime", - "runtimes", - "adapters" + "$id", + "enabled", + "clientId", + "clientSecret" ], "example": { - "key": "sveltekit", - "name": "SvelteKit", - "buildRuntime": "node-22", - "runtimes": [ - "static-1", - "node-22" - ], - "adapters": [ - { - "key": "static", - "buildRuntime": "node-22", - "buildCommand": "npm run build", - "installCommand": "npm install", - "outputDirectory": ".\/dist" - } - ] + "$id": "github", + "enabled": false, + "clientId": "e4d87900000000540733", + "clientSecret": "5e07c00000000000000000000000000000198bcc" } }, - "frameworkAdapter": { - "description": "Framework Adapter", + "oAuth2Discord": { + "description": "OAuth2Discord", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Adapter key.", - "x-example": "static" - }, - "installCommand": { + "$id": { "type": "string", - "description": "Default command to download dependencies.", - "x-example": "npm install" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "buildCommand": { - "type": "string", - "description": "Default command to build site into output directory.", - "x-example": "npm run build" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "outputDirectory": { + "clientId": { "type": "string", - "description": "Default output directory of build.", - "x-example": ".\/dist" + "description": "Discord OAuth2 client ID.", + "x-example": "950722000000343754" }, - "fallbackFile": { + "clientSecret": { "type": "string", - "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "description": "Discord OAuth2 client secret.", + "x-example": "YmPXnM000000000000000000002zFg5D" } }, "required": [ - "key", - "installCommand", - "buildCommand", - "outputDirectory", - "fallbackFile" + "$id", + "enabled", + "clientId", + "clientSecret" ], "example": { - "key": "static", - "installCommand": "npm install", - "buildCommand": "npm run build", - "outputDirectory": ".\/dist", - "fallbackFile": "index.html" + "$id": "github", + "enabled": false, + "clientId": "950722000000343754", + "clientSecret": "YmPXnM000000000000000000002zFg5D" } }, - "deployment": { - "description": "Deployment", + "oAuth2Figma": { + "description": "OAuth2Figma", "type": "object", "properties": { "$id": { "type": "string", - "description": "Deployment ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Deployment update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Figma OAuth2 client ID.", + "x-example": "byay5H0000000000VtiI40" }, - "type": { + "clientSecret": { "type": "string", - "description": "Type of deployment.", - "x-example": "vcs" - }, - "resourceId": { + "description": "Figma OAuth2 client secret.", + "x-example": "yEpOYn0000000000000000004iIsU5" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "byay5H0000000000VtiI40", + "clientSecret": "yEpOYn0000000000000000004iIsU5" + } + }, + "oAuth2Dropbox": { + "description": "OAuth2Dropbox", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea6g16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "resourceType": { - "type": "string", - "description": "Resource type.", - "x-example": "functions" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "entrypoint": { + "appKey": { "type": "string", - "description": "The entrypoint file to use to execute the deployment code.", - "x-example": "index.js" - }, - "sourceSize": { - "type": "integer", - "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" - }, - "buildSize": { - "type": "integer", - "description": "The build output size in bytes.", - "x-example": 128, - "format": "int32" + "description": "Dropbox OAuth2 app key.", + "x-example": "jl000000000009t" }, - "totalSize": { - "type": "integer", - "description": "The total size in bytes (source and build output).", - "x-example": 128, - "format": "int32" - }, - "buildId": { + "appSecret": { "type": "string", - "description": "The current build ID.", - "x-example": "5e5ea5c16897e" + "description": "Dropbox OAuth2 app secret.", + "x-example": "g200000000000vw" + } + }, + "required": [ + "$id", + "enabled", + "appKey", + "appSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "appKey": "jl000000000009t", + "appSecret": "g200000000000vw" + } + }, + "oAuth2Dailymotion": { + "description": "OAuth2Dailymotion", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "activate": { + "enabled": { "type": "boolean", - "description": "Whether the deployment should be automatically activated.", - "x-example": true - }, - "screenshotLight": { - "type": "string", - "description": "Screenshot with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "screenshotDark": { + "apiKey": { "type": "string", - "description": "Screenshot with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "description": "Dailymotion OAuth2 API key.", + "x-example": "07a9000000000000067f" }, - "status": { + "apiSecret": { "type": "string", - "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", - "x-example": "ready", - "enum": [ - "waiting", - "processing", - "building", - "ready", - "canceled", - "failed" - ] - }, - "buildLogs": { + "description": "Dailymotion OAuth2 API secret.", + "x-example": "a399a90000000000000000000000000000d90639" + } + }, + "required": [ + "$id", + "enabled", + "apiKey", + "apiSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "apiKey": "07a9000000000000067f", + "apiSecret": "a399a90000000000000000000000000000d90639" + } + }, + "oAuth2Bitbucket": { + "description": "OAuth2Bitbucket", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The build logs.", - "x-example": "Compiling source files..." + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "buildDuration": { - "type": "integer", - "description": "The current build time in seconds.", - "x-example": 128, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerRepositoryName": { + "key": { "type": "string", - "description": "The name of the vcs provider repository", - "x-example": "database" + "description": "Bitbucket OAuth2 key.", + "x-example": "Knt70000000000ByRc" }, - "providerRepositoryOwner": { + "secret": { "type": "string", - "description": "The name of the vcs provider repository owner", - "x-example": "utopia" - }, - "providerRepositoryUrl": { + "description": "Bitbucket OAuth2 secret.", + "x-example": "NMfLZJ00000000000000000000TLQdDx" + } + }, + "required": [ + "$id", + "enabled", + "key", + "secret" + ], + "example": { + "$id": "github", + "enabled": false, + "key": "Knt70000000000ByRc", + "secret": "NMfLZJ00000000000000000000TLQdDx" + } + }, + "oAuth2Bitly": { + "description": "OAuth2Bitly", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The url of the vcs provider repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "providerCommitHash": { - "type": "string", - "description": "The commit hash of the vcs commit", - "x-example": "7c3f25d" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerCommitAuthorUrl": { + "clientId": { "type": "string", - "description": "The url of vcs commit author", - "x-example": "https:\/\/github.com\/vermakhushboo" + "description": "Bitly OAuth2 client ID.", + "x-example": "d95151000000000000000000000000000067af9b" }, - "providerCommitAuthor": { + "clientSecret": { "type": "string", - "description": "The name of vcs commit author", - "x-example": "Khushboo Verma" - }, - "providerCommitMessage": { + "description": "Bitly OAuth2 client secret.", + "x-example": "a13e250000000000000000000000000000d73095" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "d95151000000000000000000000000000067af9b", + "clientSecret": "a13e250000000000000000000000000000d73095" + } + }, + "oAuth2Box": { + "description": "OAuth2Box", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The commit message", - "x-example": "Update index.js" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "providerCommitUrl": { - "type": "string", - "description": "The url of the vcs commit", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerBranch": { + "clientId": { "type": "string", - "description": "The branch of the vcs repository", - "x-example": "0.7.x" + "description": "Box OAuth2 client ID.", + "x-example": "deglcs00000000000000000000x2og6y" }, - "providerBranchUrl": { + "clientSecret": { "type": "string", - "description": "The branch of the vcs repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "description": "Box OAuth2 client secret.", + "x-example": "OKM1f100000000000000000000eshEif" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "type", - "resourceId", - "resourceType", - "entrypoint", - "sourceSize", - "buildSize", - "totalSize", - "buildId", - "activate", - "screenshotLight", - "screenshotDark", - "status", - "buildLogs", - "buildDuration", - "providerRepositoryName", - "providerRepositoryOwner", - "providerRepositoryUrl", - "providerCommitHash", - "providerCommitAuthorUrl", - "providerCommitAuthor", - "providerCommitMessage", - "providerCommitUrl", - "providerBranch", - "providerBranchUrl" + "enabled", + "clientId", + "clientSecret" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "type": "vcs", - "resourceId": "5e5ea6g16897e", - "resourceType": "functions", - "entrypoint": "index.js", - "sourceSize": 128, - "buildSize": 128, - "totalSize": 128, - "buildId": "5e5ea5c16897e", - "activate": true, - "screenshotLight": "5e5ea5c16897e", - "screenshotDark": "5e5ea5c16897e", - "status": "ready", - "buildLogs": "Compiling source files...", - "buildDuration": 128, - "providerRepositoryName": "database", - "providerRepositoryOwner": "utopia", - "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function", - "providerCommitHash": "7c3f25d", - "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo", - "providerCommitAuthor": "Khushboo Verma", - "providerCommitMessage": "Update index.js", - "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", - "providerBranch": "0.7.x", - "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "$id": "github", + "enabled": false, + "clientId": "deglcs00000000000000000000x2og6y", + "clientSecret": "OKM1f100000000000000000000eshEif" } }, - "execution": { - "description": "Execution", + "oAuth2Autodesk": { + "description": "OAuth2Autodesk", "type": "object", "properties": { "$id": { "type": "string", - "description": "Execution ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Execution creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Execution update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Execution roles.", - "items": { - "type": "string" - }, - "x-example": [ - "any" - ] + "description": "Autodesk OAuth2 client ID.", + "x-example": "5zw90v00000000000000000000kVYXN7" }, - "functionId": { + "clientSecret": { "type": "string", - "description": "Function ID.", - "x-example": "5e5ea6g16897e" - }, - "deploymentId": { + "description": "Autodesk OAuth2 client secret.", + "x-example": "7I000000000000MW" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "5zw90v00000000000000000000kVYXN7", + "clientSecret": "7I000000000000MW" + } + }, + "oAuth2Google": { + "description": "OAuth2Google", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Function's deployment ID used to create the execution.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "trigger": { - "type": "string", - "description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.", - "x-example": "http", - "enum": [ - "http", - "schedule", - "event" - ] + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "status": { + "clientId": { "type": "string", - "description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", - "x-example": "processing", - "enum": [ - "waiting", - "processing", - "completed", - "failed", - "scheduled" - ] + "description": "Google OAuth2 client ID.", + "x-example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" }, - "requestMethod": { + "clientSecret": { "type": "string", - "description": "HTTP request method type.", - "x-example": "GET" - }, - "requestPath": { + "description": "Google OAuth2 client secret.", + "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", + "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj" + } + }, + "oAuth2Zoom": { + "description": "OAuth2Zoom", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "HTTP request path and query.", - "x-example": "\/articles?id=5" - }, - "requestHeaders": { - "type": "array", - "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", - "items": { - "$ref": "#\/components\/schemas\/headers" - }, - "x-example": [ - { - "Content-Type": "application\/json" - } - ] + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "responseStatusCode": { - "type": "integer", - "description": "HTTP response status code.", - "x-example": 200, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "responseBody": { + "clientId": { "type": "string", - "description": "HTTP response body. This will return empty unless execution is created as synchronous.", - "x-example": "" - }, - "responseHeaders": { - "type": "array", - "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", - "items": { - "$ref": "#\/components\/schemas\/headers" - }, - "x-example": [ - { - "Content-Type": "application\/json" - } - ] + "description": "Zoom OAuth2 client ID.", + "x-example": "QMAC00000000000000w0AQ" }, - "logs": { + "clientSecret": { + "type": "string", + "description": "Zoom OAuth2 client secret.", + "x-example": "GAWsG4000000000000000000007U01ON" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "QMAC00000000000000w0AQ", + "clientSecret": "GAWsG4000000000000000000007U01ON" + } + }, + "oAuth2Zoho": { + "description": "OAuth2Zoho", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "errors": { - "type": "string", - "description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "duration": { - "type": "number", - "description": "Resource(function\/site) execution duration in seconds.", - "x-example": 0.4, - "format": "double" + "clientId": { + "type": "string", + "description": "Zoho OAuth2 client ID.", + "x-example": "1000.83C178000000000000000000RPNX0B" }, - "scheduledAt": { + "clientSecret": { "type": "string", - "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "nullable": true + "description": "Zoho OAuth2 client secret.", + "x-example": "fb5cac000000000000000000000000000000a68f6e" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "$permissions", - "functionId", - "deploymentId", - "trigger", - "status", - "requestMethod", - "requestPath", - "requestHeaders", - "responseStatusCode", - "responseBody", - "responseHeaders", - "logs", - "errors", - "duration" + "enabled", + "clientId", + "clientSecret" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "any" - ], - "functionId": "5e5ea6g16897e", - "deploymentId": "5e5ea5c16897e", - "trigger": "http", - "status": "processing", - "requestMethod": "GET", - "requestPath": "\/articles?id=5", - "requestHeaders": [ - { - "Content-Type": "application\/json" - } - ], - "responseStatusCode": 200, - "responseBody": "", - "responseHeaders": [ - { - "Content-Type": "application\/json" - } - ], - "logs": "", - "errors": "", - "duration": 0.4, - "scheduledAt": "2020-10-15T06:38:00.000+00:00" + "$id": "github", + "enabled": false, + "clientId": "1000.83C178000000000000000000RPNX0B", + "clientSecret": "fb5cac000000000000000000000000000000a68f6e" } }, - "project": { - "description": "Project", + "oAuth2Yandex": { + "description": "OAuth2Yandex", "type": "object", "properties": { "$id": { "type": "string", - "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Project creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Project update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Yandex OAuth2 client ID.", + "x-example": "6a8a6a0000000000000000000091483c" }, - "name": { + "clientSecret": { "type": "string", - "description": "Project name.", - "x-example": "New Project" - }, - "description": { + "description": "Yandex OAuth2 client secret.", + "x-example": "bbf98500000000000000000000c75a63" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "6a8a6a0000000000000000000091483c", + "clientSecret": "bbf98500000000000000000000c75a63" + } + }, + "oAuth2X": { + "description": "OAuth2X", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Project description.", - "x-example": "This is a new project." + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "teamId": { - "type": "string", - "description": "Project team ID.", - "x-example": "1592981250" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "logo": { + "customerKey": { "type": "string", - "description": "Project logo file ID.", - "x-example": "5f5c451b403cb" + "description": "X OAuth2 customer key.", + "x-example": "slzZV0000000000000NFLaWT" }, - "url": { + "secretKey": { "type": "string", - "description": "Project website URL.", - "x-example": "5f5c451b403cb" - }, - "legalName": { + "description": "X OAuth2 secret key.", + "x-example": "tkEPkp00000000000000000000000000000000000000FTxbI9" + } + }, + "required": [ + "$id", + "enabled", + "customerKey", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "customerKey": "slzZV0000000000000NFLaWT", + "secretKey": "tkEPkp00000000000000000000000000000000000000FTxbI9" + } + }, + "oAuth2WordPress": { + "description": "OAuth2WordPress", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Company legal name.", - "x-example": "Company LTD." + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "legalCountry": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", - "x-example": "US" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "legalState": { + "clientId": { "type": "string", - "description": "State name.", - "x-example": "New York" + "description": "WordPress OAuth2 client ID.", + "x-example": "130005" }, - "legalCity": { + "clientSecret": { "type": "string", - "description": "City name.", - "x-example": "New York City." - }, - "legalAddress": { + "description": "WordPress OAuth2 client secret.", + "x-example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "130005", + "clientSecret": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" + } + }, + "oAuth2Twitch": { + "description": "OAuth2Twitch", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Company Address.", - "x-example": "620 Eighth Avenue, New York, NY 10018" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "legalTaxId": { + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "clientId": { "type": "string", - "description": "Company Tax ID.", - "x-example": "131102020" + "description": "Twitch OAuth2 client ID.", + "x-example": "vvi0in000000000000000000ikmt9p" }, - "authDuration": { - "type": "integer", - "description": "Session duration in seconds.", - "x-example": 60, - "format": "int32" + "clientSecret": { + "type": "string", + "description": "Twitch OAuth2 client secret.", + "x-example": "pmapue000000000000000000zylw3v" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "vvi0in000000000000000000ikmt9p", + "clientSecret": "pmapue000000000000000000zylw3v" + } + }, + "oAuth2Stripe": { + "description": "OAuth2Stripe", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authLimit": { - "type": "integer", - "description": "Max users allowed. 0 is unlimited.", - "x-example": 100, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authSessionsLimit": { - "type": "integer", - "description": "Max sessions allowed per user. 100 maximum.", - "x-example": 10, - "format": "int32" + "clientId": { + "type": "string", + "description": "Stripe OAuth2 client ID.", + "x-example": "ca_UKibXX0000000000000000000006byvR" }, - "authPasswordHistory": { - "type": "integer", - "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", - "x-example": 5, - "format": "int32" + "apiSecretKey": { + "type": "string", + "description": "Stripe OAuth2 API secret key.", + "x-example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "apiSecretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "ca_UKibXX0000000000000000000006byvR", + "apiSecretKey": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + } + }, + "oAuth2Spotify": { + "description": "OAuth2Spotify", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authPasswordDictionary": { + "enabled": { "type": "boolean", - "description": "Whether or not to check user's password against most commonly used passwords.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authPersonalDataCheck": { - "type": "boolean", - "description": "Whether or not to check the user password for similarity with their personal data.", - "x-example": true + "clientId": { + "type": "string", + "description": "Spotify OAuth2 client ID.", + "x-example": "6ec271000000000000000000009beace" }, - "authDisposableEmails": { - "type": "boolean", - "description": "Whether or not to disallow disposable email addresses during signup and email updates.", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Spotify OAuth2 client secret.", + "x-example": "db068a000000000000000000008b5b9f" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "6ec271000000000000000000009beace", + "clientSecret": "db068a000000000000000000008b5b9f" + } + }, + "oAuth2Slack": { + "description": "OAuth2Slack", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authCanonicalEmails": { + "enabled": { "type": "boolean", - "description": "Whether or not to require canonical email addresses during signup and email updates.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authFreeEmails": { - "type": "boolean", - "description": "Whether or not to disallow free email addresses during signup and email updates.", - "x-example": true + "clientId": { + "type": "string", + "description": "Slack OAuth2 client ID.", + "x-example": "23000000089.15000000000023" }, - "authMockNumbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs).", - "items": { - "$ref": "#\/components\/schemas\/mockNumber" - }, - "x-example": [ - {} - ] + "clientSecret": { + "type": "string", + "description": "Slack OAuth2 client secret.", + "x-example": "81656000000000000000000000f3d2fd" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "23000000089.15000000000023", + "clientSecret": "81656000000000000000000000f3d2fd" + } + }, + "oAuth2Podio": { + "description": "OAuth2Podio", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authSessionAlerts": { + "enabled": { "type": "boolean", - "description": "Whether or not to send session alert emails to users.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authMembershipsUserName": { - "type": "boolean", - "description": "Whether or not to show user names in the teams membership response.", - "x-example": true + "clientId": { + "type": "string", + "description": "Podio OAuth2 client ID.", + "x-example": "appwrite-oauth-test-app" }, - "authMembershipsUserEmail": { - "type": "boolean", - "description": "Whether or not to show user emails in the teams membership response.", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Podio OAuth2 client secret.", + "x-example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "appwrite-oauth-test-app", + "clientSecret": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + } + }, + "oAuth2Notion": { + "description": "OAuth2Notion", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authMembershipsMfa": { + "enabled": { "type": "boolean", - "description": "Whether or not to show user MFA status in the teams membership response.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authMembershipsUserId": { - "type": "boolean", - "description": "Whether or not to show user IDs in the teams membership response.", - "x-example": true + "oauthClientId": { + "type": "string", + "description": "Notion OAuth2 client ID.", + "x-example": "341d8700-0000-0000-0000-000000446ee3" }, - "authMembershipsUserPhone": { - "type": "boolean", - "description": "Whether or not to show user phone numbers in the teams membership response.", - "x-example": true + "oauthClientSecret": { + "type": "string", + "description": "Notion OAuth2 client secret.", + "x-example": "secret_dLUr4b000000000000000000000000000000lFHAa9" + } + }, + "required": [ + "$id", + "enabled", + "oauthClientId", + "oauthClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "oauthClientId": "341d8700-0000-0000-0000-000000446ee3", + "oauthClientSecret": "secret_dLUr4b000000000000000000000000000000lFHAa9" + } + }, + "oAuth2Salesforce": { + "description": "OAuth2Salesforce", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authInvalidateSessions": { + "enabled": { "type": "boolean", - "description": "Whether or not all existing sessions should be invalidated on password change", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "oAuthProviders": { - "type": "array", - "description": "List of Auth Providers.", - "items": { - "$ref": "#\/components\/schemas\/authProvider" - }, - "x-example": [ - {} - ] + "customerKey": { + "type": "string", + "description": "Salesforce OAuth2 consumer key.", + "x-example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" }, - "platforms": { - "type": "array", - "description": "List of Platforms.", - "items": { - "anyOf": [ - { - "$ref": "#\/components\/schemas\/platformWeb" - }, - { - "$ref": "#\/components\/schemas\/platformApple" - }, - { - "$ref": "#\/components\/schemas\/platformAndroid" - }, - { - "$ref": "#\/components\/schemas\/platformWindows" - }, - { - "$ref": "#\/components\/schemas\/platformLinux" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/components\/schemas\/platformWeb", - "apple": "#\/components\/schemas\/platformApple", - "android": "#\/components\/schemas\/platformAndroid", - "windows": "#\/components\/schemas\/platformWindows", - "linux": "#\/components\/schemas\/platformLinux" - } - } - }, - "x-example": {} + "customerSecret": { + "type": "string", + "description": "Salesforce OAuth2 consumer secret.", + "x-example": "3w000000000000e2" + } + }, + "required": [ + "$id", + "enabled", + "customerKey", + "customerSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "customerKey": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", + "customerSecret": "3w000000000000e2" + } + }, + "oAuth2Yahoo": { + "description": "OAuth2Yahoo", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "webhooks": { - "type": "array", - "description": "List of Webhooks.", - "items": { - "$ref": "#\/components\/schemas\/webhook" - }, - "x-example": {} + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "keys": { - "type": "array", - "description": "List of API Keys.", - "items": { - "$ref": "#\/components\/schemas\/key" - }, - "x-example": {} + "clientId": { + "type": "string", + "description": "Yahoo OAuth2 client ID.", + "x-example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" }, - "devKeys": { - "type": "array", - "description": "List of dev keys.", - "items": { - "$ref": "#\/components\/schemas\/devKey" - }, - "x-example": {} + "clientSecret": { + "type": "string", + "description": "Yahoo OAuth2 client secret.", + "x-example": "cf978f0000000000000000000000000000c5e2e9" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", + "clientSecret": "cf978f0000000000000000000000000000c5e2e9" + } + }, + "oAuth2Linkedin": { + "description": "OAuth2Linkedin", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpEnabled": { + "enabled": { "type": "boolean", - "description": "Status for custom SMTP", + "description": "OAuth2 provider is active and can be used to create sessions.", "x-example": false }, - "smtpSenderName": { + "clientId": { "type": "string", - "description": "SMTP sender name", - "x-example": "John Appwrite" + "description": "LinkedIn OAuth2 client ID.", + "x-example": "770000000000dv" }, - "smtpSenderEmail": { + "primaryClientSecret": { "type": "string", - "description": "SMTP sender email", - "x-example": "john@appwrite.io" - }, - "smtpReplyToName": { + "description": "LinkedIn OAuth2 primary client secret.", + "x-example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "primaryClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "770000000000dv", + "primaryClientSecret": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + } + }, + "oAuth2Disqus": { + "description": "OAuth2Disqus", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "SMTP reply to name", - "x-example": "Support Team" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpReplyToEmail": { + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "publicKey": { "type": "string", - "description": "SMTP reply to email", - "x-example": "support@appwrite.io" + "description": "Disqus OAuth2 public key.", + "x-example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" }, - "smtpHost": { + "secretKey": { "type": "string", - "description": "SMTP server host name", - "x-example": "mail.appwrite.io" + "description": "Disqus OAuth2 secret key.", + "x-example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + } + }, + "required": [ + "$id", + "enabled", + "publicKey", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "publicKey": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", + "secretKey": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + } + }, + "oAuth2Amazon": { + "description": "OAuth2Amazon", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpPort": { - "type": "integer", - "description": "SMTP server port", - "x-example": 25, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "smtpUsername": { + "clientId": { "type": "string", - "description": "SMTP server username", - "x-example": "emailuser" + "description": "Amazon OAuth2 client ID.", + "x-example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" }, - "smtpPassword": { + "clientSecret": { "type": "string", - "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "" - }, - "smtpSecure": { + "description": "Amazon OAuth2 client secret.", + "x-example": "79ffe4000000000000000000000000000000000000000000000000000002de55" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2", + "clientSecret": "79ffe4000000000000000000000000000000000000000000000000000002de55" + } + }, + "oAuth2Etsy": { + "description": "OAuth2Etsy", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "SMTP server secure protocol", - "x-example": "tls" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "pingCount": { - "type": "integer", - "description": "Number of times the ping was received for this project.", - "x-example": 1, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "pingedAt": { + "keyString": { "type": "string", - "description": "Last ping datetime in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "labels": { - "type": "array", - "description": "Labels for the project.", - "items": { - "type": "string" - }, - "x-example": [ - "vip" - ] + "description": "Etsy OAuth2 keystring.", + "x-example": "nsgzxh0000000000008j85a2" }, - "status": { + "sharedSecret": { "type": "string", - "description": "Project status", - "x-example": "active" - }, - "authEmailPassword": { - "type": "boolean", - "description": "Email\/Password auth method status", - "x-example": true + "description": "Etsy OAuth2 shared secret.", + "x-example": "tp000000ru" + } + }, + "required": [ + "$id", + "enabled", + "keyString", + "sharedSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "keyString": "nsgzxh0000000000008j85a2", + "sharedSecret": "tp000000ru" + } + }, + "oAuth2Facebook": { + "description": "OAuth2Facebook", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authUsersAuthMagicURL": { + "enabled": { "type": "boolean", - "description": "Magic URL auth method status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authEmailOtp": { - "type": "boolean", - "description": "Email (OTP) auth method status", - "x-example": true + "appId": { + "type": "string", + "description": "Facebook OAuth2 app ID.", + "x-example": "260600000007694" }, - "authAnonymous": { - "type": "boolean", - "description": "Anonymous auth method status", - "x-example": true + "appSecret": { + "type": "string", + "description": "Facebook OAuth2 app secret.", + "x-example": "2d0b2800000000000000000000d38af4" + } + }, + "required": [ + "$id", + "enabled", + "appId", + "appSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "appId": "260600000007694", + "appSecret": "2d0b2800000000000000000000d38af4" + } + }, + "oAuth2Tradeshift": { + "description": "OAuth2Tradeshift", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authInvites": { + "enabled": { "type": "boolean", - "description": "Invites auth method status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authJWT": { - "type": "boolean", - "description": "JWT auth method status", - "x-example": true + "oauth2ClientId": { + "type": "string", + "description": "Tradeshift OAuth2 client ID.", + "x-example": "appwrite-test-org.appwrite-test-app" }, - "authPhone": { - "type": "boolean", - "description": "Phone auth method status", - "x-example": true + "oauth2ClientSecret": { + "type": "string", + "description": "Tradeshift OAuth2 client secret.", + "x-example": "7cb52700-0000-0000-0000-000000ca5b83" + } + }, + "required": [ + "$id", + "enabled", + "oauth2ClientId", + "oauth2ClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "oauth2ClientId": "appwrite-test-org.appwrite-test-app", + "oauth2ClientSecret": "7cb52700-0000-0000-0000-000000ca5b83" + } + }, + "oAuth2Paypal": { + "description": "OAuth2Paypal", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForAccount": { + "enabled": { "type": "boolean", - "description": "Account service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForAvatars": { - "type": "boolean", - "description": "Avatars service status", - "x-example": true + "clientId": { + "type": "string", + "description": "PayPal OAuth2 client ID.", + "x-example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" }, - "serviceStatusForDatabases": { - "type": "boolean", - "description": "Databases (legacy) service status", - "x-example": true + "secretKey": { + "type": "string", + "description": "PayPal OAuth2 secret key.", + "x-example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "secretKey": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + } + }, + "oAuth2Gitlab": { + "description": "OAuth2Gitlab", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForTablesdb": { + "enabled": { "type": "boolean", - "description": "TablesDB service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForLocale": { - "type": "boolean", - "description": "Locale service status", - "x-example": true + "applicationId": { + "type": "string", + "description": "GitLab OAuth2 application ID.", + "x-example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" }, - "serviceStatusForHealth": { - "type": "boolean", - "description": "Health service status", - "x-example": true + "secret": { + "type": "string", + "description": "GitLab OAuth2 secret.", + "x-example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" }, - "serviceStatusForProject": { - "type": "boolean", - "description": "Project service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "GitLab OAuth2 endpoint URL. Defaults to https:\/\/gitlab.com for self-hosted instances.", + "x-example": "https:\/\/gitlab.com" + } + }, + "required": [ + "$id", + "enabled", + "applicationId", + "secret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "applicationId": "d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "secret": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "endpoint": "https:\/\/gitlab.com" + } + }, + "oAuth2Authentik": { + "description": "OAuth2Authentik", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForStorage": { + "enabled": { "type": "boolean", - "description": "Storage service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForTeams": { - "type": "boolean", - "description": "Teams service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Authentik OAuth2 client ID.", + "x-example": "dTKOPa0000000000000000000000000000e7G8hv" }, - "serviceStatusForUsers": { - "type": "boolean", - "description": "Users service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Authentik OAuth2 client secret.", + "x-example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" }, - "serviceStatusForVcs": { - "type": "boolean", - "description": "VCS service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Authentik OAuth2 endpoint domain.", + "x-example": "example.authentik.com" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "dTKOPa0000000000000000000000000000e7G8hv", + "clientSecret": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", + "endpoint": "example.authentik.com" + } + }, + "oAuth2Auth0": { + "description": "OAuth2Auth0", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForSites": { + "enabled": { "type": "boolean", - "description": "Sites service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForFunctions": { - "type": "boolean", - "description": "Functions service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Auth0 OAuth2 client ID.", + "x-example": "OaOkIA000000000000000000005KLSYq" }, - "serviceStatusForProxy": { - "type": "boolean", - "description": "Proxy service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Auth0 OAuth2 client secret.", + "x-example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" }, - "serviceStatusForGraphql": { - "type": "boolean", - "description": "GraphQL service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Auth0 OAuth2 endpoint domain.", + "x-example": "example.us.auth0.com" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "OaOkIA000000000000000000005KLSYq", + "clientSecret": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", + "endpoint": "example.us.auth0.com" + } + }, + "oAuth2FusionAuth": { + "description": "OAuth2FusionAuth", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForMigrations": { + "enabled": { "type": "boolean", - "description": "Migrations service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForMessaging": { - "type": "boolean", - "description": "Messaging service status", - "x-example": true + "clientId": { + "type": "string", + "description": "FusionAuth OAuth2 client ID.", + "x-example": "b2222c00-0000-0000-0000-000000862097" }, - "protocolStatusForRest": { - "type": "boolean", - "description": "REST protocol status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "FusionAuth OAuth2 client secret.", + "x-example": "Jx4s0C0000000000000000000000000000000wGqLsc" }, - "protocolStatusForGraphql": { - "type": "boolean", - "description": "GraphQL protocol status", - "x-example": true + "endpoint": { + "type": "string", + "description": "FusionAuth OAuth2 endpoint domain.", + "x-example": "example.fusionauth.io" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "b2222c00-0000-0000-0000-000000862097", + "clientSecret": "Jx4s0C0000000000000000000000000000000wGqLsc", + "endpoint": "example.fusionauth.io" + } + }, + "oAuth2Keycloak": { + "description": "OAuth2Keycloak", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "protocolStatusForWebsocket": { + "enabled": { "type": "boolean", - "description": "Websocket protocol status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "region": { + "clientId": { "type": "string", - "description": "Project region", - "x-example": "fra" + "description": "Keycloak OAuth2 client ID.", + "x-example": "appwrite-o0000000st-app" }, - "billingLimits": { - "type": "object", - "description": "Billing limits reached", - "x-example": "", - "items": { - "$ref": "#\/components\/schemas\/billingLimits" - } + "clientSecret": { + "type": "string", + "description": "Keycloak OAuth2 client secret.", + "x-example": "jdjrJd00000000000000000000HUsaZO" }, - "blocks": { - "type": "array", - "description": "Project blocks information", - "items": { - "$ref": "#\/components\/schemas\/block" - }, - "x-example": "" + "endpoint": { + "type": "string", + "description": "Keycloak OAuth2 endpoint domain.", + "x-example": "keycloak.example.com" }, - "consoleAccessedAt": { + "realmName": { "type": "string", - "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Keycloak OAuth2 realm name.", + "x-example": "appwrite-realm" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "description", - "teamId", - "logo", - "url", - "legalName", - "legalCountry", - "legalState", - "legalCity", - "legalAddress", - "legalTaxId", - "authDuration", - "authLimit", - "authSessionsLimit", - "authPasswordHistory", - "authPasswordDictionary", - "authPersonalDataCheck", - "authDisposableEmails", - "authCanonicalEmails", - "authFreeEmails", - "authMockNumbers", - "authSessionAlerts", - "authMembershipsUserName", - "authMembershipsUserEmail", - "authMembershipsMfa", - "authMembershipsUserId", - "authMembershipsUserPhone", - "authInvalidateSessions", - "oAuthProviders", - "platforms", - "webhooks", - "keys", - "devKeys", - "smtpEnabled", - "smtpSenderName", - "smtpSenderEmail", - "smtpReplyToName", - "smtpReplyToEmail", - "smtpHost", - "smtpPort", - "smtpUsername", - "smtpPassword", - "smtpSecure", - "pingCount", - "pingedAt", - "labels", - "status", - "authEmailPassword", - "authUsersAuthMagicURL", - "authEmailOtp", - "authAnonymous", - "authInvites", - "authJWT", - "authPhone", - "serviceStatusForAccount", - "serviceStatusForAvatars", - "serviceStatusForDatabases", - "serviceStatusForTablesdb", - "serviceStatusForLocale", - "serviceStatusForHealth", - "serviceStatusForProject", - "serviceStatusForStorage", - "serviceStatusForTeams", - "serviceStatusForUsers", - "serviceStatusForVcs", - "serviceStatusForSites", - "serviceStatusForFunctions", - "serviceStatusForProxy", - "serviceStatusForGraphql", - "serviceStatusForMigrations", - "serviceStatusForMessaging", - "protocolStatusForRest", - "protocolStatusForGraphql", - "protocolStatusForWebsocket", - "region", - "billingLimits", - "blocks", - "consoleAccessedAt" + "enabled", + "clientId", + "clientSecret", + "endpoint", + "realmName" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "New Project", - "description": "This is a new project.", - "teamId": "1592981250", - "logo": "5f5c451b403cb", - "url": "5f5c451b403cb", - "legalName": "Company LTD.", - "legalCountry": "US", - "legalState": "New York", - "legalCity": "New York City.", - "legalAddress": "620 Eighth Avenue, New York, NY 10018", - "legalTaxId": "131102020", - "authDuration": 60, - "authLimit": 100, - "authSessionsLimit": 10, - "authPasswordHistory": 5, - "authPasswordDictionary": true, - "authPersonalDataCheck": true, - "authDisposableEmails": true, - "authCanonicalEmails": true, - "authFreeEmails": true, - "authMockNumbers": [ - {} - ], - "authSessionAlerts": true, - "authMembershipsUserName": true, - "authMembershipsUserEmail": true, - "authMembershipsMfa": true, - "authMembershipsUserId": true, - "authMembershipsUserPhone": true, - "authInvalidateSessions": true, - "oAuthProviders": [ - {} - ], - "platforms": {}, - "webhooks": {}, - "keys": {}, - "devKeys": {}, - "smtpEnabled": false, - "smtpSenderName": "John Appwrite", - "smtpSenderEmail": "john@appwrite.io", - "smtpReplyToName": "Support Team", - "smtpReplyToEmail": "support@appwrite.io", - "smtpHost": "mail.appwrite.io", - "smtpPort": 25, - "smtpUsername": "emailuser", - "smtpPassword": "", - "smtpSecure": "tls", - "pingCount": 1, - "pingedAt": "2020-10-15T06:38:00.000+00:00", - "labels": [ - "vip" - ], - "status": "active", - "authEmailPassword": true, - "authUsersAuthMagicURL": true, - "authEmailOtp": true, - "authAnonymous": true, - "authInvites": true, - "authJWT": true, - "authPhone": true, - "serviceStatusForAccount": true, - "serviceStatusForAvatars": true, - "serviceStatusForDatabases": true, - "serviceStatusForTablesdb": true, - "serviceStatusForLocale": true, - "serviceStatusForHealth": true, - "serviceStatusForProject": true, - "serviceStatusForStorage": true, - "serviceStatusForTeams": true, - "serviceStatusForUsers": true, - "serviceStatusForVcs": true, - "serviceStatusForSites": true, - "serviceStatusForFunctions": true, - "serviceStatusForProxy": true, - "serviceStatusForGraphql": true, - "serviceStatusForMigrations": true, - "serviceStatusForMessaging": true, - "protocolStatusForRest": true, - "protocolStatusForGraphql": true, - "protocolStatusForWebsocket": true, - "region": "fra", - "billingLimits": "", - "blocks": "", - "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + "$id": "github", + "enabled": false, + "clientId": "appwrite-o0000000st-app", + "clientSecret": "jdjrJd00000000000000000000HUsaZO", + "endpoint": "keycloak.example.com", + "realmName": "appwrite-realm" } }, - "webhook": { - "description": "Webhook", + "oAuth2Oidc": { + "description": "OAuth2Oidc", "type": "object", "properties": { "$id": { "type": "string", - "description": "Webhook ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "clientId": { + "type": "string", + "description": "OpenID Connect OAuth2 client ID.", + "x-example": "qibI2x0000000000000000000000000006L2YFoG" }, - "$createdAt": { + "clientSecret": { "type": "string", - "description": "Webhook creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "OpenID Connect OAuth2 client secret.", + "x-example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" }, - "$updatedAt": { + "wellKnownURL": { "type": "string", - "description": "Webhook update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "OpenID Connect well-known configuration URL. When set, authorization, token, and user info endpoints can be discovered automatically.", + "x-example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" }, - "name": { + "authorizationURL": { "type": "string", - "description": "Webhook name.", - "x-example": "My Webhook" + "description": "OpenID Connect authorization endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" }, - "url": { + "tokenUrl": { "type": "string", - "description": "Webhook URL endpoint.", - "x-example": "https:\/\/example.com\/webhook" + "description": "OpenID Connect token endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/token" }, - "events": { - "type": "array", - "description": "Webhook trigger events.", - "items": { - "type": "string" - }, - "x-example": [ - "databases.tables.update", - "databases.collections.update" - ] + "userInfoUrl": { + "type": "string", + "description": "OpenID Connect user info endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "wellKnownURL", + "authorizationURL", + "tokenUrl", + "userInfoUrl" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "qibI2x0000000000000000000000000006L2YFoG", + "clientSecret": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", + "wellKnownURL": "https:\/\/myoauth.com\/.well-known\/openid-configuration", + "authorizationURL": "https:\/\/myoauth.com\/oauth2\/authorize", + "tokenUrl": "https:\/\/myoauth.com\/oauth2\/token", + "userInfoUrl": "https:\/\/myoauth.com\/oauth2\/userinfo" + } + }, + "oAuth2Okta": { + "description": "OAuth2Okta", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "tls": { + "enabled": { "type": "boolean", - "description": "Indicates if SSL \/ TLS certificate verification is enabled.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authUsername": { + "clientId": { "type": "string", - "description": "HTTP basic authentication username.", - "x-example": "username" + "description": "Okta OAuth2 client ID.", + "x-example": "0oa00000000000000698" }, - "authPassword": { + "clientSecret": { "type": "string", - "description": "HTTP basic authentication password.", - "x-example": "password" + "description": "Okta OAuth2 client secret.", + "x-example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" }, - "secret": { + "domain": { "type": "string", - "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", - "x-example": "ad3d581ca230e2b7059c545e5a" + "description": "Okta OAuth2 domain.", + "x-example": "trial-6400025.okta.com" + }, + "authorizationServerId": { + "type": "string", + "description": "Okta OAuth2 authorization server ID.", + "x-example": "aus000000000000000h7z" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "domain", + "authorizationServerId" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "0oa00000000000000698", + "clientSecret": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "domain": "trial-6400025.okta.com", + "authorizationServerId": "aus000000000000000h7z" + } + }, + "oAuth2Kick": { + "description": "OAuth2Kick", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, "enabled": { "type": "boolean", - "description": "Indicates if this webhook is enabled.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "logs": { + "clientId": { "type": "string", - "description": "Webhook error logs from the most recent failure.", - "x-example": "Failed to connect to remote server." + "description": "Kick OAuth2 client ID.", + "x-example": "01KQ7C00000000000001MFHS32" }, - "attempts": { - "type": "integer", - "description": "Number of consecutive failed webhook attempts.", - "x-example": 10, - "format": "int32" + "clientSecret": { + "type": "string", + "description": "Kick OAuth2 client secret.", + "x-example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "url", - "events", - "tls", - "authUsername", - "authPassword", - "secret", "enabled", - "logs", - "attempts" + "clientId", + "clientSecret" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My Webhook", - "url": "https:\/\/example.com\/webhook", - "events": [ - "databases.tables.update", - "databases.collections.update" - ], - "tls": true, - "authUsername": "username", - "authPassword": "password", - "secret": "ad3d581ca230e2b7059c545e5a", - "enabled": true, - "logs": "Failed to connect to remote server.", - "attempts": 10 + "$id": "github", + "enabled": false, + "clientId": "01KQ7C00000000000001MFHS32", + "clientSecret": "34ac5600000000000000000000000000000000000000000000000000e830c8b" } }, - "key": { - "description": "Key", + "oAuth2Apple": { + "description": "OAuth2Apple", "type": "object", "properties": { "$id": { "type": "string", - "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "apple" }, - "$createdAt": { + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "serviceId": { "type": "string", - "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Apple OAuth2 service ID.", + "x-example": "ip.appwrite.app.web" }, - "$updatedAt": { + "keyId": { "type": "string", - "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Apple OAuth2 key ID.", + "x-example": "P4000000N8" }, - "name": { + "teamId": { "type": "string", - "description": "Key name.", - "x-example": "My API Key" + "description": "Apple OAuth2 team ID.", + "x-example": "D4000000R6" }, - "expire": { + "p8File": { "type": "string", - "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.", + "x-example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" + } + }, + "required": [ + "$id", + "enabled", + "serviceId", + "keyId", + "teamId", + "p8File" + ], + "example": { + "$id": "apple", + "enabled": false, + "serviceId": "ip.appwrite.app.web", + "keyId": "P4000000N8", + "teamId": "D4000000R6", + "p8File": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" + } + }, + "oAuth2Microsoft": { + "description": "OAuth2Microsoft", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "scopes": { - "type": "array", - "description": "Allowed permission scopes.", - "items": { - "type": "string" - }, - "x-example": "users.read" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "secret": { + "applicationId": { "type": "string", - "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "description": "Microsoft OAuth2 application ID.", + "x-example": "00001111-aaaa-2222-bbbb-3333cccc4444" }, - "accessedAt": { + "applicationSecret": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Microsoft OAuth2 application secret.", + "x-example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" }, - "sdks": { + "tenant": { + "type": "string", + "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID.", + "x-example": "common" + } + }, + "required": [ + "$id", + "enabled", + "applicationId", + "applicationSecret", + "tenant" + ], + "example": { + "$id": "github", + "enabled": false, + "applicationId": "00001111-aaaa-2222-bbbb-3333cccc4444", + "applicationSecret": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", + "tenant": "common" + } + }, + "oAuth2ProviderList": { + "description": "OAuth2 Providers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of OAuth2 providers in the given project.", + "x-example": 5, + "format": "int32" + }, + "providers": { "type": "array", - "description": "List of SDK user agents that used this key.", + "description": "List of OAuth2 providers.", "items": { - "type": "string" + "anyOf": [ + { + "$ref": "#\/components\/schemas\/oAuth2Github" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Discord" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Figma" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Dropbox" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Dailymotion" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Bitbucket" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Bitly" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Box" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Autodesk" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Google" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Zoom" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Zoho" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Yandex" + }, + { + "$ref": "#\/components\/schemas\/oAuth2X" + }, + { + "$ref": "#\/components\/schemas\/oAuth2WordPress" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Twitch" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Stripe" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Spotify" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Slack" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Podio" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Notion" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Salesforce" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Yahoo" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Linkedin" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Disqus" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Amazon" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Etsy" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Facebook" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Tradeshift" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Paypal" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Gitlab" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Authentik" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Auth0" + }, + { + "$ref": "#\/components\/schemas\/oAuth2FusionAuth" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Keycloak" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Oidc" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Apple" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Okta" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Kick" + }, + { + "$ref": "#\/components\/schemas\/oAuth2Microsoft" + } + ], + "discriminator": { + "propertyName": "$id", + "mapping": { + "github": "#\/components\/schemas\/oAuth2Github", + "discord": "#\/components\/schemas\/oAuth2Discord", + "figma": "#\/components\/schemas\/oAuth2Figma", + "dropbox": "#\/components\/schemas\/oAuth2Dropbox", + "dailymotion": "#\/components\/schemas\/oAuth2Dailymotion", + "bitbucket": "#\/components\/schemas\/oAuth2Bitbucket", + "bitly": "#\/components\/schemas\/oAuth2Bitly", + "box": "#\/components\/schemas\/oAuth2Box", + "autodesk": "#\/components\/schemas\/oAuth2Autodesk", + "google": "#\/components\/schemas\/oAuth2Google", + "zoom": "#\/components\/schemas\/oAuth2Zoom", + "zoho": "#\/components\/schemas\/oAuth2Zoho", + "yandex": "#\/components\/schemas\/oAuth2Yandex", + "x": "#\/components\/schemas\/oAuth2X", + "wordpress": "#\/components\/schemas\/oAuth2WordPress", + "twitch": "#\/components\/schemas\/oAuth2Twitch", + "stripe": "#\/components\/schemas\/oAuth2Stripe", + "spotify": "#\/components\/schemas\/oAuth2Spotify", + "slack": "#\/components\/schemas\/oAuth2Slack", + "podio": "#\/components\/schemas\/oAuth2Podio", + "notion": "#\/components\/schemas\/oAuth2Notion", + "salesforce": "#\/components\/schemas\/oAuth2Salesforce", + "yahoo": "#\/components\/schemas\/oAuth2Yahoo", + "linkedin": "#\/components\/schemas\/oAuth2Linkedin", + "disqus": "#\/components\/schemas\/oAuth2Disqus", + "amazon": "#\/components\/schemas\/oAuth2Amazon", + "etsy": "#\/components\/schemas\/oAuth2Etsy", + "facebook": "#\/components\/schemas\/oAuth2Facebook", + "tradeshift": "#\/components\/schemas\/oAuth2Tradeshift", + "tradeshiftBox": "#\/components\/schemas\/oAuth2Tradeshift", + "paypal": "#\/components\/schemas\/oAuth2Paypal", + "paypalSandbox": "#\/components\/schemas\/oAuth2Paypal", + "gitlab": "#\/components\/schemas\/oAuth2Gitlab", + "authentik": "#\/components\/schemas\/oAuth2Authentik", + "auth0": "#\/components\/schemas\/oAuth2Auth0", + "fusionauth": "#\/components\/schemas\/oAuth2FusionAuth", + "keycloak": "#\/components\/schemas\/oAuth2Keycloak", + "oidc": "#\/components\/schemas\/oAuth2Oidc", + "apple": "#\/components\/schemas\/oAuth2Apple", + "okta": "#\/components\/schemas\/oAuth2Okta", + "kick": "#\/components\/schemas\/oAuth2Kick", + "microsoft": "#\/components\/schemas\/oAuth2Microsoft" + } + } }, - "x-example": "appwrite:flutter" + "x-example": "" } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "name", - "expire", - "scopes", - "secret", - "accessedAt", - "sdks" + "total", + "providers" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My API Key", - "expire": "2020-10-15T06:38:00.000+00:00", - "scopes": "users.read", - "secret": "919c2d18fb5d4...a2ae413da83346ad2", - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "sdks": "appwrite:flutter" + "total": 5, + "providers": "" } }, - "devKey": { - "description": "DevKey", + "policyPasswordDictionary": { + "description": "Policy Password Dictionary", "type": "object", "properties": { "$id": { "type": "string", - "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "$createdAt": { + "enabled": { + "type": "boolean", + "description": "Whether password dictionary policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyPasswordHistory": { + "description": "Policy Password History", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "$updatedAt": { + "total": { + "type": "integer", + "description": "Password history length. A value of 0 means the policy is disabled.", + "x-example": 5, + "format": "int32" + } + }, + "required": [ + "$id", + "total" + ], + "example": { + "$id": "password-dictionary", + "total": 5 + } + }, + "policyPasswordPersonalData": { + "description": "Policy Password Personal Data", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "name": { + "enabled": { + "type": "boolean", + "description": "Whether password personal data policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionAlert": { + "description": "Policy Session Alert", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key name.", - "x-example": "Dev API Key" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "expire": { + "enabled": { + "type": "boolean", + "description": "Whether session alert policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionDuration": { + "description": "Policy Session Duration", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "secret": { + "duration": { + "type": "integer", + "description": "Session duration in seconds.", + "x-example": 3600, + "format": "int32" + } + }, + "required": [ + "$id", + "duration" + ], + "example": { + "$id": "password-dictionary", + "duration": 3600 + } + }, + "policySessionInvalidation": { + "description": "Policy Session Invalidation", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "accessedAt": { + "enabled": { + "type": "boolean", + "description": "Whether session invalidation policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionLimit": { + "description": "Policy Session Limit", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "sdks": { - "type": "array", - "description": "List of SDK user agents that used this key.", - "items": { - "type": "string" - }, - "x-example": "appwrite:flutter" + "total": { + "type": "integer", + "description": "Maximum number of sessions allowed per user. A value of 0 means the policy is disabled.", + "x-example": 10, + "format": "int32" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "expire", - "secret", - "accessedAt", - "sdks" + "total" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "Dev API Key", - "expire": "2020-10-15T06:38:00.000+00:00", - "secret": "919c2d18fb5d4...a2ae413da83346ad2", - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "sdks": "appwrite:flutter" + "$id": "password-dictionary", + "total": 10 } }, - "mockNumber": { - "description": "Mock Number", + "policyUserLimit": { + "description": "Policy User Limit", "type": "object", "properties": { - "phone": { + "$id": { "type": "string", - "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", - "x-example": "+1612842323" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "otp": { + "total": { + "type": "integer", + "description": "Maximum number of users allowed in the project. A value of 0 means the policy is disabled.", + "x-example": 100, + "format": "int32" + } + }, + "required": [ + "$id", + "total" + ], + "example": { + "$id": "password-dictionary", + "total": 100 + } + }, + "policyMembershipPrivacy": { + "description": "Policy Membership Privacy", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Mock OTP for the number. ", - "x-example": "123456" + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "userId": { + "type": "boolean", + "description": "Whether user ID is visible in memberships.", + "x-example": true + }, + "userEmail": { + "type": "boolean", + "description": "Whether user email is visible in memberships.", + "x-example": true + }, + "userPhone": { + "type": "boolean", + "description": "Whether user phone is visible in memberships.", + "x-example": true + }, + "userName": { + "type": "boolean", + "description": "Whether user name is visible in memberships.", + "x-example": true + }, + "userMFA": { + "type": "boolean", + "description": "Whether user MFA status is visible in memberships.", + "x-example": true } }, "required": [ - "phone", - "otp" + "$id", + "userId", + "userEmail", + "userPhone", + "userName", + "userMFA" ], "example": { - "phone": "+1612842323", - "otp": "123456" + "$id": "password-dictionary", + "userId": true, + "userEmail": true, + "userPhone": true, + "userName": true, + "userMFA": true } }, "authProvider": { @@ -61298,8 +68386,8 @@ }, "secret": { "type": "string", - "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.", - "x-example": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ" + "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.", + "x-example": "" }, "enabled": { "type": "boolean", @@ -61318,7 +68406,7 @@ "key": "github", "name": "GitHub", "appId": "259125845563242502", - "secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ", + "secret": "", "enabled": "" } }, @@ -63295,19 +70383,54 @@ "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", "x-example": "2020-10-15T06:38:00.000+00:00", "nullable": true + }, + "projectName": { + "type": "string", + "description": "Name of the project this block applies to.", + "x-example": "My Project" + }, + "region": { + "type": "string", + "description": "Region of the project this block applies to.", + "x-example": "fra" + }, + "organizationName": { + "type": "string", + "description": "Name of the organization that owns the project.", + "x-example": "Acme Inc." + }, + "organizationId": { + "type": "string", + "description": "ID of the organization that owns the project.", + "x-example": "5e5ea5c16897e" + }, + "billingPlan": { + "type": "string", + "description": "Billing plan of the organization that owns the project.", + "x-example": "pro" } }, "required": [ "$createdAt", "resourceType", - "resourceId" + "resourceId", + "projectName", + "region", + "organizationName", + "organizationId", + "billingPlan" ], "example": { "$createdAt": "2020-10-15T06:38:00.000+00:00", "resourceType": "project", "resourceId": "5e5ea5c16897e", "reason": "Payment overdue", - "expiredAt": "2020-10-15T06:38:00.000+00:00" + "expiredAt": "2020-10-15T06:38:00.000+00:00", + "projectName": "My Project", + "region": "fra", + "organizationName": "Acme Inc.", + "organizationId": "5e5ea5c16897e", + "billingPlan": "pro" } }, "backupPolicy": { diff --git a/specs/1.9.x/swagger2-1.9.x-client.json b/specs/1.9.x/swagger2-1.9.x-client.json index ea077b2c0..8925ed45b 100644 --- a/specs/1.9.x/swagger2-1.9.x-client.json +++ b/specs/1.9.x/swagger2-1.9.x-client.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.9.2", + "version": "1.9.3", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -630,7 +630,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 187, + "weight": 166, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -705,7 +705,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 189, + "weight": 168, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -829,7 +829,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 190, + "weight": 169, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -970,7 +970,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 191, + "weight": 170, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1094,7 +1094,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 195, + "weight": 174, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1231,7 +1231,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 196, + "weight": 175, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1371,7 +1371,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 188, + "weight": 167, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1472,7 +1472,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 194, + "weight": 173, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1573,7 +1573,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 192, + "weight": 171, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1674,7 +1674,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 193, + "weight": 172, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2669,7 +2669,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -2689,9 +2689,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -3626,7 +3629,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -3646,9 +3649,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -4223,7 +4229,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 198, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4349,7 +4355,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 197, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4481,7 +4487,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 201, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4545,7 +4551,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 199, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -5033,7 +5039,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 200, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -5117,7 +5123,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 203, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5209,7 +5215,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 202, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5301,7 +5307,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 204, + "weight": 183, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -6014,7 +6020,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 703, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6081,7 +6087,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 699, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6152,7 +6158,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 700, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6215,7 +6221,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 701, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6294,7 +6300,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 702, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6359,7 +6365,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 704, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6440,7 +6446,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 654, + "weight": 897, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6554,7 +6560,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 646, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6713,7 +6719,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 647, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6816,7 +6822,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 650, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6967,7 +6973,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 648, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -7077,7 +7083,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 652, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7178,7 +7184,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 657, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7301,7 +7307,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 656, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7422,7 +7428,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 810, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -7489,7 +7495,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 806, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -7560,7 +7566,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 807, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -7623,7 +7629,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 808, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -7702,7 +7708,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 809, + "weight": 861, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -7767,7 +7773,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 811, + "weight": 863, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -7847,7 +7853,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 803, + "weight": 898, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -7957,7 +7963,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 795, + "weight": 847, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -8132,7 +8138,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 796, + "weight": 848, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -8231,7 +8237,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 799, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -8372,7 +8378,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 797, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -8476,7 +8482,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 801, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -8572,7 +8578,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 805, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -8689,7 +8695,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 804, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -8804,14 +8810,17 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 453, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-executions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -8887,14 +8896,17 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 451, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/create-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "client", @@ -9006,14 +9018,17 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 452, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/get-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -9078,7 +9093,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 122, + "weight": 117, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -9153,7 +9168,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 121, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -9652,7 +9667,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 171, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -9737,7 +9752,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 175, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -9808,7 +9823,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 563, + "weight": 544, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -9901,7 +9916,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 1073, + "weight": 1186, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -9992,7 +10007,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 562, + "weight": 543, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -10063,7 +10078,7 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 564, + "weight": 545, "cookies": false, "type": "", "demo": "storage\/update-file.md", @@ -10154,7 +10169,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 565, + "weight": 546, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -10225,7 +10240,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 567, + "weight": 548, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -10305,7 +10320,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 566, + "weight": 547, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -10513,7 +10528,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 568, + "weight": 549, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -10593,7 +10608,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 776, + "weight": 828, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -10663,7 +10678,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 772, + "weight": 824, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -10737,7 +10752,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 773, + "weight": 825, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -10803,7 +10818,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 774, + "weight": 826, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -10885,7 +10900,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 775, + "weight": 827, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -10953,7 +10968,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 777, + "weight": 829, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -11037,7 +11052,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 768, + "weight": 899, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -11150,7 +11165,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 760, + "weight": 812, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -11304,7 +11319,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 761, + "weight": 813, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -11406,7 +11421,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 764, + "weight": 816, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -11552,7 +11567,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 762, + "weight": 814, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -11661,7 +11676,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 766, + "weight": 818, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -11761,7 +11776,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 771, + "weight": 823, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -11883,7 +11898,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 770, + "weight": 822, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -12003,7 +12018,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 539, + "weight": 520, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -12088,7 +12103,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 537, + "weight": 518, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -12179,7 +12194,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 538, + "weight": 519, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -12242,7 +12257,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 541, + "weight": 522, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -12318,7 +12333,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 540, + "weight": 521, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -12381,7 +12396,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 546, + "weight": 527, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -12474,7 +12489,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 544, + "weight": 525, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -12591,7 +12606,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 545, + "weight": 526, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -12662,7 +12677,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 547, + "weight": 528, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -12749,7 +12764,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 1074, + "weight": 1187, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -12822,7 +12837,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 549, + "weight": 530, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -12918,7 +12933,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 542, + "weight": 523, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -12981,7 +12996,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 543, + "weight": 524, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -13062,7 +13077,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 843, + "weight": 895, "cookies": false, "type": "", "demo": "vectorsdb\/list-transactions.md", @@ -13129,7 +13144,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 839, + "weight": 891, "cookies": false, "type": "", "demo": "vectorsdb\/create-transaction.md", @@ -13200,7 +13215,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 840, + "weight": 892, "cookies": false, "type": "", "demo": "vectorsdb\/get-transaction.md", @@ -13263,7 +13278,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 841, + "weight": 893, "cookies": false, "type": "", "demo": "vectorsdb\/update-transaction.md", @@ -13342,7 +13357,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 842, + "weight": 894, "cookies": false, "type": "", "demo": "vectorsdb\/delete-transaction.md", @@ -13407,7 +13422,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 844, + "weight": 896, "cookies": false, "type": "", "demo": "vectorsdb\/create-operations.md", @@ -13488,7 +13503,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 833, + "weight": 885, "cookies": false, "type": "", "demo": "vectorsdb\/list-documents.md", @@ -13598,7 +13613,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 829, + "weight": 881, "cookies": false, "type": "", "demo": "vectorsdb\/create-document.md", @@ -13746,7 +13761,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 832, + "weight": 884, "cookies": false, "type": "", "demo": "vectorsdb\/get-document.md", @@ -13845,7 +13860,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 831, + "weight": 883, "cookies": false, "type": "", "demo": "vectorsdb\/upsert-document.md", @@ -13986,7 +14001,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 830, + "weight": 882, "cookies": false, "type": "", "demo": "vectorsdb\/update-document.md", @@ -14090,7 +14105,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 834, + "weight": 886, "cookies": false, "type": "", "demo": "vectorsdb\/delete-document.md", diff --git a/specs/1.9.x/swagger2-1.9.x-console.json b/specs/1.9.x/swagger2-1.9.x-console.json index 7158b2350..e14bb6989 100644 --- a/specs/1.9.x/swagger2-1.9.x-console.json +++ b/specs/1.9.x/swagger2-1.9.x-console.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.9.2", + "version": "1.9.3", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -319,7 +319,7 @@ "x-appwrite": { "method": "listBillingAddresses", "group": null, - "weight": 1017, + "weight": 1075, "cookies": false, "type": "", "demo": "account\/list-billing-addresses.md", @@ -382,7 +382,7 @@ "x-appwrite": { "method": "createBillingAddress", "group": null, - "weight": 1015, + "weight": 1073, "cookies": false, "type": "", "demo": "account\/create-billing-address.md", @@ -483,7 +483,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 1016, + "weight": 1074, "cookies": false, "type": "", "demo": "account\/get-billing-address.md", @@ -542,7 +542,7 @@ "x-appwrite": { "method": "updateBillingAddress", "group": null, - "weight": 1018, + "weight": 1076, "cookies": false, "type": "", "demo": "account\/update-billing-address.md", @@ -648,7 +648,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 1019, + "weight": 1077, "cookies": false, "type": "", "demo": "account\/delete-billing-address.md", @@ -707,7 +707,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 1021, + "weight": 1079, "cookies": false, "type": "", "demo": "account\/get-coupon.md", @@ -983,7 +983,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 1020, + "weight": 1078, "cookies": false, "type": "", "demo": "account\/list-invoices.md", @@ -1118,7 +1118,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1003, + "weight": 1061, "cookies": false, "type": "", "demo": "account\/list-keys.md", @@ -1177,7 +1177,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1004, + "weight": 1062, "cookies": false, "type": "", "demo": "account\/create-key.md", @@ -1270,7 +1270,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1007, + "weight": 1065, "cookies": false, "type": "", "demo": "account\/get-key.md", @@ -1328,7 +1328,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1006, + "weight": 1064, "cookies": false, "type": "", "demo": "account\/update-key.md", @@ -1426,7 +1426,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1005, + "weight": 1063, "cookies": false, "type": "", "demo": "account\/delete-key.md", @@ -1561,7 +1561,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 187, + "weight": 166, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -1635,7 +1635,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 189, + "weight": 168, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -1758,7 +1758,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 190, + "weight": 169, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -1898,7 +1898,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 191, + "weight": 170, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -2021,7 +2021,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 195, + "weight": 174, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -2157,7 +2157,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 196, + "weight": 175, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -2296,7 +2296,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 188, + "weight": 167, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -2396,7 +2396,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 194, + "weight": 173, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -2496,7 +2496,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 192, + "weight": 171, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -2596,7 +2596,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 193, + "weight": 172, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -2851,7 +2851,7 @@ "x-appwrite": { "method": "listPaymentMethods", "group": null, - "weight": 1010, + "weight": 1068, "cookies": false, "type": "", "demo": "account\/list-payment-methods.md", @@ -2914,7 +2914,7 @@ "x-appwrite": { "method": "createPaymentMethod", "group": null, - "weight": 1008, + "weight": 1066, "cookies": false, "type": "", "demo": "account\/create-payment-method.md", @@ -2963,7 +2963,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 1009, + "weight": 1067, "cookies": false, "type": "", "demo": "account\/get-payment-method.md", @@ -3022,7 +3022,7 @@ "x-appwrite": { "method": "updatePaymentMethod", "group": null, - "weight": 1011, + "weight": 1069, "cookies": false, "type": "", "demo": "account\/update-payment-method.md", @@ -3111,7 +3111,7 @@ "x-appwrite": { "method": "deletePaymentMethod", "group": null, - "weight": 1014, + "weight": 1072, "cookies": false, "type": "", "demo": "account\/delete-payment-method.md", @@ -3172,7 +3172,7 @@ "x-appwrite": { "method": "updatePaymentMethodProvider", "group": null, - "weight": 1012, + "weight": 1070, "cookies": false, "type": "", "demo": "account\/update-payment-method-provider.md", @@ -3265,7 +3265,7 @@ "x-appwrite": { "method": "updatePaymentMethodMandateOptions", "group": null, - "weight": 1013, + "weight": 1071, "cookies": false, "type": "", "demo": "account\/update-payment-method-mandate-options.md", @@ -4050,7 +4050,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -4070,9 +4070,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -4995,7 +4998,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -5015,9 +5018,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -5587,7 +5593,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 1071, + "weight": 1184, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -5648,7 +5654,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 1072, + "weight": 1185, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -5709,7 +5715,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 198, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -5835,7 +5841,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 197, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -5967,7 +5973,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 201, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -6031,7 +6037,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 199, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -6519,7 +6525,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 200, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -6603,7 +6609,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 203, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -6695,7 +6701,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 202, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -6787,7 +6793,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 204, + "weight": 183, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -7500,7 +7506,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 997, + "weight": 1055, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -7565,7 +7571,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 998, + "weight": 1056, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -7656,7 +7662,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 996, + "weight": 1054, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -7714,7 +7720,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 999, + "weight": 1057, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -7775,7 +7781,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 992, + "weight": 1050, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -7840,7 +7846,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 993, + "weight": 1051, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -7965,7 +7971,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 991, + "weight": 1049, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -8026,7 +8032,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 994, + "weight": 1052, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -8121,7 +8127,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 995, + "weight": 1053, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -8184,7 +8190,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 1002, + "weight": 1060, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -8287,7 +8293,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 1001, + "weight": 1059, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -8352,7 +8358,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 1000, + "weight": 1058, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -8415,7 +8421,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 519, + "weight": 500, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -8484,7 +8490,7 @@ "x-appwrite": { "method": "getCampaign", "group": null, - "weight": 857, + "weight": 912, "cookies": false, "type": "", "demo": "console\/get-campaign.md", @@ -8543,7 +8549,7 @@ "x-appwrite": { "method": "getCoupon", "group": null, - "weight": 854, + "weight": 909, "cookies": false, "type": "", "demo": "console\/get-coupon.md", @@ -8578,6 +8584,54 @@ ] } }, + "\/console\/oauth2-providers": { + "get": { + "summary": "List OAuth2 providers", + "operationId": "consoleListOAuth2Providers", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "console" + ], + "description": "List all OAuth2 providers supported by the Appwrite server, along with the parameters required to configure each provider. The response excludes mock providers but includes sandbox providers.", + "responses": { + "200": { + "description": "Console OAuth2 Providers List", + "schema": { + "$ref": "#\/definitions\/consoleOAuth2ProviderList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listOAuth2Providers", + "group": "console", + "weight": 498, + "cookies": false, + "type": "", + "demo": "console\/list-o-auth-2-providers.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "public", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ] + } + }, "\/console\/plans": { "get": { "summary": "Get plans", @@ -8602,7 +8656,7 @@ "x-appwrite": { "method": "getPlans", "group": null, - "weight": 852, + "weight": 907, "cookies": false, "type": "", "demo": "console\/get-plans.md", @@ -8668,7 +8722,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 853, + "weight": 908, "cookies": false, "type": "", "demo": "console\/get-plan.md", @@ -8727,7 +8781,7 @@ "x-appwrite": { "method": "getProgram", "group": null, - "weight": 855, + "weight": 910, "cookies": false, "type": "", "demo": "console\/get-program.md", @@ -8788,7 +8842,7 @@ "x-appwrite": { "method": "createProgramMembership", "group": null, - "weight": 856, + "weight": 911, "cookies": false, "type": "", "demo": "console\/create-program-membership.md", @@ -8847,7 +8901,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 851, + "weight": 906, "cookies": false, "type": "", "demo": "console\/list-regions.md", @@ -8891,7 +8945,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 520, + "weight": 501, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -8938,6 +8992,54 @@ ] } }, + "\/console\/scopes\/project": { + "get": { + "summary": "List project scopes", + "operationId": "consoleListProjectScopes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "console" + ], + "description": "List all scopes available for project API keys, along with a description for each scope.", + "responses": { + "200": { + "description": "Console Key Scopes List", + "schema": { + "$ref": "#\/definitions\/consoleKeyScopeList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listProjectScopes", + "group": "console", + "weight": 499, + "cookies": false, + "type": "", + "demo": "console\/list-project-scopes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "public", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ] + } + }, "\/console\/sources": { "post": { "summary": "Create source", @@ -8964,7 +9066,7 @@ "x-appwrite": { "method": "createSource", "group": null, - "weight": 858, + "weight": 913, "cookies": false, "type": "", "demo": "console\/create-source.md", @@ -9060,7 +9162,7 @@ "x-appwrite": { "method": "suggestColumns", "group": null, - "weight": 859, + "weight": 914, "cookies": false, "type": "", "demo": "console\/suggest-columns.md", @@ -9155,7 +9257,7 @@ "x-appwrite": { "method": "suggestIndexes", "group": null, - "weight": 860, + "weight": 915, "cookies": false, "type": "", "demo": "console\/suggest-indexes.md", @@ -9242,7 +9344,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 518, + "weight": 497, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -9255,7 +9357,6 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md", "auth": { "Project": [] } @@ -9291,7 +9392,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 635, + "weight": 687, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -9407,7 +9508,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 631, + "weight": 683, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -9527,7 +9628,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 703, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -9594,7 +9695,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 699, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -9665,7 +9766,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 700, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -9728,7 +9829,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 701, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -9807,7 +9908,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 702, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -9872,7 +9973,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 704, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -9953,7 +10054,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 638, + "weight": 690, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -10055,7 +10156,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 632, + "weight": 684, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -10149,7 +10250,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 633, + "weight": 685, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -10261,7 +10362,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 634, + "weight": 686, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -10354,7 +10455,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 643, + "weight": 695, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -10449,7 +10550,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 639, + "weight": 691, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -10579,7 +10680,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 640, + "weight": 692, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -10652,7 +10753,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 641, + "weight": 693, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -10763,7 +10864,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 642, + "weight": 694, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -10836,7 +10937,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 660, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -10932,7 +11033,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 661, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -11045,7 +11146,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 662, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -11160,7 +11261,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 663, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -11274,7 +11375,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 664, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -11390,7 +11491,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 665, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -11504,7 +11605,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 666, + "weight": 718, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -11620,7 +11721,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 667, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -11743,7 +11844,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 668, + "weight": 720, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -11868,7 +11969,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 669, + "weight": 721, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -11998,7 +12099,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 670, + "weight": 722, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -12130,7 +12231,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 671, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -12260,7 +12361,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 672, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -12392,7 +12493,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 673, + "weight": 725, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -12505,7 +12606,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 674, + "weight": 726, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -12620,7 +12721,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 675, + "weight": 727, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -12727,7 +12828,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 676, + "weight": 728, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -12841,7 +12942,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 693, + "weight": 745, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -12956,7 +13057,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 694, + "weight": 746, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -13067,7 +13168,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 691, + "weight": 743, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -13182,7 +13283,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 692, + "weight": 744, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -13293,7 +13394,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 677, + "weight": 729, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -13400,7 +13501,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 678, + "weight": 730, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -13514,7 +13615,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 679, + "weight": 731, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -13621,7 +13722,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 680, + "weight": 732, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -13735,7 +13836,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 681, + "weight": 733, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -13876,7 +13977,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 682, + "weight": 734, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -13987,7 +14088,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 683, + "weight": 735, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -14114,7 +14215,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 684, + "weight": 736, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -14237,7 +14338,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 689, + "weight": 741, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -14352,7 +14453,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 690, + "weight": 742, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -14463,7 +14564,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 685, + "weight": 737, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -14577,7 +14678,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 686, + "weight": 738, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -14693,7 +14794,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 687, + "weight": 739, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -14816,7 +14917,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 688, + "weight": 740, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -15015,7 +15116,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 658, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -15090,7 +15191,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 659, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -15170,7 +15271,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 654, + "weight": 897, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -15284,7 +15385,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 646, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -15475,7 +15576,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 651, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -15610,7 +15711,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 649, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -15714,7 +15815,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 653, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -15812,7 +15913,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 647, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -15915,7 +16016,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 650, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -16066,7 +16167,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 648, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -16176,7 +16277,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 652, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -16275,7 +16376,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 655, + "weight": 707, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -16368,7 +16469,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 657, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -16491,7 +16592,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 656, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -16612,7 +16713,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 698, + "weight": 750, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -16706,7 +16807,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 695, + "weight": 747, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -16846,7 +16947,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 696, + "weight": 748, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -16921,7 +17022,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 697, + "weight": 749, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -17001,7 +17102,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 644, + "weight": 696, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -17084,7 +17185,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 645, + "weight": 697, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -17175,7 +17276,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 636, + "weight": 688, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -17280,7 +17381,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 637, + "weight": 689, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -17393,7 +17494,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 782, + "weight": 834, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -17476,7 +17577,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 778, + "weight": 830, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -17560,7 +17661,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 810, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -17627,7 +17728,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 806, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -17698,7 +17799,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 807, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -17761,7 +17862,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 808, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -17840,7 +17941,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 809, + "weight": 861, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -17903,7 +18004,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 784, + "weight": 836, "cookies": false, "type": "", "demo": "documentsdb\/list-usage.md", @@ -17997,7 +18098,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 779, + "weight": 831, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -18058,7 +18159,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 780, + "weight": 832, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -18138,7 +18239,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 781, + "weight": 833, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -18199,7 +18300,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 789, + "weight": 841, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -18290,7 +18391,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 785, + "weight": 837, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -18416,7 +18517,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 786, + "weight": 838, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -18485,7 +18586,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 787, + "weight": 839, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -18594,7 +18695,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 788, + "weight": 840, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -18663,7 +18764,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 803, + "weight": 898, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -18773,7 +18874,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 795, + "weight": 847, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -18948,7 +19049,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 800, + "weight": 852, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -19074,7 +19175,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 798, + "weight": 850, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -19173,7 +19274,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 802, + "weight": 854, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -19266,7 +19367,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 796, + "weight": 848, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -19365,7 +19466,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 799, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -19506,7 +19607,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 797, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -19610,7 +19711,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 801, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -19706,7 +19807,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 805, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -19823,7 +19924,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 804, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -19938,7 +20039,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 794, + "weight": 846, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -20028,7 +20129,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 791, + "weight": 843, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -20163,7 +20264,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 792, + "weight": 844, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -20234,7 +20335,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 793, + "weight": 845, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -20310,7 +20411,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 790, + "weight": 842, "cookies": false, "type": "", "demo": "documentsdb\/get-collection-usage.md", @@ -20397,7 +20498,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 783, + "weight": 835, "cookies": false, "type": "", "demo": "documentsdb\/get-usage.md", @@ -20502,7 +20603,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 866, + "weight": 921, "cookies": false, "type": "", "demo": "domains\/list.md", @@ -20573,7 +20674,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 861, + "weight": 916, "cookies": false, "type": "", "demo": "domains\/create.md", @@ -20648,7 +20749,7 @@ "x-appwrite": { "method": "getPrice", "group": null, - "weight": 864, + "weight": 919, "cookies": false, "type": "", "demo": "domains\/get-price.md", @@ -20733,7 +20834,7 @@ "x-appwrite": { "method": "createPurchase", "group": null, - "weight": 911, + "weight": 966, "cookies": false, "type": "", "demo": "domains\/create-purchase.md", @@ -20853,7 +20954,7 @@ ] } }, - "\/domains\/purchases\/{domainId}": { + "\/domains\/purchases\/{invoiceId}": { "patch": { "summary": "Confirm a domain purchase", "operationId": "domainsUpdatePurchase", @@ -20879,7 +20980,7 @@ "x-appwrite": { "method": "updatePurchase", "group": null, - "weight": 912, + "weight": 967, "cookies": false, "type": "", "demo": "domains\/update-purchase.md", @@ -20903,11 +21004,11 @@ ], "parameters": [ { - "name": "domainId", - "description": "Domain ID to confirm purchase for.", + "name": "invoiceId", + "description": "Invoice ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -20955,7 +21056,7 @@ "x-appwrite": { "method": "listSuggestions", "group": null, - "weight": 910, + "weight": 965, "cookies": false, "type": "", "demo": "domains\/list-suggestions.md", @@ -21065,7 +21166,7 @@ "x-appwrite": { "method": "createTransferIn", "group": null, - "weight": 871, + "weight": 926, "cookies": false, "type": "", "demo": "domains\/create-transfer-in.md", @@ -21136,7 +21237,7 @@ ] } }, - "\/domains\/transfers\/in\/{domainId}": { + "\/domains\/transfers\/in\/{invoiceId}": { "patch": { "summary": "Confirm a domain transfer in", "operationId": "domainsUpdateTransferIn", @@ -21162,7 +21263,7 @@ "x-appwrite": { "method": "updateTransferIn", "group": null, - "weight": 872, + "weight": 927, "cookies": false, "type": "", "demo": "domains\/update-transfer-in.md", @@ -21186,11 +21287,11 @@ ], "parameters": [ { - "name": "domainId", - "description": "Domain ID to confirm transfer for.", + "name": "invoiceId", + "description": "Invoice ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -21240,7 +21341,7 @@ "x-appwrite": { "method": "createTransferOut", "group": null, - "weight": 873, + "weight": 928, "cookies": false, "type": "", "demo": "domains\/create-transfer-out.md", @@ -21315,7 +21416,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 863, + "weight": 918, "cookies": false, "type": "", "demo": "domains\/get.md", @@ -21370,7 +21471,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 862, + "weight": 917, "cookies": false, "type": "", "demo": "domains\/delete.md", @@ -21430,7 +21531,7 @@ "x-appwrite": { "method": "updateAutoRenewal", "group": null, - "weight": 867, + "weight": 922, "cookies": false, "type": "", "demo": "domains\/update-auto-renewal.md", @@ -21508,7 +21609,7 @@ "x-appwrite": { "method": "updateNameservers", "group": null, - "weight": 868, + "weight": 923, "cookies": false, "type": "", "demo": "domains\/update-nameservers.md", @@ -21566,7 +21667,7 @@ "x-appwrite": { "method": "getPresetGoogleWorkspace", "group": null, - "weight": 899, + "weight": 954, "cookies": false, "type": "", "demo": "domains\/get-preset-google-workspace.md", @@ -21624,7 +21725,7 @@ "x-appwrite": { "method": "createPresetGoogleWorkspace", "group": null, - "weight": 898, + "weight": 953, "cookies": false, "type": "", "demo": "domains\/create-preset-google-workspace.md", @@ -21682,7 +21783,7 @@ "x-appwrite": { "method": "getPresetICloud", "group": null, - "weight": 909, + "weight": 964, "cookies": false, "type": "", "demo": "domains\/get-preset-i-cloud.md", @@ -21740,7 +21841,7 @@ "x-appwrite": { "method": "createPresetICloud", "group": null, - "weight": 908, + "weight": 963, "cookies": false, "type": "", "demo": "domains\/create-preset-i-cloud.md", @@ -21798,7 +21899,7 @@ "x-appwrite": { "method": "getPresetMailgun", "group": null, - "weight": 901, + "weight": 956, "cookies": false, "type": "", "demo": "domains\/get-preset-mailgun.md", @@ -21856,7 +21957,7 @@ "x-appwrite": { "method": "createPresetMailgun", "group": null, - "weight": 900, + "weight": 955, "cookies": false, "type": "", "demo": "domains\/create-preset-mailgun.md", @@ -21914,7 +22015,7 @@ "x-appwrite": { "method": "getPresetOutlook", "group": null, - "weight": 907, + "weight": 962, "cookies": false, "type": "", "demo": "domains\/get-preset-outlook.md", @@ -21972,7 +22073,7 @@ "x-appwrite": { "method": "createPresetOutlook", "group": null, - "weight": 906, + "weight": 961, "cookies": false, "type": "", "demo": "domains\/create-preset-outlook.md", @@ -22030,7 +22131,7 @@ "x-appwrite": { "method": "getPresetProtonMail", "group": null, - "weight": 905, + "weight": 960, "cookies": false, "type": "", "demo": "domains\/get-preset-proton-mail.md", @@ -22088,7 +22189,7 @@ "x-appwrite": { "method": "createPresetProtonMail", "group": null, - "weight": 904, + "weight": 959, "cookies": false, "type": "", "demo": "domains\/create-preset-proton-mail.md", @@ -22146,7 +22247,7 @@ "x-appwrite": { "method": "getPresetZoho", "group": null, - "weight": 903, + "weight": 958, "cookies": false, "type": "", "demo": "domains\/get-preset-zoho.md", @@ -22204,7 +22305,7 @@ "x-appwrite": { "method": "createPresetZoho", "group": null, - "weight": 902, + "weight": 957, "cookies": false, "type": "", "demo": "domains\/create-preset-zoho.md", @@ -22262,7 +22363,7 @@ "x-appwrite": { "method": "listRecords", "group": null, - "weight": 897, + "weight": 952, "cookies": false, "type": "", "demo": "domains\/list-records.md", @@ -22334,7 +22435,7 @@ "x-appwrite": { "method": "createRecordA", "group": null, - "weight": 875, + "weight": 930, "cookies": false, "type": "", "demo": "domains\/create-record-a.md", @@ -22433,7 +22534,7 @@ "x-appwrite": { "method": "updateRecordA", "group": null, - "weight": 876, + "weight": 931, "cookies": false, "type": "", "demo": "domains\/update-record-a.md", @@ -22540,7 +22641,7 @@ "x-appwrite": { "method": "createRecordAAAA", "group": null, - "weight": 877, + "weight": 932, "cookies": false, "type": "", "demo": "domains\/create-record-aaaa.md", @@ -22639,7 +22740,7 @@ "x-appwrite": { "method": "updateRecordAAAA", "group": null, - "weight": 878, + "weight": 933, "cookies": false, "type": "", "demo": "domains\/update-record-aaaa.md", @@ -22746,7 +22847,7 @@ "x-appwrite": { "method": "createRecordAlias", "group": null, - "weight": 879, + "weight": 934, "cookies": false, "type": "", "demo": "domains\/create-record-alias.md", @@ -22845,7 +22946,7 @@ "x-appwrite": { "method": "updateRecordAlias", "group": null, - "weight": 880, + "weight": 935, "cookies": false, "type": "", "demo": "domains\/update-record-alias.md", @@ -22952,7 +23053,7 @@ "x-appwrite": { "method": "createRecordCAA", "group": null, - "weight": 881, + "weight": 936, "cookies": false, "type": "", "demo": "domains\/create-record-caa.md", @@ -23051,7 +23152,7 @@ "x-appwrite": { "method": "updateRecordCAA", "group": null, - "weight": 882, + "weight": 937, "cookies": false, "type": "", "demo": "domains\/update-record-caa.md", @@ -23158,7 +23259,7 @@ "x-appwrite": { "method": "createRecordCNAME", "group": null, - "weight": 883, + "weight": 938, "cookies": false, "type": "", "demo": "domains\/create-record-cname.md", @@ -23257,7 +23358,7 @@ "x-appwrite": { "method": "updateRecordCNAME", "group": null, - "weight": 884, + "weight": 939, "cookies": false, "type": "", "demo": "domains\/update-record-cname.md", @@ -23364,7 +23465,7 @@ "x-appwrite": { "method": "createRecordHTTPS", "group": null, - "weight": 885, + "weight": 940, "cookies": false, "type": "", "demo": "domains\/create-record-https.md", @@ -23463,7 +23564,7 @@ "x-appwrite": { "method": "updateRecordHTTPS", "group": null, - "weight": 886, + "weight": 941, "cookies": false, "type": "", "demo": "domains\/update-record-https.md", @@ -23570,7 +23671,7 @@ "x-appwrite": { "method": "createRecordMX", "group": null, - "weight": 887, + "weight": 942, "cookies": false, "type": "", "demo": "domains\/create-record-mx.md", @@ -23677,7 +23778,7 @@ "x-appwrite": { "method": "updateRecordMX", "group": null, - "weight": 888, + "weight": 943, "cookies": false, "type": "", "demo": "domains\/update-record-mx.md", @@ -23792,7 +23893,7 @@ "x-appwrite": { "method": "createRecordNS", "group": null, - "weight": 889, + "weight": 944, "cookies": false, "type": "", "demo": "domains\/create-record-ns.md", @@ -23891,7 +23992,7 @@ "x-appwrite": { "method": "updateRecordNS", "group": null, - "weight": 890, + "weight": 945, "cookies": false, "type": "", "demo": "domains\/update-record-ns.md", @@ -23998,7 +24099,7 @@ "x-appwrite": { "method": "createRecordSRV", "group": null, - "weight": 891, + "weight": 946, "cookies": false, "type": "", "demo": "domains\/create-record-srv.md", @@ -24121,7 +24222,7 @@ "x-appwrite": { "method": "updateRecordSRV", "group": null, - "weight": 892, + "weight": 947, "cookies": false, "type": "", "demo": "domains\/update-record-srv.md", @@ -24252,7 +24353,7 @@ "x-appwrite": { "method": "createRecordTXT", "group": null, - "weight": 893, + "weight": 948, "cookies": false, "type": "", "demo": "domains\/create-record-txt.md", @@ -24350,7 +24451,7 @@ "x-appwrite": { "method": "updateRecordTXT", "group": null, - "weight": 894, + "weight": 949, "cookies": false, "type": "", "demo": "domains\/update-record-txt.md", @@ -24455,7 +24556,7 @@ "x-appwrite": { "method": "getRecord", "group": null, - "weight": 896, + "weight": 951, "cookies": false, "type": "", "demo": "domains\/get-record.md", @@ -24518,7 +24619,7 @@ "x-appwrite": { "method": "deleteRecord", "group": null, - "weight": 895, + "weight": 950, "cookies": false, "type": "", "demo": "domains\/delete-record.md", @@ -24586,7 +24687,7 @@ "x-appwrite": { "method": "updateTeam", "group": null, - "weight": 870, + "weight": 925, "cookies": false, "type": "", "demo": "domains\/update-team.md", @@ -24662,7 +24763,7 @@ "x-appwrite": { "method": "getTransferStatus", "group": null, - "weight": 874, + "weight": 929, "cookies": false, "type": "", "demo": "domains\/get-transfer-status.md", @@ -24720,7 +24821,7 @@ "x-appwrite": { "method": "getZone", "group": null, - "weight": 865, + "weight": 920, "cookies": false, "type": "", "demo": "domains\/get-zone.md", @@ -24778,7 +24879,7 @@ "x-appwrite": { "method": "updateZone", "group": null, - "weight": 869, + "weight": 924, "cookies": false, "type": "", "demo": "domains\/update-zone.md", @@ -24854,7 +24955,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 437, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -24936,7 +25037,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 845, + "weight": 900, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -25068,6 +25169,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -25143,75 +25245,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -25308,7 +25417,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 439, + "weight": 418, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -25358,7 +25467,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 440, + "weight": 419, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -25408,7 +25517,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 463, + "weight": 442, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -25523,6 +25632,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -25617,7 +25727,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 462, + "weight": 441, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -25675,7 +25785,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 456, + "weight": 435, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -25745,7 +25855,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 435, + "weight": 414, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -25805,7 +25915,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 846, + "weight": 901, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -25939,6 +26049,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -26014,75 +26125,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -26173,7 +26291,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 438, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -26235,7 +26353,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 443, + "weight": 422, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -26313,7 +26431,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 444, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -26403,7 +26521,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 441, + "weight": 420, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -26496,7 +26614,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 449, + "weight": 428, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -26582,7 +26700,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 446, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -26703,7 +26821,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 447, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -26800,7 +26918,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 442, + "weight": 421, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -26863,7 +26981,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 445, + "weight": 424, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -26931,7 +27049,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 448, + "weight": 427, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -27017,7 +27135,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 450, + "weight": 429, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -27085,14 +27203,17 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 453, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-executions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -27168,14 +27289,17 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 451, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/create-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "client", @@ -27287,14 +27411,17 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 452, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/get-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -27352,14 +27479,17 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 454, + "weight": 433, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "server" @@ -27420,7 +27550,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 455, + "weight": 434, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -27498,7 +27628,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 459, + "weight": 438, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -27558,7 +27688,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 847, + "weight": 902, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -27649,7 +27779,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 458, + "weight": 437, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -27717,7 +27847,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 460, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -27812,7 +27942,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 461, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -27882,7 +28012,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 122, + "weight": 117, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -27957,7 +28087,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 121, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -28030,7 +28160,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 464, + "weight": 443, "cookies": false, "type": "", "demo": "health\/get.md", @@ -28081,7 +28211,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 473, + "weight": 452, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -28132,7 +28262,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 467, + "weight": 446, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -28183,7 +28313,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 470, + "weight": 449, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -28243,7 +28373,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 985, + "weight": 1043, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -28314,7 +28444,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 466, + "weight": 445, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -28365,7 +28495,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 468, + "weight": 447, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -28416,7 +28546,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 474, + "weight": 453, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -28478,7 +28608,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 981, + "weight": 1039, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -28540,7 +28670,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 980, + "weight": 1038, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -28602,7 +28732,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 478, + "weight": 457, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -28664,7 +28794,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 982, + "weight": 1040, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -28726,7 +28856,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 477, + "weight": 456, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -28788,7 +28918,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 479, + "weight": 458, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -28859,7 +28989,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 480, + "weight": 459, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -28921,7 +29051,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 487, + "weight": 466, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -29008,7 +29138,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 484, + "weight": 463, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -29070,7 +29200,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 476, + "weight": 455, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -29132,7 +29262,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 481, + "weight": 460, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -29194,7 +29324,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 482, + "weight": 461, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -29256,7 +29386,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 483, + "weight": 462, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -29318,7 +29448,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 983, + "weight": 1041, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -29380,7 +29510,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 485, + "weight": 464, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -29442,7 +29572,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 486, + "weight": 465, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -29504,7 +29634,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 984, + "weight": 1042, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -29566,7 +29696,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 475, + "weight": 454, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -29628,7 +29758,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 472, + "weight": 451, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -29679,7 +29809,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 471, + "weight": 450, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -29730,7 +29860,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 469, + "weight": 448, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -30181,6 +30311,323 @@ ] } }, + "\/manager\/blocks": { + "post": { + "summary": "Create a new resource block for a project", + "operationId": "managerCreateBlock", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "manager" + ], + "description": "Creates a new resource block.", + "responses": { + "201": { + "description": "Block", + "schema": { + "$ref": "#\/definitions\/block" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createBlock", + "group": null, + "weight": 974, + "cookies": false, + "type": "", + "demo": "manager\/create-block.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "", + "platforms": [ + "console" + ], + "packaging": false, + "public": true + }, + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "projectId": { + "type": "string", + "description": "Project ID", + "default": null, + "x-example": "" + }, + "resourceType": { + "type": "string", + "description": "Resource type to block (e.g., projects, functions, databases, storage, etc.)", + "default": null, + "x-example": "projects", + "enum": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "resourceId": { + "type": "string", + "description": "Optional resource ID (if omitted, all resources of this type will be blocked)", + "default": "", + "x-example": "" + }, + "reason": { + "type": "string", + "description": "Optional reason why the resource is blocked", + "default": "", + "x-example": "" + }, + "expiredAt": { + "type": "string", + "description": "Optional expiration date for the block", + "default": "", + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" + } + }, + "required": [ + "projectId", + "resourceType" + ] + } + } + ] + }, + "delete": { + "summary": "Delete resource blocks for a project", + "operationId": "managerDeleteBlock", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "manager" + ], + "description": "Deletes resource blocks for a project.", + "responses": { + "200": { + "description": "BlockDelete", + "schema": { + "$ref": "#\/definitions\/blockDelete" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteBlock", + "group": null, + "weight": 976, + "cookies": false, + "type": "", + "demo": "manager\/delete-block.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "", + "platforms": [ + "console" + ], + "packaging": false, + "public": true + }, + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "projectId": { + "type": "string", + "description": "Project ID", + "default": null, + "x-example": "" + }, + "resourceType": { + "type": "string", + "description": "Resource type to unblock", + "default": null, + "x-example": "projects", + "enum": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "resourceId": { + "type": "string", + "description": "Optional resource ID (if omitted, all blocks of this type will be removed)", + "default": "", + "x-example": "" + } + }, + "required": [ + "projectId", + "resourceType" + ] + } + } + ] + } + }, + "\/manager\/blocks\/{projectId}": { + "get": { + "summary": "List all resource blocks for a project", + "operationId": "managerListBlocks", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "manager" + ], + "description": "Lists all resource blocks for a project.", + "responses": { + "200": { + "description": "Blocks list", + "schema": { + "$ref": "#\/definitions\/blockList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listBlocks", + "group": null, + "weight": 975, + "cookies": false, + "type": "", + "demo": "manager\/list-blocks.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "", + "platforms": [ + "console" + ], + "packaging": false, + "public": true + }, + "parameters": [ + { + "name": "projectId", + "description": "Project ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/manager\/users\/status": { + "patch": { + "summary": "Update a user status by ID or email", + "operationId": "managerUpdateUserStatus", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "manager" + ], + "description": "Updates a console user status using a user ID or email address.", + "responses": { + "200": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateUserStatus", + "group": "users", + "weight": 977, + "cookies": false, + "type": "", + "demo": "manager\/update-user-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "", + "platforms": [ + "console" + ], + "packaging": false, + "public": true + }, + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID.", + "default": "", + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email address.", + "default": "", + "x-example": "" + }, + "status": { + "type": "boolean", + "description": "User status. Set to `false` to block and `true` to unblock.", + "default": null, + "x-example": false + }, + "reason": { + "type": "string", + "description": "Optional reason when blocking a user. Accepted for parity with the CLI task but not persisted.", + "default": "", + "x-example": "" + } + }, + "required": [ + "status" + ] + } + } + ] + } + }, "\/messaging\/messages": { "get": { "summary": "List messages", @@ -30205,7 +30652,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 179, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -30290,7 +30737,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 176, + "weight": 155, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -30451,7 +30898,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 183, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -30619,7 +31066,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 178, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -30819,7 +31266,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 185, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -31034,7 +31481,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 177, + "weight": 156, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -31225,7 +31672,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 184, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -31415,7 +31862,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 182, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -31471,7 +31918,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 186, + "weight": 165, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -31532,7 +31979,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 180, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -31614,7 +32061,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 181, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -31696,7 +32143,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 150, + "weight": 129, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -31781,7 +32228,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 149, + "weight": 128, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -31970,7 +32417,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 163, + "weight": 142, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -32156,7 +32603,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 148, + "weight": 127, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -32314,7 +32761,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 162, + "weight": 141, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -32468,7 +32915,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 139, + "weight": 118, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -32600,7 +33047,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 153, + "weight": 132, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -32729,7 +33176,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 143, + "weight": 122, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -32834,7 +33281,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 157, + "weight": 136, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -32937,7 +33384,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 141, + "weight": 120, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -33056,7 +33503,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 155, + "weight": 134, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -33172,7 +33619,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 140, + "weight": 119, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -33291,7 +33738,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 154, + "weight": 133, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -33407,7 +33854,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 142, + "weight": 121, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -33657,7 +34104,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 156, + "weight": 135, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -33901,7 +34348,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 144, + "weight": 123, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -34007,7 +34454,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 158, + "weight": 137, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -34110,7 +34557,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 145, + "weight": 124, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -34216,7 +34663,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 159, + "weight": 138, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -34319,7 +34766,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 146, + "weight": 125, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -34425,7 +34872,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 160, + "weight": 139, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -34528,7 +34975,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 147, + "weight": 126, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -34634,7 +35081,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 161, + "weight": 140, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -34735,7 +35182,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 152, + "weight": 131, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -34791,7 +35238,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 164, + "weight": 143, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -34852,7 +35299,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 151, + "weight": 130, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -34934,7 +35381,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 173, + "weight": 152, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -35016,7 +35463,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 166, + "weight": 145, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -35099,7 +35546,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 165, + "weight": 144, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -35188,7 +35635,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 168, + "weight": 147, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -35249,7 +35696,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 169, + "weight": 148, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -35331,7 +35778,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 170, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -35392,7 +35839,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 167, + "weight": 146, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -35474,7 +35921,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 172, + "weight": 151, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -35565,7 +36012,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 171, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -35653,7 +36100,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 174, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -35717,7 +36164,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 175, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -35788,7 +36235,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 131, + "weight": 572, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -35871,7 +36318,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 123, + "weight": 576, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -35933,7 +36380,8 @@ "message", "site", "site-deployment", - "site-variable" + "site-variable", + "backup-policy" ], "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [] @@ -35994,7 +36442,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 133, + "weight": 577, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -36051,7 +36499,8 @@ "message", "site", "site-deployment", - "site-variable" + "site-variable", + "backup-policy" ], "x-enum-name": "AppwriteMigrationResource", "x-enum-keys": [] @@ -36112,7 +36561,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 128, + "weight": 585, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -36238,7 +36687,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 127, + "weight": 584, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -36329,7 +36778,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 124, + "weight": 578, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -36422,7 +36871,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 134, + "weight": 579, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -36508,7 +36957,7 @@ "x-appwrite": { "method": "createJSONExport", "group": null, - "weight": 130, + "weight": 587, "cookies": false, "type": "", "demo": "migrations\/create-json-export.md", @@ -36610,7 +37059,7 @@ "x-appwrite": { "method": "createJSONImport", "group": null, - "weight": 129, + "weight": 586, "cookies": false, "type": "", "demo": "migrations\/create-json-import.md", @@ -36701,7 +37150,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 126, + "weight": 582, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -36837,7 +37286,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 136, + "weight": 583, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -36973,7 +37422,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 125, + "weight": 580, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -37103,7 +37552,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 135, + "weight": 581, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -37230,7 +37679,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 132, + "weight": 573, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -37289,7 +37738,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 137, + "weight": 574, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -37343,7 +37792,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 138, + "weight": 575, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -37402,7 +37851,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 932, + "weight": 989, "cookies": false, "type": "", "demo": "organizations\/list.md", @@ -37481,7 +37930,7 @@ "x-appwrite": { "method": "create", "group": null, - "weight": 931, + "weight": 988, "cookies": false, "type": "", "demo": "organizations\/create.md", @@ -37623,7 +38072,7 @@ "x-appwrite": { "method": "estimationCreateOrganization", "group": null, - "weight": 965, + "weight": 1023, "cookies": false, "type": "", "demo": "organizations\/estimation-create-organization.md", @@ -37726,7 +38175,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 933, + "weight": 990, "cookies": false, "type": "", "demo": "organizations\/delete.md", @@ -37785,7 +38234,7 @@ "x-appwrite": { "method": "listAddons", "group": null, - "weight": 973, + "weight": 1031, "cookies": false, "type": "", "demo": "organizations\/list-addons.md", @@ -37846,7 +38295,7 @@ "x-appwrite": { "method": "createBaaAddon", "group": null, - "weight": 976, + "weight": 1034, "cookies": false, "type": "", "demo": "organizations\/create-baa-addon.md", @@ -37905,7 +38354,7 @@ "x-appwrite": { "method": "getAddon", "group": null, - "weight": 974, + "weight": 1032, "cookies": false, "type": "", "demo": "organizations\/get-addon.md", @@ -37969,7 +38418,7 @@ "x-appwrite": { "method": "deleteAddon", "group": null, - "weight": 977, + "weight": 1035, "cookies": false, "type": "", "demo": "organizations\/delete-addon.md", @@ -38038,7 +38487,7 @@ "x-appwrite": { "method": "confirmAddonPayment", "group": null, - "weight": 978, + "weight": 1036, "cookies": false, "type": "", "demo": "organizations\/confirm-addon-payment.md", @@ -38105,7 +38554,7 @@ "x-appwrite": { "method": "getAddonPrice", "group": null, - "weight": 975, + "weight": 1033, "cookies": false, "type": "", "demo": "organizations\/get-addon-price.md", @@ -38177,7 +38626,7 @@ "x-appwrite": { "method": "listAggregations", "group": null, - "weight": 948, + "weight": 1005, "cookies": false, "type": "", "demo": "organizations\/list-aggregations.md", @@ -38248,7 +38697,7 @@ "x-appwrite": { "method": "getAggregation", "group": null, - "weight": 949, + "weight": 1006, "cookies": false, "type": "", "demo": "organizations\/get-aggregation.md", @@ -38336,7 +38785,7 @@ "x-appwrite": { "method": "setBillingAddress", "group": null, - "weight": 941, + "weight": 998, "cookies": false, "type": "", "demo": "organizations\/set-billing-address.md", @@ -38410,7 +38859,7 @@ "x-appwrite": { "method": "deleteBillingAddress", "group": null, - "weight": 942, + "weight": 999, "cookies": false, "type": "", "demo": "organizations\/delete-billing-address.md", @@ -38469,7 +38918,7 @@ "x-appwrite": { "method": "getBillingAddress", "group": null, - "weight": 940, + "weight": 997, "cookies": false, "type": "", "demo": "organizations\/get-billing-address.md", @@ -38538,7 +38987,7 @@ "x-appwrite": { "method": "setBillingEmail", "group": null, - "weight": 960, + "weight": 1017, "cookies": false, "type": "", "demo": "organizations\/set-billing-email.md", @@ -38618,7 +39067,7 @@ "x-appwrite": { "method": "updateBudget", "group": null, - "weight": 937, + "weight": 994, "cookies": false, "type": "", "demo": "organizations\/update-budget.md", @@ -38708,7 +39157,7 @@ "x-appwrite": { "method": "listCredits", "group": null, - "weight": 952, + "weight": 1009, "cookies": false, "type": "", "demo": "organizations\/list-credits.md", @@ -38779,7 +39228,7 @@ "x-appwrite": { "method": "addCredit", "group": null, - "weight": 953, + "weight": 1010, "cookies": false, "type": "", "demo": "organizations\/add-credit.md", @@ -38856,7 +39305,7 @@ "x-appwrite": { "method": "getAvailableCredits", "group": null, - "weight": 951, + "weight": 1008, "cookies": false, "type": "", "demo": "organizations\/get-available-credits.md", @@ -38915,7 +39364,7 @@ "x-appwrite": { "method": "getCredit", "group": null, - "weight": 950, + "weight": 1007, "cookies": false, "type": "", "demo": "organizations\/get-credit.md", @@ -38984,7 +39433,7 @@ "x-appwrite": { "method": "estimationDeleteOrganization", "group": null, - "weight": 966, + "weight": 1024, "cookies": false, "type": "", "demo": "organizations\/estimation-delete-organization.md", @@ -39045,7 +39494,7 @@ "x-appwrite": { "method": "estimationUpdatePlan", "group": null, - "weight": 964, + "weight": 1021, "cookies": false, "type": "", "demo": "organizations\/estimation-update-plan.md", @@ -39140,7 +39589,7 @@ "x-appwrite": { "method": "createDowngradeFeedback", "group": null, - "weight": 967, + "weight": 1025, "cookies": false, "type": "", "demo": "organizations\/create-downgrade-feedback.md", @@ -39238,7 +39687,7 @@ "x-appwrite": { "method": "listInvoices", "group": null, - "weight": 955, + "weight": 1012, "cookies": false, "type": "", "demo": "organizations\/list-invoices.md", @@ -39309,7 +39758,7 @@ "x-appwrite": { "method": "getInvoice", "group": null, - "weight": 954, + "weight": 1011, "cookies": false, "type": "", "demo": "organizations\/get-invoice.md", @@ -39376,7 +39825,7 @@ "x-appwrite": { "method": "getInvoiceDownload", "group": null, - "weight": 958, + "weight": 1015, "cookies": false, "type": "", "demo": "organizations\/get-invoice-download.md", @@ -39445,7 +39894,7 @@ "x-appwrite": { "method": "createInvoicePayment", "group": null, - "weight": 959, + "weight": 1016, "cookies": false, "type": "", "demo": "organizations\/create-invoice-payment.md", @@ -39532,7 +39981,7 @@ "x-appwrite": { "method": "validateInvoice", "group": null, - "weight": 956, + "weight": 1013, "cookies": false, "type": "", "demo": "organizations\/validate-invoice.md", @@ -39599,7 +40048,7 @@ "x-appwrite": { "method": "getInvoiceView", "group": null, - "weight": 957, + "weight": 1014, "cookies": false, "type": "", "demo": "organizations\/get-invoice-view.md", @@ -39666,7 +40115,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 970, + "weight": 1028, "cookies": false, "type": "", "demo": "organizations\/list-keys.md", @@ -39733,7 +40182,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 968, + "weight": 1026, "cookies": false, "type": "", "demo": "organizations\/create-key.md", @@ -39839,7 +40288,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 972, + "weight": 1030, "cookies": false, "type": "", "demo": "organizations\/get-key.md", @@ -39905,7 +40354,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 969, + "weight": 1027, "cookies": false, "type": "", "demo": "organizations\/update-key.md", @@ -40016,7 +40465,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 971, + "weight": 1029, "cookies": false, "type": "", "demo": "organizations\/delete-key.md", @@ -40084,7 +40533,7 @@ "x-appwrite": { "method": "setDefaultPaymentMethod", "group": null, - "weight": 944, + "weight": 1001, "cookies": false, "type": "", "demo": "organizations\/set-default-payment-method.md", @@ -40161,7 +40610,7 @@ "x-appwrite": { "method": "deleteDefaultPaymentMethod", "group": null, - "weight": 946, + "weight": 1003, "cookies": false, "type": "", "demo": "organizations\/delete-default-payment-method.md", @@ -40222,7 +40671,7 @@ "x-appwrite": { "method": "setBackupPaymentMethod", "group": null, - "weight": 945, + "weight": 1002, "cookies": false, "type": "", "demo": "organizations\/set-backup-payment-method.md", @@ -40299,7 +40748,7 @@ "x-appwrite": { "method": "deleteBackupPaymentMethod", "group": null, - "weight": 947, + "weight": 1004, "cookies": false, "type": "", "demo": "organizations\/delete-backup-payment-method.md", @@ -40358,7 +40807,7 @@ "x-appwrite": { "method": "getPaymentMethod", "group": null, - "weight": 943, + "weight": 1000, "cookies": false, "type": "", "demo": "organizations\/get-payment-method.md", @@ -40425,7 +40874,7 @@ "x-appwrite": { "method": "getPlan", "group": null, - "weight": 934, + "weight": 991, "cookies": false, "type": "", "demo": "organizations\/get-plan.md", @@ -40484,7 +40933,7 @@ "x-appwrite": { "method": "updatePlan", "group": null, - "weight": 935, + "weight": 992, "cookies": false, "type": "", "demo": "organizations\/update-plan.md", @@ -40607,7 +41056,7 @@ "x-appwrite": { "method": "cancelDowngrade", "group": null, - "weight": 936, + "weight": 993, "cookies": false, "type": "", "demo": "organizations\/cancel-downgrade.md", @@ -40642,6 +41091,101 @@ ] } }, + "\/organizations\/{organizationId}\/plan\/estimations": { + "post": { + "summary": "Create billing plan estimation (upgrade or downgrade)", + "operationId": "organizationsCreatePlanEstimation", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "organizations" + ], + "description": "Create a billing plan estimation for upgrading or downgrading an organization plan.\n", + "responses": { + "200": { + "description": "EstimationPlanChange", + "schema": { + "$ref": "#\/definitions\/estimationPlanChange" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createPlanEstimation", + "group": null, + "weight": 1022, + "cookies": false, + "type": "", + "demo": "organizations\/create-plan-estimation.md", + "rate-limit": 10, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "billing.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/create-plan-estimation.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "organizationId", + "description": "Organization ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "Target billing plan", + "default": null, + "x-example": "tier-0" + }, + "invites": { + "type": "array", + "description": "Additional member invites", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "couponId": { + "type": "string", + "description": "Coupon id", + "default": null, + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "billingPlan" + ] + } + } + ] + } + }, "\/organizations\/{organizationId}\/regions": { "get": { "summary": "List Regions", @@ -40666,7 +41210,7 @@ "x-appwrite": { "method": "listRegions", "group": null, - "weight": 963, + "weight": 1020, "cookies": false, "type": "", "demo": "organizations\/list-regions.md", @@ -40725,7 +41269,7 @@ "x-appwrite": { "method": "getScopes", "group": null, - "weight": 962, + "weight": 1019, "cookies": false, "type": "", "demo": "organizations\/get-scopes.md", @@ -40795,7 +41339,7 @@ "x-appwrite": { "method": "setBillingTaxId", "group": null, - "weight": 938, + "weight": 995, "cookies": false, "type": "", "demo": "organizations\/set-billing-tax-id.md", @@ -40873,7 +41417,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 939, + "weight": 996, "cookies": false, "type": "", "demo": "organizations\/get-usage.md", @@ -40952,7 +41496,7 @@ "x-appwrite": { "method": "validatePayment", "group": null, - "weight": 961, + "weight": 1018, "cookies": false, "type": "", "demo": "organizations\/validate-payment.md", @@ -41005,6 +41549,144 @@ ] } }, + "\/project": { + "delete": { + "summary": "Delete project", + "operationId": "projectDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "project" + ], + "description": "Delete a project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 1087, + "cookies": false, + "type": "", + "demo": "project\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, + "\/project\/auth-methods\/{methodId}": { + "patch": { + "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", + "operationId": "projectUpdateAuthMethod", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAuthMethod", + "group": null, + "weight": 1136, + "cookies": false, + "type": "", + "demo": "project\/update-auth-method.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "methodId", + "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "required": true, + "type": "string", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": null, + "x-enum-keys": [], + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Auth method status.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, "\/project\/auth\/canonical-emails": { "patch": { "summary": "Update project auth canonical emails", @@ -41031,7 +41713,7 @@ "x-appwrite": { "method": "updateCanonicalEmails", "group": "auth", - "weight": 1068, + "weight": 1181, "cookies": false, "type": "", "demo": "project\/update-canonical-emails.md", @@ -41103,7 +41785,7 @@ "x-appwrite": { "method": "updateDisposableEmails", "group": "auth", - "weight": 1069, + "weight": 1182, "cookies": false, "type": "", "demo": "project\/update-disposable-emails.md", @@ -41175,7 +41857,7 @@ "x-appwrite": { "method": "updateFreeEmails", "group": "auth", - "weight": 1070, + "weight": 1183, "cookies": false, "type": "", "demo": "project\/update-free-emails.md", @@ -41245,7 +41927,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1042, + "weight": 1103, "cookies": false, "type": "", "demo": "project\/list-keys.md", @@ -41305,7 +41987,7 @@ "tags": [ "project" ], - "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", + "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create an ephemeral API key if you need a short-lived key instead.", "responses": { "201": { "description": "Key", @@ -41318,7 +42000,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1041, + "weight": 1101, "cookies": false, "type": "", "demo": "project\/create-key.md", @@ -41369,75 +42051,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -41469,68 +42158,10 @@ ] } }, - "\/project\/keys\/{keyId}": { - "get": { - "summary": "Get project key", - "operationId": "projectGetKey", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "project" - ], - "description": "Get a key by its unique ID. ", - "responses": { - "200": { - "description": "Key", - "schema": { - "$ref": "#\/definitions\/key" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getKey", - "group": "keys", - "weight": 1043, - "cookies": false, - "type": "", - "demo": "project\/get-key.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "keys.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "keyId", - "description": "Key ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "put": { - "summary": "Update project key", - "operationId": "projectUpdateKey", + "\/project\/keys\/ephemeral": { + "post": { + "summary": "Create ephemeral project key", + "operationId": "projectCreateEphemeralKey", "consumes": [ "application\/json" ], @@ -41540,23 +42171,251 @@ "tags": [ "project" ], - "description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.", + "description": "Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create a standard API key if you need a longer-lived key instead.", "responses": { - "200": { - "description": "Key", + "201": { + "description": "Ephemeral Key", "schema": { - "$ref": "#\/definitions\/key" + "$ref": "#\/definitions\/ephemeralKey" } } }, "deprecated": false, "x-appwrite": { - "method": "updateKey", + "method": "createEphemeralKey", "group": "keys", - "weight": 1045, + "weight": 1102, "cookies": false, "type": "", - "demo": "project\/update-key.md", + "demo": "project\/create-ephemeral-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string", + "enum": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "rules.read", + "rules.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "duration": { + "type": "integer", + "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", + "default": null, + "x-example": 1, + "format": "int32" + } + }, + "required": [ + "scopes", + "duration" + ] + } + } + ] + } + }, + "\/project\/keys\/{keyId}": { + "get": { + "summary": "Get project key", + "operationId": "projectGetKey", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a key by its unique ID. ", + "responses": { + "200": { + "description": "Key", + "schema": { + "$ref": "#\/definitions\/key" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getKey", + "group": "keys", + "weight": 1104, + "cookies": false, + "type": "", + "demo": "project\/get-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "keyId", + "description": "Key ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update project key", + "operationId": "projectUpdateKey", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.", + "responses": { + "200": { + "description": "Key", + "schema": { + "$ref": "#\/definitions\/key" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateKey", + "group": "keys", + "weight": 1106, + "cookies": false, + "type": "", + "demo": "project\/update-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -41606,75 +42465,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -41724,7 +42590,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1044, + "weight": 1105, "cookies": false, "type": "", "demo": "project\/delete-key.md", @@ -41786,7 +42652,7 @@ "x-appwrite": { "method": "updateLabels", "group": null, - "weight": 1029, + "weight": 1088, "cookies": false, "type": "", "demo": "project\/update-labels.md", @@ -41835,10 +42701,10 @@ ] } }, - "\/project\/platforms": { + "\/project\/mock-phones": { "get": { - "summary": "List project platforms", - "operationId": "projectListPlatforms", + "summary": "List project mock phones", + "operationId": "projectListMockPhones", "consumes": [], "produces": [ "application\/json" @@ -41846,27 +42712,27 @@ "tags": [ "project" ], - "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", + "description": "Get a list of all mock phones in the project. This endpoint returns an array of all mock phones and their OTPs.", "responses": { "200": { - "description": "Platforms List", + "description": "Mock Numbers List", "schema": { - "$ref": "#\/definitions\/platformList" + "$ref": "#\/definitions\/mockNumberList" } } }, "deprecated": false, "x-appwrite": { - "method": "listPlatforms", - "group": "platforms", - "weight": 1058, + "method": "listMockPhones", + "group": "mocks", + "weight": 1121, "cookies": false, "type": "", - "demo": "project\/list-platforms.md", + "demo": "project\/list-mock-phones.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "mocks.read", "platforms": [ "console", "server" @@ -41886,7 +42752,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "type": "array", "collectionFormat": "multi", @@ -41906,12 +42772,10 @@ "in": "query" } ] - } - }, - "\/project\/platforms\/android": { + }, "post": { - "summary": "Create project Android platform", - "operationId": "projectCreateAndroidPlatform", + "summary": "Create project mock phone", + "operationId": "projectCreateMockPhone", "consumes": [ "application\/json" ], @@ -41921,27 +42785,27 @@ "tags": [ "project" ], - "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", + "description": "Create a new mock phone for your project. Use this endpoint to register a mock phone number and its sign-in OTP for your testers.", "responses": { "201": { - "description": "Platform Android", + "description": "Mock Number", "schema": { - "$ref": "#\/definitions\/platformAndroid" + "$ref": "#\/definitions\/mockNumber" } } }, "deprecated": false, "x-appwrite": { - "method": "createAndroidPlatform", - "group": "platforms", - "weight": 1054, + "method": "createMockPhone", + "group": "mocks", + "weight": 1120, "cookies": false, "type": "", - "demo": "project\/create-android-platform.md", + "demo": "project\/create-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -41965,69 +42829,61 @@ "schema": { "type": "object", "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { + "number": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.", "default": null, - "x-example": "" + "x-example": "+12065550100", + "format": "phone" }, - "applicationId": { + "otp": { "type": "string", - "description": "Android application ID. Max length: 256 chars.", + "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", "default": null, - "x-example": "" + "x-example": "" } }, "required": [ - "platformId", - "name", - "applicationId" + "number", + "otp" ] } } ] } }, - "\/project\/platforms\/android\/{platformId}": { - "put": { - "summary": "Update project Android platform", - "operationId": "projectUpdateAndroidPlatform", - "consumes": [ - "application\/json" - ], + "\/project\/mock-phones\/{number}": { + "get": { + "summary": "Get project mock phone", + "operationId": "projectGetMockPhone", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", + "description": "Get a mock phone by its unique number. This endpoint returns the mock phone's OTP.", "responses": { "200": { - "description": "Platform Android", + "description": "Mock Number", "schema": { - "$ref": "#\/definitions\/platformAndroid" + "$ref": "#\/definitions\/mockNumber" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAndroidPlatform", - "group": "platforms", - "weight": 1049, + "method": "getMockPhone", + "group": "mocks", + "weight": 1122, "cookies": false, "type": "", - "demo": "project\/update-android-platform.md", + "demo": "project\/get-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.read", "platforms": [ "console", "server" @@ -42046,45 +42902,19 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", "required": true, "type": "string", - "x-example": "", + "format": "phone", + "x-example": "+12065550100", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "applicationId": { - "type": "string", - "description": "Android application ID. Max length: 256 chars.", - "default": null, - "x-example": "" - } - }, - "required": [ - "name", - "applicationId" - ] - } } ] - } - }, - "\/project\/platforms\/apple": { - "post": { - "summary": "Create project Apple platform", - "operationId": "projectCreateApplePlatform", + }, + "put": { + "summary": "Update project mock phone", + "operationId": "projectUpdateMockPhone", "consumes": [ "application\/json" ], @@ -42094,27 +42924,27 @@ "tags": [ "project" ], - "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update a mock phone by its unique number. Use this endpoint to update the mock phone's OTP.", "responses": { - "201": { - "description": "Platform Apple", + "200": { + "description": "Mock Number", "schema": { - "$ref": "#\/definitions\/platformApple" + "$ref": "#\/definitions\/mockNumber" } } }, "deprecated": false, "x-appwrite": { - "method": "createApplePlatform", - "group": "platforms", - "weight": 1053, + "method": "updateMockPhone", + "group": "mocks", + "weight": 1123, "cookies": false, "type": "", - "demo": "project\/create-apple-platform.md", + "demo": "project\/update-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -42132,75 +42962,63 @@ } ], "parameters": [ + { + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", + "required": true, + "type": "string", + "format": "phone", + "x-example": "+12065550100", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "bundleIdentifier": { + "otp": { "type": "string", - "description": "Apple bundle identifier. Max length: 256 chars.", + "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", "default": null, - "x-example": "" + "x-example": "" } }, "required": [ - "platformId", - "name", - "bundleIdentifier" + "otp" ] } } ] - } - }, - "\/project\/platforms\/apple\/{platformId}": { - "put": { - "summary": "Update project Apple platform", - "operationId": "projectUpdateApplePlatform", + }, + "delete": { + "summary": "Delete project mock phone", + "operationId": "projectDeleteMockPhone", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "project" ], - "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", + "description": "Delete a mock phone by its unique number. This endpoint removes the mock phone and its OTP configuration from the project.", "responses": { - "200": { - "description": "Platform Apple", - "schema": { - "$ref": "#\/definitions\/platformApple" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateApplePlatform", - "group": "platforms", - "weight": 1048, + "method": "deleteMockPhone", + "group": "mocks", + "weight": 1124, "cookies": false, "type": "", - "demo": "project\/update-apple-platform.md", + "demo": "project\/delete-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -42219,75 +43037,49 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", "required": true, "type": "string", - "x-example": "", + "format": "phone", + "x-example": "+12065550100", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "bundleIdentifier": { - "type": "string", - "description": "Apple bundle identifier. Max length: 256 chars.", - "default": null, - "x-example": "" - } - }, - "required": [ - "name", - "bundleIdentifier" - ] - } } ] } }, - "\/project\/platforms\/linux": { - "post": { - "summary": "Create project Linux platform", - "operationId": "projectCreateLinuxPlatform", - "consumes": [ - "application\/json" - ], + "\/project\/oauth2": { + "get": { + "summary": "List project OAuth2 providers", + "operationId": "projectListOAuth2Providers", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", + "description": "Get a list of all OAuth2 providers supported by the server, along with the project's configuration for each. Credential fields are write-only and always returned empty.", "responses": { - "201": { - "description": "Platform Linux", + "200": { + "description": "OAuth2 Providers List", "schema": { - "$ref": "#\/definitions\/platformLinux" + "$ref": "#\/definitions\/oAuth2ProviderList" } } }, "deprecated": false, "x-appwrite": { - "method": "createLinuxPlatform", - "group": "platforms", - "weight": 1056, + "method": "listOAuth2Providers", + "group": "oauth2", + "weight": 1137, "cookies": false, "type": "", - "demo": "project\/create-linux-platform.md", + "demo": "project\/list-o-auth-2-providers.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.read", "platforms": [ "console", "server" @@ -42303,49 +43095,15 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "packageName": { - "type": "string", - "description": "Linux package name. Max length: 256 chars.", - "default": null, - "x-example": "" - } - }, - "required": [ - "platformId", - "name", - "packageName" - ] - } - } - ] - } - }, - "\/project\/platforms\/linux\/{platformId}": { - "put": { - "summary": "Update project Linux platform", - "operationId": "projectUpdateLinuxPlatform", - "consumes": [ - "application\/json" + ] + } + }, + "\/project\/oauth2\/amazon": { + "patch": { + "summary": "Update project OAuth2 Amazon", + "operationId": "projectUpdateOAuth2Amazon", + "consumes": [ + "application\/json" ], "produces": [ "application\/json" @@ -42353,27 +43111,27 @@ "tags": [ "project" ], - "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", + "description": "Update the project OAuth2 Amazon configuration.", "responses": { "200": { - "description": "Platform Linux", + "description": "OAuth2Amazon", "schema": { - "$ref": "#\/definitions\/platformLinux" + "$ref": "#\/definitions\/oAuth2Amazon" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLinuxPlatform", - "group": "platforms", - "weight": 1051, + "method": "updateOAuth2Amazon", + "group": "oauth2", + "weight": 1164, "cookies": false, "type": "", - "demo": "project\/update-linux-platform.md", + "demo": "project\/update-o-auth-2-amazon.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42391,46 +43149,43 @@ } ], "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "packageName": { + "clientSecret": { "type": "string", - "description": "Linux package name. Max length: 256 chars.", + "description": "'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "packageName" - ] + } } } ] } }, - "\/project\/platforms\/web": { - "post": { - "summary": "Create project web platform", - "operationId": "projectCreateWebPlatform", + "\/project\/oauth2\/apple": { + "patch": { + "summary": "Update project OAuth2 Apple", + "operationId": "projectUpdateOAuth2Apple", "consumes": [ "application\/json" ], @@ -42440,27 +43195,27 @@ "tags": [ "project" ], - "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Apple configuration.", "responses": { - "201": { - "description": "Platform Web", + "200": { + "description": "OAuth2Apple", "schema": { - "$ref": "#\/definitions\/platformWeb" + "$ref": "#\/definitions\/oAuth2Apple" } } }, "deprecated": false, "x-appwrite": { - "method": "createWebPlatform", - "group": "platforms", - "weight": 1052, + "method": "updateOAuth2Apple", + "group": "oauth2", + "weight": 1179, "cookies": false, "type": "", - "demo": "project\/create-web-platform.md", + "demo": "project\/update-o-auth-2-apple.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42484,39 +43239,51 @@ "schema": { "type": "object", "properties": { - "platformId": { + "serviceId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "name": { + "keyId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Key ID' of Apple OAuth2 app. For example: P4000000N8", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "hostname": { + "teamId": { "type": "string", - "description": "Platform web hostname. Max length: 256 chars.", + "description": "'Team ID' of Apple OAuth2 app. For example: D4000000R6", "default": null, - "x-example": "app.example.com" + "x-example": "", + "x-nullable": true + }, + "p8File": { + "type": "string", + "description": "Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "hostname" - ] + } } } ] } }, - "\/project\/platforms\/web\/{platformId}": { - "put": { - "summary": "Update project web platform", - "operationId": "projectUpdateWebPlatform", + "\/project\/oauth2\/auth0": { + "patch": { + "summary": "Update project OAuth2 Auth0", + "operationId": "projectUpdateOAuth2Auth0", "consumes": [ "application\/json" ], @@ -42526,27 +43293,27 @@ "tags": [ "project" ], - "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", + "description": "Update the project OAuth2 Auth0 configuration.", "responses": { "200": { - "description": "Platform Web", + "description": "OAuth2Auth0", "schema": { - "$ref": "#\/definitions\/platformWeb" + "$ref": "#\/definitions\/oAuth2Auth0" } } }, "deprecated": false, "x-appwrite": { - "method": "updateWebPlatform", - "group": "platforms", - "weight": 1047, + "method": "updateOAuth2Auth0", + "group": "oauth2", + "weight": 1173, "cookies": false, "type": "", - "demo": "project\/update-web-platform.md", + "demo": "project\/update-o-auth-2-auth-0.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42564,46 +43331,50 @@ } ], "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "hostname": { + "clientSecret": { "type": "string", - "description": "Platform web hostname. Max length: 256 chars.", + "description": "'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", "default": null, - "x-example": "app.example.com" + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of Auth0 instance. For example: example.us.auth0.com", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "hostname" - ] + } } } ] } }, - "\/project\/platforms\/windows": { - "post": { - "summary": "Create project Windows platform", - "operationId": "projectCreateWindowsPlatform", + "\/project\/oauth2\/authentik": { + "patch": { + "summary": "Update project OAuth2 Authentik", + "operationId": "projectUpdateOAuth2Authentik", "consumes": [ "application\/json" ], @@ -42613,27 +43384,27 @@ "tags": [ "project" ], - "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Authentik configuration.", "responses": { - "201": { - "description": "Platform Windows", + "200": { + "description": "OAuth2Authentik", "schema": { - "$ref": "#\/definitions\/platformWindows" + "$ref": "#\/definitions\/oAuth2Authentik" } } }, "deprecated": false, "x-appwrite": { - "method": "createWindowsPlatform", - "group": "platforms", - "weight": 1055, + "method": "updateOAuth2Authentik", + "group": "oauth2", + "weight": 1172, "cookies": false, "type": "", - "demo": "project\/create-windows-platform.md", + "demo": "project\/update-o-auth-2-authentik.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42657,39 +43428,44 @@ "schema": { "type": "object", "properties": { - "platformId": { + "clientId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "name": { + "clientSecret": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "packageIdentifierName": { + "endpoint": { "type": "string", - "description": "Windows package identifier name. Max length: 256 chars.", + "description": "Domain of Authentik instance. For example: example.authentik.com", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "packageIdentifierName" - ] + } } } ] } }, - "\/project\/platforms\/windows\/{platformId}": { - "put": { - "summary": "Update project Windows platform", - "operationId": "projectUpdateWindowsPlatform", + "\/project\/oauth2\/autodesk": { + "patch": { + "summary": "Update project OAuth2 Autodesk", + "operationId": "projectUpdateOAuth2Autodesk", "consumes": [ "application\/json" ], @@ -42699,27 +43475,27 @@ "tags": [ "project" ], - "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", + "description": "Update the project OAuth2 Autodesk configuration.", "responses": { "200": { - "description": "Platform Windows", + "description": "OAuth2Autodesk", "schema": { - "$ref": "#\/definitions\/platformWindows" + "$ref": "#\/definitions\/oAuth2Autodesk" } } }, "deprecated": false, "x-appwrite": { - "method": "updateWindowsPlatform", - "group": "platforms", - "weight": 1050, + "method": "updateOAuth2Autodesk", + "group": "oauth2", + "weight": 1147, "cookies": false, "type": "", - "demo": "project\/update-windows-platform.md", + "demo": "project\/update-o-auth-2-autodesk.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42737,100 +43513,73 @@ } ], "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "packageIdentifierName": { + "clientSecret": { "type": "string", - "description": "Windows package identifier name. Max length: 256 chars.", + "description": "'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "packageIdentifierName" - ] + } } } ] } }, - "\/project\/platforms\/{platformId}": { - "get": { - "summary": "Get project platform", - "operationId": "projectGetPlatform", - "consumes": [], + "\/project\/oauth2\/bitbucket": { + "patch": { + "summary": "Update project OAuth2 Bitbucket", + "operationId": "projectUpdateOAuth2Bitbucket", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", + "description": "Update the project OAuth2 Bitbucket configuration.", "responses": { "200": { - "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", + "description": "OAuth2Bitbucket", "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/platformWeb" - }, - { - "$ref": "#\/definitions\/platformApple" - }, - { - "$ref": "#\/definitions\/platformAndroid" - }, - { - "$ref": "#\/definitions\/platformWindows" - }, - { - "$ref": "#\/definitions\/platformLinux" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/definitions\/platformWeb", - "apple": "#\/definitions\/platformApple", - "android": "#\/definitions\/platformAndroid", - "windows": "#\/definitions\/platformWindows", - "linux": "#\/definitions\/platformLinux" - } - } + "$ref": "#\/definitions\/oAuth2Bitbucket" } } }, "deprecated": false, "x-appwrite": { - "method": "getPlatform", - "group": "platforms", - "weight": 1057, + "method": "updateOAuth2Bitbucket", + "group": "oauth2", + "weight": 1144, "cookies": false, "type": "", - "demo": "project\/get-platform.md", + "demo": "project\/update-o-auth-2-bitbucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42849,43 +43598,72 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "string", + "description": "'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "delete": { - "summary": "Delete project platform", - "operationId": "projectDeletePlatform", + } + }, + "\/project\/oauth2\/bitly": { + "patch": { + "summary": "Update project OAuth2 Bitly", + "operationId": "projectUpdateOAuth2Bitly", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "project" ], - "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", + "description": "Update the project OAuth2 Bitly configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Bitly", + "schema": { + "$ref": "#\/definitions\/oAuth2Bitly" + } } }, "deprecated": false, "x-appwrite": { - "method": "deletePlatform", - "group": "platforms", - "weight": 1046, + "method": "updateOAuth2Bitly", + "group": "oauth2", + "weight": 1145, "cookies": false, "type": "", - "demo": "project\/delete-platform.md", + "demo": "project\/update-o-auth-2-bitly.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42904,20 +43682,42 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/project\/policies\/membership-privacy": { + "\/project\/oauth2\/box": { "patch": { - "summary": "Update membership privacy policy", - "operationId": "projectUpdateMembershipPrivacyPolicy", + "summary": "Update project OAuth2 Box", + "operationId": "projectUpdateOAuth2Box", "consumes": [ "application\/json" ], @@ -42927,27 +43727,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", + "description": "Update the project OAuth2 Box configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Box", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Box" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipPrivacyPolicy", - "group": "policies", - "weight": 1059, + "method": "updateOAuth2Box", + "group": "oauth2", + "weight": 1146, "cookies": false, "type": "", - "demo": "project\/update-membership-privacy-policy.md", + "demo": "project\/update-o-auth-2-box.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -42971,35 +43771,26 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "boolean", - "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "default": null, - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "default": null, - "x-example": false - }, - "userPhone": { - "type": "boolean", - "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", + "clientId": { + "type": "string", + "description": "'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y", "default": null, - "x-example": false + "x-example": "", + "x-nullable": true }, - "userName": { - "type": "boolean", - "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif", "default": null, - "x-example": false + "x-example": "", + "x-nullable": true }, - "userMFA": { + "enabled": { "type": "boolean", - "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } } } @@ -43007,10 +43798,10 @@ ] } }, - "\/project\/policies\/password-dictionary": { + "\/project\/oauth2\/dailymotion": { "patch": { - "summary": "Update password dictionary policy", - "operationId": "projectUpdatePasswordDictionaryPolicy", + "summary": "Update project OAuth2 Dailymotion", + "operationId": "projectUpdateOAuth2Dailymotion", "consumes": [ "application\/json" ], @@ -43020,27 +43811,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "description": "Update the project OAuth2 Dailymotion configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Dailymotion", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Dailymotion" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordDictionaryPolicy", - "group": "policies", - "weight": 1060, + "method": "updateOAuth2Dailymotion", + "group": "oauth2", + "weight": 1143, "cookies": false, "type": "", - "demo": "project\/update-password-dictionary-policy.md", + "demo": "project\/update-o-auth-2-dailymotion.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43064,25 +43855,37 @@ "schema": { "type": "object", "properties": { + "apiKey": { + "type": "string", + "description": "'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f", + "default": null, + "x-example": "", + "x-nullable": true + }, + "apiSecret": { + "type": "string", + "description": "'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/policies\/password-history": { + "\/project\/oauth2\/discord": { "patch": { - "summary": "Update password history policy", - "operationId": "projectUpdatePasswordHistoryPolicy", + "summary": "Update project OAuth2 Discord", + "operationId": "projectUpdateOAuth2Discord", "consumes": [ "application\/json" ], @@ -43092,27 +43895,27 @@ "tags": [ "project" ], - "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", + "description": "Update the project OAuth2 Discord configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Discord", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Discord" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordHistoryPolicy", - "group": "policies", - "weight": 1061, + "method": "updateOAuth2Discord", + "group": "oauth2", + "weight": 1140, "cookies": false, "type": "", - "demo": "project\/update-password-history-policy.md", + "demo": "project\/update-o-auth-2-discord.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43136,27 +43939,37 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", + "clientId": { + "type": "string", + "description": "'Client ID' of Discord OAuth2 app. For example: 950722000000343754", "default": null, - "x-example": 1, - "format": "int32", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } ] } }, - "\/project\/policies\/password-personal-data": { + "\/project\/oauth2\/disqus": { "patch": { - "summary": "Update password personal data policy", - "operationId": "projectUpdatePasswordPersonalDataPolicy", + "summary": "Update project OAuth2 Disqus", + "operationId": "projectUpdateOAuth2Disqus", "consumes": [ "application\/json" ], @@ -43166,27 +43979,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", + "description": "Update the project OAuth2 Disqus configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Disqus", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Disqus" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordPersonalDataPolicy", - "group": "policies", - "weight": 1062, + "method": "updateOAuth2Disqus", + "group": "oauth2", + "weight": 1163, "cookies": false, "type": "", - "demo": "project\/update-password-personal-data-policy.md", + "demo": "project\/update-o-auth-2-disqus.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43210,25 +44023,37 @@ "schema": { "type": "object", "properties": { + "publicKey": { + "type": "string", + "description": "'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/policies\/session-alert": { + "\/project\/oauth2\/dropbox": { "patch": { - "summary": "Update session alert policy", - "operationId": "projectUpdateSessionAlertPolicy", + "summary": "Update project OAuth2 Dropbox", + "operationId": "projectUpdateOAuth2Dropbox", "consumes": [ "application\/json" ], @@ -43238,27 +44063,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.", + "description": "Update the project OAuth2 Dropbox configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Dropbox", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Dropbox" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionAlertPolicy", - "group": "policies", - "weight": 1063, + "method": "updateOAuth2Dropbox", + "group": "oauth2", + "weight": 1142, "cookies": false, "type": "", - "demo": "project\/update-session-alert-policy.md", + "demo": "project\/update-o-auth-2-dropbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43282,25 +44107,37 @@ "schema": { "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", + "appKey": { + "type": "string", + "description": "'App Key' of Dropbox OAuth2 app. For example: jl000000000009t", "default": null, - "x-example": false - } - }, - "required": [ - "enabled" - ] + "x-example": "", + "x-nullable": true + }, + "appSecret": { + "type": "string", + "description": "'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } } } ] } }, - "\/project\/policies\/session-duration": { + "\/project\/oauth2\/etsy": { "patch": { - "summary": "Update session duration policy", - "operationId": "projectUpdateSessionDurationPolicy", + "summary": "Update project OAuth2 Etsy", + "operationId": "projectUpdateOAuth2Etsy", "consumes": [ "application\/json" ], @@ -43310,27 +44147,27 @@ "tags": [ "project" ], - "description": "Update maximum duration how long sessions created within a project should stay active for.", + "description": "Update the project OAuth2 Etsy configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Etsy", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Etsy" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionDurationPolicy", - "group": "policies", - "weight": 1064, + "method": "updateOAuth2Etsy", + "group": "oauth2", + "weight": 1165, "cookies": false, "type": "", - "demo": "project\/update-session-duration-policy.md", + "demo": "project\/update-o-auth-2-etsy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43354,26 +44191,37 @@ "schema": { "type": "object", "properties": { - "duration": { - "type": "integer", - "description": "Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.", + "keyString": { + "type": "string", + "description": "'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2", "default": null, - "x-example": 5, - "format": "int32" + "x-example": "", + "x-nullable": true + }, + "sharedSecret": { + "type": "string", + "description": "'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "duration" - ] + } } } ] } }, - "\/project\/policies\/session-invalidation": { + "\/project\/oauth2\/facebook": { "patch": { - "summary": "Update session invalidation policy", - "operationId": "projectUpdateSessionInvalidationPolicy", + "summary": "Update project OAuth2 Facebook", + "operationId": "projectUpdateOAuth2Facebook", "consumes": [ "application\/json" ], @@ -43383,27 +44231,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.", + "description": "Update the project OAuth2 Facebook configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Facebook", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Facebook" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionInvalidationPolicy", - "group": "policies", - "weight": 1065, + "method": "updateOAuth2Facebook", + "group": "oauth2", + "weight": 1166, "cookies": false, "type": "", - "demo": "project\/update-session-invalidation-policy.md", + "demo": "project\/update-o-auth-2-facebook.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43427,25 +44275,37 @@ "schema": { "type": "object", "properties": { + "appId": { + "type": "string", + "description": "'App ID' of Facebook OAuth2 app. For example: 260600000007694", + "default": null, + "x-example": "", + "x-nullable": true + }, + "appSecret": { + "type": "string", + "description": "'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/policies\/session-limit": { + "\/project\/oauth2\/figma": { "patch": { - "summary": "Update session limit policy", - "operationId": "projectUpdateSessionLimitPolicy", + "summary": "Update project OAuth2 Figma", + "operationId": "projectUpdateOAuth2Figma", "consumes": [ "application\/json" ], @@ -43455,27 +44315,27 @@ "tags": [ "project" ], - "description": "Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.", + "description": "Update the project OAuth2 Figma configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Figma", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Figma" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionLimitPolicy", - "group": "policies", - "weight": 1066, + "method": "updateOAuth2Figma", + "group": "oauth2", + "weight": 1141, "cookies": false, "type": "", - "demo": "project\/update-session-limit-policy.md", + "demo": "project\/update-o-auth-2-figma.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43499,27 +44359,37 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.", + "clientId": { + "type": "string", + "description": "'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40", "default": null, - "x-example": 1, - "format": "int32", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } ] } }, - "\/project\/policies\/user-limit": { + "\/project\/oauth2\/fusionauth": { "patch": { - "summary": "Update user limit policy", - "operationId": "projectUpdateUserLimitPolicy", + "summary": "Update project OAuth2 FusionAuth", + "operationId": "projectUpdateOAuth2FusionAuth", "consumes": [ "application\/json" ], @@ -43529,27 +44399,27 @@ "tags": [ "project" ], - "description": "Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.", + "description": "Update the project OAuth2 FusionAuth configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2FusionAuth", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2FusionAuth" } } }, "deprecated": false, "x-appwrite": { - "method": "updateUserLimitPolicy", - "group": "policies", - "weight": 1067, + "method": "updateOAuth2FusionAuth", + "group": "oauth2", + "weight": 1174, "cookies": false, "type": "", - "demo": "project\/update-user-limit-policy.md", + "demo": "project\/update-o-auth-2-fusion-auth.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43573,27 +44443,44 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.", + "clientId": { + "type": "string", + "description": "'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097", "default": null, - "x-example": 1, - "format": "int32", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc", + "default": null, + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of FusionAuth instance. For example: example.fusionauth.io", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } ] } }, - "\/project\/protocols\/{protocolId}": { + "\/project\/oauth2\/github": { "patch": { - "summary": "Update project protocol", - "operationId": "projectUpdateProtocol", + "summary": "Update project OAuth2 GitHub", + "operationId": "projectUpdateOAuth2GitHub", "consumes": [ "application\/json" ], @@ -43603,27 +44490,27 @@ "tags": [ "project" ], - "description": "Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project. ", + "description": "Update the project OAuth2 GitHub configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2GitHub", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Github" } } }, "deprecated": false, "x-appwrite": { - "method": "updateProtocol", - "group": null, - "weight": 1030, + "method": "updateOAuth2GitHub", + "group": "oauth2", + "weight": 1139, "cookies": false, "type": "", - "demo": "project\/update-protocol.md", + "demo": "project\/update-o-auth-2-git-hub.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43641,46 +44528,43 @@ } ], "parameters": [ - { - "name": "protocolId", - "description": "Protocol name. Can be one of: rest, graphql, websocket", - "required": true, - "type": "string", - "x-example": "rest", - "enum": [ - "rest", - "graphql", - "websocket" - ], - "x-enum-name": null, - "x-enum-keys": [], - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "clientId": { + "type": "string", + "description": "'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Protocol status.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/services\/{serviceId}": { + "\/project\/oauth2\/gitlab": { "patch": { - "summary": "Update project service", - "operationId": "projectUpdateService", + "summary": "Update project OAuth2 Gitlab", + "operationId": "projectUpdateOAuth2Gitlab", "consumes": [ "application\/json" ], @@ -43690,27 +44574,27 @@ "tags": [ "project" ], - "description": "Update properties of a specific service. Use this endpoint to enable or disable a service in your project. ", + "description": "Update the project OAuth2 Gitlab configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Gitlab", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Gitlab" } } }, "deprecated": false, "x-appwrite": { - "method": "updateService", - "group": null, - "weight": 1031, + "method": "updateOAuth2Gitlab", + "group": "oauth2", + "weight": 1171, "cookies": false, "type": "", - "demo": "project\/update-service.md", + "demo": "project\/update-o-auth-2-gitlab.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43728,60 +44612,51 @@ } ], "parameters": [ - { - "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", - "required": true, - "type": "string", - "x-example": "account", - "enum": [ - "account", - "avatars", - "databases", - "tablesdb", - "locale", - "health", - "project", - "storage", - "teams", - "users", - "vcs", - "sites", - "functions", - "proxy", - "graphql", - "migrations", - "messaging" - ], - "x-enum-name": null, - "x-enum-keys": [], - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "applicationId": { + "type": "string", + "description": "'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "string", + "description": "'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "default": null, + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Endpoint URL of self-hosted GitLab instance. For example: https:\/\/gitlab.com", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Service status.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/smtp": { + "\/project\/oauth2\/google": { "patch": { - "summary": "Update project SMTP configuration", - "operationId": "projectUpdateSMTP", + "summary": "Update project OAuth2 Google", + "operationId": "projectUpdateOAuth2Google", "consumes": [ "application\/json" ], @@ -43791,27 +44666,27 @@ "tags": [ "project" ], - "description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.", + "description": "Update the project OAuth2 Google configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Google", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Google" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSMTP", - "group": "smtp", - "weight": 1032, + "method": "updateOAuth2Google", + "group": "oauth2", + "weight": 1148, "cookies": false, "type": "", - "demo": "project\/update-smtp.md", + "demo": "project\/update-o-auth-2-google.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43835,81 +44710,205 @@ "schema": { "type": "object", "properties": { - "host": { + "clientId": { "type": "string", - "description": "SMTP server hostname (domain)", + "description": "'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", "default": null, - "x-example": null, + "x-example": "", "x-nullable": true }, - "port": { - "type": "integer", - "description": "SMTP server port", + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj", "default": null, - "x-example": null, - "format": "int32", + "x-example": "", "x-nullable": true }, - "username": { - "type": "string", - "description": "SMTP server username. Leave empty for no authorization.", + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": "", + "x-example": false, "x-nullable": true - }, - "password": { + } + } + } + } + ] + } + }, + "\/project\/oauth2\/keycloak": { + "patch": { + "summary": "Update project OAuth2 Keycloak", + "operationId": "projectUpdateOAuth2Keycloak", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Keycloak configuration.", + "responses": { + "200": { + "description": "OAuth2Keycloak", + "schema": { + "$ref": "#\/definitions\/oAuth2Keycloak" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Keycloak", + "group": "oauth2", + "weight": 1175, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-keycloak.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { "type": "string", - "description": "SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).", + "description": "'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "senderEmail": { + "clientSecret": { "type": "string", - "description": "Email address shown in inbox as the sender of the email.", + "description": "'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "", "x-nullable": true }, - "senderName": { + "endpoint": { "type": "string", - "description": "Name shown in inbox as the sender of the email.", + "description": "Domain of Keycloak instance. For example: keycloak.example.com", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "replyToEmail": { + "realmName": { "type": "string", - "description": "Email used when user replies to the email.", + "description": "Keycloak realm name. For example: appwrite-realm", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "", "x-nullable": true }, - "replyToName": { + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } + } + ] + } + }, + "\/project\/oauth2\/kick": { + "patch": { + "summary": "Update project OAuth2 Kick", + "operationId": "projectUpdateOAuth2Kick", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Kick configuration.", + "responses": { + "200": { + "description": "OAuth2Kick", + "schema": { + "$ref": "#\/definitions\/oAuth2Kick" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Kick", + "group": "oauth2", + "weight": 1178, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-kick.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { "type": "string", - "description": "Name used when user replies to the email.", + "description": "'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "secure": { + "clientSecret": { "type": "string", - "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", + "description": "'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b", "default": null, - "x-example": "tls", - "enum": [ - "tls", - "ssl" - ], - "x-enum-name": null, - "x-enum-keys": [], + "x-example": "", "x-nullable": true }, "enabled": { "type": "boolean", - "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, "x-example": false, "x-nullable": true @@ -43920,35 +44919,40 @@ ] } }, - "\/project\/smtp\/tests": { - "post": { - "summary": "Create project SMTP test", - "operationId": "projectCreateSMTPTest", + "\/project\/oauth2\/linkedin": { + "patch": { + "summary": "Update project OAuth2 Linkedin", + "operationId": "projectUpdateOAuth2Linkedin", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "project" ], - "description": "Send a test email to verify SMTP configuration. ", + "description": "Update the project OAuth2 Linkedin configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Linkedin", + "schema": { + "$ref": "#\/definitions\/oAuth2Linkedin" + } } }, "deprecated": false, "x-appwrite": { - "method": "createSMTPTest", - "group": "smtp", - "weight": 1033, + "method": "updateOAuth2Linkedin", + "group": "oauth2", + "weight": 1162, "cookies": false, "type": "", - "demo": "project\/create-smtp-test.md", + "demo": "project\/update-o-auth-2-linkedin.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -43972,28 +44976,37 @@ "schema": { "type": "object", "properties": { - "emails": { - "type": "array", - "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", + "clientId": { + "type": "string", + "description": "'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv", "default": null, - "x-example": null, - "items": { - "type": "string" - } + "x-example": "", + "x-nullable": true + }, + "primaryClientSecret": { + "type": "string", + "description": "'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000.\/HtlYw==", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "emails" - ] + } } } ] } }, - "\/project\/templates\/email": { + "\/project\/oauth2\/microsoft": { "patch": { - "summary": "Update project email template", - "operationId": "projectUpdateEmailTemplate", + "summary": "Update project OAuth2 Microsoft", + "operationId": "projectUpdateOAuth2Microsoft", "consumes": [ "application\/json" ], @@ -44003,27 +45016,27 @@ "tags": [ "project" ], - "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", + "description": "Update the project OAuth2 Microsoft configuration.", "responses": { "200": { - "description": "EmailTemplate", + "description": "OAuth2Microsoft", "schema": { - "$ref": "#\/definitions\/emailTemplate" + "$ref": "#\/definitions\/oAuth2Microsoft" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmailTemplate", - "group": "templates", - "weight": 1035, + "method": "updateOAuth2Microsoft", + "group": "oauth2", + "weight": 1180, "cookies": false, "type": "", - "demo": "project\/update-email-template.md", + "demo": "project\/update-o-auth-2-microsoft.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "templates.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44047,249 +45060,74 @@ "schema": { "type": "object", "properties": { - "templateId": { + "applicationId": { "type": "string", - "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", + "description": "'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444", "default": null, - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [] + "x-example": "", + "x-nullable": true }, - "locale": { + "applicationSecret": { "type": "string", - "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "default": "", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [] - }, - "subject": { - "type": "string", - "description": "Subject of the email template. Can be up to 255 characters.", + "description": "'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", "default": null, - "x-example": "", - "x-nullable": true - }, - "message": { - "type": "string", - "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "senderName": { - "type": "string", - "description": "Name of the email sender.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "senderEmail": { - "type": "string", - "description": "Email of the sender.", - "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "", "x-nullable": true }, - "replyToEmail": { + "tenant": { "type": "string", - "description": "Reply to email.", + "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "", "x-nullable": true }, - "replyToName": { - "type": "string", - "description": "Reply to name.", + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": "", + "x-example": false, "x-nullable": true } - }, - "required": [ - "templateId" - ] + } } } ] } }, - "\/project\/templates\/email\/{templateId}": { - "get": { - "summary": "Get project email template", - "operationId": "projectGetEmailTemplate", - "consumes": [], + "\/project\/oauth2\/notion": { + "patch": { + "summary": "Update project OAuth2 Notion", + "operationId": "projectUpdateOAuth2Notion", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.", + "description": "Update the project OAuth2 Notion configuration.", "responses": { "200": { - "description": "EmailTemplate", + "description": "OAuth2Notion", "schema": { - "$ref": "#\/definitions\/emailTemplate" + "$ref": "#\/definitions\/oAuth2Notion" } } }, "deprecated": false, "x-appwrite": { - "method": "getEmailTemplate", - "group": "templates", - "weight": 1034, + "method": "updateOAuth2Notion", + "group": "oauth2", + "weight": 1159, "cookies": false, "type": "", - "demo": "project\/get-email-template.md", + "demo": "project\/update-o-auth-2-notion.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "templates.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44308,290 +45146,188 @@ ], "parameters": [ { - "name": "templateId", - "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", - "required": true, - "type": "string", - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [], - "in": "path" - }, - { - "name": "locale", - "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "required": false, - "type": "string", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [], - "default": "", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "oauthClientId": { + "type": "string", + "description": "'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3", + "default": null, + "x-example": "", + "x-nullable": true + }, + "oauthClientSecret": { + "type": "string", + "description": "'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/project\/usage": { - "get": { - "summary": "Get project usage stats", - "operationId": "projectGetUsage", - "consumes": [], + "\/project\/oauth2\/oidc": { + "patch": { + "summary": "Update project OAuth2 Oidc", + "operationId": "projectUpdateOAuth2Oidc", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.", + "description": "Update the project OAuth2 Oidc configuration.", "responses": { "200": { - "description": "UsageProject", + "description": "OAuth2Oidc", "schema": { - "$ref": "#\/definitions\/usageProject" + "$ref": "#\/definitions\/oAuth2Oidc" } } }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 630, + "method": "updateOAuth2Oidc", + "group": "oauth2", + "weight": 1176, "cookies": false, "type": "", - "demo": "project\/get-usage.md", + "demo": "project\/update-o-auth-2-oidc.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "startDate", - "description": "Starting date for the usage", - "required": true, - "type": "string", - "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00", - "in": "query" - }, - { - "name": "endDate", - "description": "End date for the usage", - "required": true, - "type": "string", - "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00", - "in": "query" - }, - { - "name": "period", - "description": "Period used", - "required": false, - "type": "string", - "x-example": "1h", - "enum": [ - "1h", - "1d" - ], - "x-enum-name": "ProjectUsageRange", - "x-enum-keys": [ - "One Hour", - "One Day" - ], - "default": "1d", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", + "default": null, + "x-example": "", + "x-nullable": true + }, + "wellKnownURL": { + "type": "string", + "description": "OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https:\/\/myoauth.com\/.well-known\/openid-configuration", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "authorizationURL": { + "type": "string", + "description": "OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/authorize", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "tokenUrl": { + "type": "string", + "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "userInfoUrl": { + "type": "string", + "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/project\/variables": { - "get": { - "summary": "List project variables", - "operationId": "projectListVariables", - "consumes": [], + "\/project\/oauth2\/okta": { + "patch": { + "summary": "Update project OAuth2 Okta", + "operationId": "projectUpdateOAuth2Okta", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a list of all project environment variables.", + "description": "Update the project OAuth2 Okta configuration.", "responses": { "200": { - "description": "Variables List", + "description": "OAuth2Okta", "schema": { - "$ref": "#\/definitions\/variableList" + "$ref": "#\/definitions\/oAuth2Okta" } } }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 1037, + "method": "updateOAuth2Okta", + "group": "oauth2", + "weight": 1177, "cookies": false, "type": "", - "demo": "project\/list-variables.md", + "demo": "project\/update-o-auth-2-okta.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44610,61 +45346,86 @@ ], "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: key, resourceType, resourceId, secret", - "required": false, - "type": "array", - "collectionFormat": "multi", - "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, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } - ] - }, - "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", - "consumes": [ - "application\/json" - ], + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "default": null, + "x-example": "", + "x-nullable": true + }, + "domain": { + "type": "string", + "description": "Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https:\/\/trial-6400025.okta.com\/", + "default": null, + "x-example": null, + "x-nullable": true + }, + "authorizationServerId": { + "type": "string", + "description": "Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } + } + ] + } + }, + "\/project\/oauth2\/paypal": { + "patch": { + "summary": "Update project OAuth2 Paypal", + "operationId": "projectUpdateOAuth2Paypal", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "description": "Update the project OAuth2 Paypal configuration.", "responses": { - "201": { - "description": "Variable", + "200": { + "description": "OAuth2Paypal", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/oAuth2Paypal" } } }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 1036, + "method": "updateOAuth2Paypal", + "group": "oauth2", + "weight": 1169, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "project\/update-o-auth-2-paypal.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44688,73 +45449,67 @@ "schema": { "type": "object", "properties": { - "variableId": { - "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "key": { + "clientId": { "type": "string", - "description": "Variable key. Max length: 255 chars.", + "description": "'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "value": { + "secretKey": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", + "description": "'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "secret": { + "enabled": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "default": true, - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "variableId", - "key", - "value" - ] + } } } ] } }, - "\/project\/variables\/{variableId}": { - "get": { - "summary": "Get project variable", - "operationId": "projectGetVariable", - "consumes": [], + "\/project\/oauth2\/paypalSandbox": { + "patch": { + "summary": "Update project OAuth2 PaypalSandbox", + "operationId": "projectUpdateOAuth2PaypalSandbox", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a variable by its unique ID. ", + "description": "Update the project OAuth2 PaypalSandbox configuration.", "responses": { "200": { - "description": "Variable", + "description": "OAuth2Paypal", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/oAuth2Paypal" } } }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 1038, + "method": "updateOAuth2PaypalSandbox", + "group": "oauth2", + "weight": 1170, "cookies": false, "type": "", - "demo": "project\/get-variable.md", + "demo": "project\/update-o-auth-2-paypal-sandbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44773,18 +45528,42 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "put": { - "summary": "Update project variable", - "operationId": "projectUpdateVariable", + } + }, + "\/project\/oauth2\/podio": { + "patch": { + "summary": "Update project OAuth2 Podio", + "operationId": "projectUpdateOAuth2Podio", "consumes": [ "application\/json" ], @@ -44794,27 +45573,27 @@ "tags": [ "project" ], - "description": "Update variable by its unique ID.", + "description": "Update the project OAuth2 Podio configuration.", "responses": { "200": { - "description": "Variable", + "description": "OAuth2Podio", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/oAuth2Podio" } } }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 1040, + "method": "updateOAuth2Podio", + "group": "oauth2", + "weight": 1158, "cookies": false, "type": "", - "demo": "project\/update-variable.md", + "demo": "project\/update-o-auth-2-podio.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44832,37 +45611,29 @@ } ], "parameters": [ - { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { + "clientId": { "type": "string", - "description": "Variable key. Max length: 255 chars.", + "description": "'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "value": { + "clientSecret": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", + "description": "'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "secret": { + "enabled": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, "x-example": false, "x-nullable": true @@ -44871,35 +45642,42 @@ } } ] - }, - "delete": { - "summary": "Delete project variable", - "operationId": "projectDeleteVariable", + } + }, + "\/project\/oauth2\/salesforce": { + "patch": { + "summary": "Update project OAuth2 Salesforce", + "operationId": "projectUpdateOAuth2Salesforce", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "project" ], - "description": "Delete a variable by its unique ID. ", + "description": "Update the project OAuth2 Salesforce configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Salesforce", + "schema": { + "$ref": "#\/definitions\/oAuth2Salesforce" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 1039, + "method": "updateOAuth2Salesforce", + "group": "oauth2", + "weight": 1160, "cookies": false, "type": "", - "demo": "project\/delete-variable.md", + "demo": "project\/update-o-auth-2-salesforce.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -44918,50 +45696,75 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "customerKey": { + "type": "string", + "description": "'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", + "default": null, + "x-example": "", + "x-nullable": true + }, + "customerSecret": { + "type": "string", + "description": "'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/projects": { - "get": { - "summary": "List projects", - "operationId": "projectsList", - "consumes": [], + "\/project\/oauth2\/slack": { + "patch": { + "summary": "Update project OAuth2 Slack", + "operationId": "projectUpdateOAuth2Slack", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Get a list of all projects. You can use the query params to filter your results. ", + "description": "Update the project OAuth2 Slack configuration.", "responses": { "200": { - "description": "Projects List", + "description": "OAuth2Slack", "schema": { - "$ref": "#\/definitions\/projectList" + "$ref": "#\/definitions\/oAuth2Slack" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "projects", - "weight": 1027, + "method": "updateOAuth2Slack", + "group": "oauth2", + "weight": 1157, "cookies": false, "type": "", - "demo": "projects\/list.md", + "demo": "project\/update-o-auth-2-slack.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -44971,45 +45774,48 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "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: name, teamId, labels, search", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "post": { - "summary": "Create project", - "operationId": "projectsCreate", + } + }, + "\/project\/oauth2\/spotify": { + "patch": { + "summary": "Update project OAuth2 Spotify", + "operationId": "projectUpdateOAuth2Spotify", "consumes": [ "application\/json" ], @@ -45017,42 +45823,43 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Create a new project. You can create a maximum of 100 projects per account. ", + "description": "Update the project OAuth2 Spotify configuration.", "responses": { - "201": { - "description": "Project", + "200": { + "description": "OAuth2Spotify", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Spotify" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "projects", - "weight": 1025, + "method": "updateOAuth2Spotify", + "group": "oauth2", + "weight": 1156, "cookies": false, "type": "", - "demo": "projects\/create.md", + "demo": "project\/update-o-auth-2-spotify.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -45062,167 +45869,121 @@ "schema": { "type": "object", "properties": { - "projectId": { + "clientId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", + "description": "'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace", "default": null, - "x-example": null + "x-example": "", + "x-nullable": true }, - "name": { + "clientSecret": { "type": "string", - "description": "Project name. Max length: 128 chars.", + "description": "'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "teamId": { - "type": "string", - "description": "Team unique ID.", + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": "" - }, - "region": { - "type": "string", - "description": "Project Region.", - "default": "fra", - "x-example": "fra", - "enum": [ - "fra", - "nyc", - "syd", - "sfo", - "sgp", - "tor" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "description": { - "type": "string", - "description": "Project description. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "default": "", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "default": "", - "x-example": "https:\/\/example.com", - "format": "url" - }, - "legalName": { - "type": "string", - "description": "Project legal Name. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCountry": { - "type": "string", - "description": "Project legal Country. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal State. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCity": { - "type": "string", - "description": "Project legal City. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalAddress": { - "type": "string", - "description": "Project legal Address. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalTaxId": { - "type": "string", - "description": "Project legal Tax ID. Max length: 256 chars.", - "default": "", - "x-example": "" + "x-example": false, + "x-nullable": true } - }, - "required": [ - "projectId", - "name", - "teamId" - ] + } } } ] } }, - "\/projects\/{projectId}": { - "get": { - "summary": "Get project", - "operationId": "projectsGet", - "consumes": [], + "\/project\/oauth2\/stripe": { + "patch": { + "summary": "Update project OAuth2 Stripe", + "operationId": "projectUpdateOAuth2Stripe", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", + "description": "Update the project OAuth2 Stripe configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Stripe", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Stripe" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "projects", - "weight": 57, + "method": "updateOAuth2Stripe", + "group": "oauth2", + "weight": 1155, "cookies": false, "type": "", - "demo": "projects\/get.md", + "demo": "project\/update-o-auth-2-stripe.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR", + "default": null, + "x-example": "", + "x-nullable": true + }, + "apiSecretKey": { + "type": "string", + "description": "'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, + } + }, + "\/project\/oauth2\/tradeshift": { "patch": { - "summary": "Update project", - "operationId": "projectsUpdate", + "summary": "Update project OAuth2 Tradeshift", + "operationId": "projectUpdateOAuth2Tradeshift", "consumes": [ "application\/json" ], @@ -45230,187 +45991,167 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update a project by its unique ID.", + "description": "Update the project OAuth2 Tradeshift configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Tradeshift", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Tradeshift" } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "projects", - "weight": 1026, + "method": "updateOAuth2Tradeshift", + "group": "oauth2", + "weight": 1167, "cookies": false, "type": "", - "demo": "projects\/update.md", + "demo": "project\/update-o-auth-2-tradeshift.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "oauth2ClientId": { "type": "string", - "description": "Project name. Max length: 128 chars.", + "description": "'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app", "default": null, - "x-example": "" - }, - "description": { - "type": "string", - "description": "Project description. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "logo": { - "type": "string", - "description": "Project logo.", - "default": "", - "x-example": "" - }, - "url": { - "type": "string", - "description": "Project URL.", - "default": "", - "x-example": "https:\/\/example.com", - "format": "url" + "x-example": "", + "x-nullable": true }, - "legalName": { + "oauth2ClientSecret": { "type": "string", - "description": "Project legal name. Max length: 256 chars.", - "default": "", - "x-example": "" + "description": "'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", + "default": null, + "x-example": "", + "x-nullable": true }, - "legalCountry": { - "type": "string", - "description": "Project legal country. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalState": { - "type": "string", - "description": "Project legal state. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalCity": { - "type": "string", - "description": "Project legal city. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalAddress": { - "type": "string", - "description": "Project legal address. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "legalTaxId": { - "type": "string", - "description": "Project legal tax ID. Max length: 256 chars.", - "default": "", - "x-example": "" + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name" - ] + } } } ] - }, - "delete": { - "summary": "Delete project", - "operationId": "projectsDelete", + } + }, + "\/project\/oauth2\/tradeshiftBox": { + "patch": { + "summary": "Update project OAuth2 Tradeshift Sandbox", + "operationId": "projectUpdateOAuth2TradeshiftSandbox", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "projects" + "project" ], - "description": "Delete a project by its unique ID.", + "description": "Update the project OAuth2 Tradeshift Sandbox configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Tradeshift", + "schema": { + "$ref": "#\/definitions\/oAuth2Tradeshift" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "projects", - "weight": 63, + "method": "updateOAuth2TradeshiftSandbox", + "group": "oauth2", + "weight": 1168, "cookies": false, "type": "", - "demo": "projects\/delete.md", + "demo": "project\/update-o-auth-2-tradeshift-sandbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "oauth2ClientId": { + "type": "string", + "description": "'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app", + "default": null, + "x-example": "", + "x-nullable": true + }, + "oauth2ClientSecret": { + "type": "string", + "description": "'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/projects\/{projectId}\/auth\/mock-numbers": { + "\/project\/oauth2\/twitch": { "patch": { - "summary": "Update the mock numbers for the project", - "operationId": "projectsUpdateMockNumbers", + "summary": "Update project OAuth2 Twitch", + "operationId": "projectUpdateOAuth2Twitch", "consumes": [ "application\/json" ], @@ -45418,81 +46159,83 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. ", + "description": "Update the project OAuth2 Twitch configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Twitch", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Twitch" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMockNumbers", - "group": "auth", - "weight": 62, + "method": "updateOAuth2Twitch", + "group": "oauth2", + "weight": 1154, "cookies": false, "type": "", - "demo": "projects\/update-mock-numbers.md", + "demo": "project\/update-o-auth-2-twitch.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "numbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.", + "clientId": { + "type": "string", + "description": "'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p", "default": null, - "x-example": null, - "items": { - "type": "object" - } + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "numbers" - ] + } } } ] } }, - "\/projects\/{projectId}\/auth\/{method}": { + "\/project\/oauth2\/wordpress": { "patch": { - "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", - "operationId": "projectsUpdateAuthStatus", + "summary": "Update project OAuth2 WordPress", + "operationId": "projectUpdateOAuth2WordPress", "consumes": [ "application\/json" ], @@ -45500,97 +46243,83 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project. ", + "description": "Update the project OAuth2 WordPress configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2WordPress", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2WordPress" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAuthStatus", - "group": "auth", - "weight": 61, + "method": "updateOAuth2WordPress", + "group": "oauth2", + "weight": 1153, "cookies": false, "type": "", - "demo": "projects\/update-auth-status.md", + "demo": "project\/update-o-auth-2-word-press.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "method", - "description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", - "required": true, - "type": "string", - "x-example": "email-password", - "enum": [ - "email-password", - "magic-url", - "email-otp", - "anonymous", - "invites", - "jwt", - "phone" - ], - "x-enum-name": "AuthMethod", - "x-enum-keys": [], - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "status": { + "clientId": { + "type": "string", + "description": "'Client ID' of WordPress OAuth2 app. For example: 130005", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { "type": "boolean", - "description": "Set the status of this auth method.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "status" - ] + } } } ] } }, - "\/projects\/{projectId}\/console-access": { + "\/project\/oauth2\/x": { "patch": { - "summary": "Record console access to a project", - "operationId": "projectsUpdateConsoleAccess", + "summary": "Update project OAuth2 X", + "operationId": "projectUpdateOAuth2X", "consumes": [ "application\/json" ], @@ -45598,87 +46327,116 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", + "description": "Update the project OAuth2 X configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2X", + "schema": { + "$ref": "#\/definitions\/oAuth2X" + } } }, "deprecated": false, "x-appwrite": { - "method": "updateConsoleAccess", - "group": null, - "weight": 1022, + "method": "updateOAuth2X", + "group": "oauth2", + "weight": 1152, "cookies": false, "type": "", - "demo": "projects\/update-console-access.md", + "demo": "project\/update-o-auth-2x.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project ID", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "customerKey": { + "type": "string", + "description": "'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/projects\/{projectId}\/dev-keys": { - "get": { - "summary": "List dev keys", - "operationId": "projectsListDevKeys", - "consumes": [], + "\/project\/oauth2\/yahoo": { + "patch": { + "summary": "Update project OAuth2 Yahoo", + "operationId": "projectUpdateOAuth2Yahoo", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", + "description": "Update the project OAuth2 Yahoo configuration.", "responses": { "200": { - "description": "Dev Keys List", + "description": "OAuth2Yahoo", "schema": { - "$ref": "#\/definitions\/devKeyList" + "$ref": "#\/definitions\/oAuth2Yahoo" } } }, "deprecated": false, "x-appwrite": { - "method": "listDevKeys", - "group": "devKeys", - "weight": 425, + "method": "updateOAuth2Yahoo", + "group": "oauth2", + "weight": 1161, "cookies": false, "type": "", - "demo": "projects\/list-dev-keys.md", + "demo": "project\/update-o-auth-2-yahoo.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45688,35 +46446,48 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: accessedAt, expire", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "post": { - "summary": "Create dev key", - "operationId": "projectsCreateDevKey", + } + }, + "\/project\/oauth2\/yandex": { + "patch": { + "summary": "Update project OAuth2 Yandex", + "operationId": "projectUpdateOAuth2Yandex", "consumes": [ "application\/json" ], @@ -45724,31 +46495,32 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", + "description": "Update the project OAuth2 Yandex configuration.", "responses": { - "201": { - "description": "DevKey", + "200": { + "description": "OAuth2Yandex", "schema": { - "$ref": "#\/definitions\/devKey" + "$ref": "#\/definitions\/oAuth2Yandex" } } }, "deprecated": false, "x-appwrite": { - "method": "createDevKey", - "group": "devKeys", - "weight": 422, + "method": "updateOAuth2Yandex", + "group": "oauth2", + "weight": 1151, "cookies": false, "type": "", - "demo": "projects\/create-dev-key.md", + "demo": "project\/update-o-auth-2-yandex.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45758,81 +46530,81 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Key name. Max length: 128 chars.", + "description": "'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "expire": { + "clientSecret": { "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "description": "'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime" + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "expire" - ] + } } } ] } }, - "\/projects\/{projectId}\/dev-keys\/{keyId}": { - "get": { - "summary": "Get dev key", - "operationId": "projectsGetDevKey", - "consumes": [], + "\/project\/oauth2\/zoho": { + "patch": { + "summary": "Update project OAuth2 Zoho", + "operationId": "projectUpdateOAuth2Zoho", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", + "description": "Update the project OAuth2 Zoho configuration.", "responses": { "200": { - "description": "DevKey", + "description": "OAuth2Zoho", "schema": { - "$ref": "#\/definitions\/devKey" + "$ref": "#\/definitions\/oAuth2Zoho" } } }, "deprecated": false, "x-appwrite": { - "method": "getDevKey", - "group": "devKeys", - "weight": 424, + "method": "updateOAuth2Zoho", + "group": "oauth2", + "weight": 1150, "cookies": false, "type": "", - "demo": "projects\/get-dev-key.md", + "demo": "project\/update-o-auth-2-zoho.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.read", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45842,31 +46614,48 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "put": { - "summary": "Update dev key", - "operationId": "projectsUpdateDevKey", + } + }, + "\/project\/oauth2\/zoom": { + "patch": { + "summary": "Update project OAuth2 Zoom", + "operationId": "projectUpdateOAuth2Zoom", "consumes": [ "application\/json" ], @@ -45874,31 +46663,32 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", + "description": "Update the project OAuth2 Zoom configuration.", "responses": { "200": { - "description": "DevKey", + "description": "OAuth2Zoom", "schema": { - "$ref": "#\/definitions\/devKey" + "$ref": "#\/definitions\/oAuth2Zoom" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDevKey", - "group": "devKeys", - "weight": 423, + "method": "updateOAuth2Zoom", + "group": "oauth2", + "weight": 1149, "cookies": false, "type": "", - "demo": "projects\/update-dev-key.md", + "demo": "project\/update-o-auth-2-zoom.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", + "scope": "oauth2.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -45908,289 +46698,349 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Key name. Max length: 128 chars.", + "description": "'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "expire": { + "clientSecret": { "type": "string", - "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "description": "'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime" + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "expire" - ] + } } } ] - }, - "delete": { - "summary": "Delete dev key", - "operationId": "projectsDeleteDevKey", - "consumes": [ + } + }, + "\/project\/oauth2\/{provider}": { + "get": { + "summary": "Get project OAuth2 provider", + "operationId": "projectGetOAuth2Provider", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "projects" + "project" ], - "description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", + "description": "Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key\/team IDs) are write-only and always returned empty.", "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteDevKey", - "group": "devKeys", - "weight": 426, - "cookies": false, - "type": "", - "demo": "projects\/delete-dev-key.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "devKeys.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] + "200": { + "description": "OAuth2GitHub, or OAuth2Discord, or OAuth2Figma, or OAuth2Dropbox, or OAuth2Dailymotion, or OAuth2Bitbucket, or OAuth2Bitly, or OAuth2Box, or OAuth2Autodesk, or OAuth2Google, or OAuth2Zoom, or OAuth2Zoho, or OAuth2Yandex, or OAuth2X, or OAuth2WordPress, or OAuth2Twitch, or OAuth2Stripe, or OAuth2Spotify, or OAuth2Slack, or OAuth2Podio, or OAuth2Notion, or OAuth2Salesforce, or OAuth2Yahoo, or OAuth2Linkedin, or OAuth2Disqus, or OAuth2Amazon, or OAuth2Etsy, or OAuth2Facebook, or OAuth2Tradeshift, or OAuth2Paypal, or OAuth2Gitlab, or OAuth2Authentik, or OAuth2Auth0, or OAuth2FusionAuth, or OAuth2Keycloak, or OAuth2Oidc, or OAuth2Apple, or OAuth2Okta, or OAuth2Kick, or OAuth2Microsoft", + "schema": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/oAuth2Github" + }, + { + "$ref": "#\/definitions\/oAuth2Discord" + }, + { + "$ref": "#\/definitions\/oAuth2Figma" + }, + { + "$ref": "#\/definitions\/oAuth2Dropbox" + }, + { + "$ref": "#\/definitions\/oAuth2Dailymotion" + }, + { + "$ref": "#\/definitions\/oAuth2Bitbucket" + }, + { + "$ref": "#\/definitions\/oAuth2Bitly" + }, + { + "$ref": "#\/definitions\/oAuth2Box" + }, + { + "$ref": "#\/definitions\/oAuth2Autodesk" + }, + { + "$ref": "#\/definitions\/oAuth2Google" + }, + { + "$ref": "#\/definitions\/oAuth2Zoom" + }, + { + "$ref": "#\/definitions\/oAuth2Zoho" + }, + { + "$ref": "#\/definitions\/oAuth2Yandex" + }, + { + "$ref": "#\/definitions\/oAuth2X" + }, + { + "$ref": "#\/definitions\/oAuth2WordPress" + }, + { + "$ref": "#\/definitions\/oAuth2Twitch" + }, + { + "$ref": "#\/definitions\/oAuth2Stripe" + }, + { + "$ref": "#\/definitions\/oAuth2Spotify" + }, + { + "$ref": "#\/definitions\/oAuth2Slack" + }, + { + "$ref": "#\/definitions\/oAuth2Podio" + }, + { + "$ref": "#\/definitions\/oAuth2Notion" + }, + { + "$ref": "#\/definitions\/oAuth2Salesforce" + }, + { + "$ref": "#\/definitions\/oAuth2Yahoo" + }, + { + "$ref": "#\/definitions\/oAuth2Linkedin" + }, + { + "$ref": "#\/definitions\/oAuth2Disqus" + }, + { + "$ref": "#\/definitions\/oAuth2Amazon" + }, + { + "$ref": "#\/definitions\/oAuth2Etsy" + }, + { + "$ref": "#\/definitions\/oAuth2Facebook" + }, + { + "$ref": "#\/definitions\/oAuth2Tradeshift" + }, + { + "$ref": "#\/definitions\/oAuth2Paypal" + }, + { + "$ref": "#\/definitions\/oAuth2Gitlab" + }, + { + "$ref": "#\/definitions\/oAuth2Authentik" + }, + { + "$ref": "#\/definitions\/oAuth2Auth0" + }, + { + "$ref": "#\/definitions\/oAuth2FusionAuth" + }, + { + "$ref": "#\/definitions\/oAuth2Keycloak" + }, + { + "$ref": "#\/definitions\/oAuth2Oidc" + }, + { + "$ref": "#\/definitions\/oAuth2Apple" + }, + { + "$ref": "#\/definitions\/oAuth2Okta" + }, + { + "$ref": "#\/definitions\/oAuth2Kick" + }, + { + "$ref": "#\/definitions\/oAuth2Microsoft" + } + ], + "x-discriminator": { + "propertyName": "$id", + "mapping": { + "github": "#\/definitions\/oAuth2Github", + "discord": "#\/definitions\/oAuth2Discord", + "figma": "#\/definitions\/oAuth2Figma", + "dropbox": "#\/definitions\/oAuth2Dropbox", + "dailymotion": "#\/definitions\/oAuth2Dailymotion", + "bitbucket": "#\/definitions\/oAuth2Bitbucket", + "bitly": "#\/definitions\/oAuth2Bitly", + "box": "#\/definitions\/oAuth2Box", + "autodesk": "#\/definitions\/oAuth2Autodesk", + "google": "#\/definitions\/oAuth2Google", + "zoom": "#\/definitions\/oAuth2Zoom", + "zoho": "#\/definitions\/oAuth2Zoho", + "yandex": "#\/definitions\/oAuth2Yandex", + "x": "#\/definitions\/oAuth2X", + "wordpress": "#\/definitions\/oAuth2WordPress", + "twitch": "#\/definitions\/oAuth2Twitch", + "stripe": "#\/definitions\/oAuth2Stripe", + "spotify": "#\/definitions\/oAuth2Spotify", + "slack": "#\/definitions\/oAuth2Slack", + "podio": "#\/definitions\/oAuth2Podio", + "notion": "#\/definitions\/oAuth2Notion", + "salesforce": "#\/definitions\/oAuth2Salesforce", + "yahoo": "#\/definitions\/oAuth2Yahoo", + "linkedin": "#\/definitions\/oAuth2Linkedin", + "disqus": "#\/definitions\/oAuth2Disqus", + "amazon": "#\/definitions\/oAuth2Amazon", + "etsy": "#\/definitions\/oAuth2Etsy", + "facebook": "#\/definitions\/oAuth2Facebook", + "tradeshift": "#\/definitions\/oAuth2Tradeshift", + "tradeshiftBox": "#\/definitions\/oAuth2Tradeshift", + "paypal": "#\/definitions\/oAuth2Paypal", + "paypalSandbox": "#\/definitions\/oAuth2Paypal", + "gitlab": "#\/definitions\/oAuth2Gitlab", + "authentik": "#\/definitions\/oAuth2Authentik", + "auth0": "#\/definitions\/oAuth2Auth0", + "fusionauth": "#\/definitions\/oAuth2FusionAuth", + "keycloak": "#\/definitions\/oAuth2Keycloak", + "oidc": "#\/definitions\/oAuth2Oidc", + "apple": "#\/definitions\/oAuth2Apple", + "okta": "#\/definitions\/oAuth2Okta", + "kick": "#\/definitions\/oAuth2Kick", + "microsoft": "#\/definitions\/oAuth2Microsoft" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getOAuth2Provider", + "group": "oauth2", + "weight": 1138, + "cookies": false, + "type": "", + "demo": "project\/get-o-auth-2-provider.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "keyId", - "description": "Key unique ID.", + "name": "provider", + "description": "OAuth2 provider key. For example: github, google, apple.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/projects\/{projectId}\/jwts": { - "post": { - "summary": "Create JWT", - "operationId": "projectsCreateJWT", - "consumes": [ - "application\/json" - ], + "\/project\/platforms": { + "get": { + "summary": "List project platforms", + "operationId": "projectListPlatforms", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ", + "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", "responses": { - "201": { - "description": "JWT", + "200": { + "description": "Platforms List", "schema": { - "$ref": "#\/definitions\/jwt" + "$ref": "#\/definitions\/platformList" } } }, "deprecated": false, "x-appwrite": { - "method": "createJWT", - "group": "auth", - "weight": 64, + "method": "listPlatforms", + "group": "platforms", + "weight": 1119, "cookies": false, "type": "", - "demo": "projects\/create-jwt.md", + "demo": "project\/list-platforms.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "scopes": { - "type": "array", - "description": "List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.", - "default": null, - "x-example": null, - "items": { - "type": "string", - "enum": [ - "sessions.write", - "users.read", - "users.write", - "teams.read", - "teams.write", - "databases.read", - "databases.write", - "collections.read", - "collections.write", - "tables.read", - "tables.write", - "attributes.read", - "attributes.write", - "columns.read", - "columns.write", - "indexes.read", - "indexes.write", - "documents.read", - "documents.write", - "rows.read", - "rows.write", - "files.read", - "files.write", - "buckets.read", - "buckets.write", - "functions.read", - "functions.write", - "sites.read", - "sites.write", - "log.read", - "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", - "providers.read", - "providers.write", - "messages.read", - "messages.write", - "topics.read", - "topics.write", - "subscribers.read", - "subscribers.write", - "targets.read", - "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", - "migrations.read", - "migrations.write", - "vcs.read", - "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", - "archives.read", - "archives.write", - "restorations.read", - "restorations.write", - "domains.read", - "domains.write", - "events.read" - ], - "x-enum-name": null, - "x-enum-keys": [] - } - }, - "duration": { - "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", - "default": 900, - "x-example": 0, - "format": "int32" - } - }, - "required": [ - "scopes" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/projects\/{projectId}\/oauth2": { - "patch": { - "summary": "Update project OAuth2", - "operationId": "projectsUpdateOAuth2", + "\/project\/platforms\/android": { + "post": { + "summary": "Create project Android platform", + "operationId": "projectCreateAndroidPlatform", "consumes": [ "application\/json" ], @@ -46198,221 +47048,172 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ", + "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Project", + "201": { + "description": "Platform Android", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformAndroid" } } }, "deprecated": false, "x-appwrite": { - "method": "updateOAuth2", - "group": "auth", - "weight": 60, + "method": "createAndroidPlatform", + "group": "platforms", + "weight": 1115, "cookies": false, "type": "", - "demo": "projects\/update-o-auth-2.md", + "demo": "project\/create-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "provider": { + "platformId": { "type": "string", - "description": "Provider Name", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "amazon", - "enum": [ - "amazon", - "apple", - "auth0", - "authentik", - "autodesk", - "bitbucket", - "bitly", - "box", - "dailymotion", - "discord", - "disqus", - "dropbox", - "etsy", - "facebook", - "figma", - "github", - "gitlab", - "google", - "linkedin", - "microsoft", - "notion", - "oidc", - "okta", - "paypal", - "paypalSandbox", - "podio", - "salesforce", - "slack", - "spotify", - "stripe", - "tradeshift", - "tradeshiftBox", - "twitch", - "wordpress", - "x", - "yahoo", - "yammer", - "yandex", - "zoho", - "zoom" - ], - "x-enum-name": "OAuthProvider", - "x-enum-keys": [] + "x-example": "" }, - "appId": { + "name": { "type": "string", - "description": "Provider app ID. Max length: 256 chars.", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, - "secret": { + "applicationId": { "type": "string", - "description": "Provider secret key. Max length: 512 chars.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "enabled": { - "type": "boolean", - "description": "Provider status. Set to 'false' to disable new session creation.", + "description": "Android application ID. Max length: 256 chars.", "default": null, - "x-example": false, - "x-nullable": true + "x-example": "" } }, "required": [ - "provider" + "platformId", + "name", + "applicationId" ] } } ] } }, - "\/projects\/{projectId}\/schedules": { - "get": { - "summary": "List schedules", - "operationId": "projectsListSchedules", - "consumes": [], + "\/project\/platforms\/android\/{platformId}": { + "put": { + "summary": "Update project Android platform", + "operationId": "projectUpdateAndroidPlatform", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Get a list of all the project's schedules. You can use the query params to filter your results.", + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", "responses": { "200": { - "description": "Schedules List", + "description": "Platform Android", "schema": { - "$ref": "#\/definitions\/scheduleList" + "$ref": "#\/definitions\/platformAndroid" } } }, "deprecated": false, "x-appwrite": { - "method": "listSchedules", - "group": "schedules", - "weight": 433, + "method": "updateAndroidPlatform", + "group": "platforms", + "weight": 1110, "cookies": false, "type": "", - "demo": "projects\/list-schedules.md", + "demo": "project\/update-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "schedules.read", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-schedules.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: resourceType, resourceId, projectId, schedule, active, region", - "required": false, - "type": "array", - "collectionFormat": "multi", - "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, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "applicationId" + ] + } } ] - }, + } + }, + "\/project\/platforms\/apple": { "post": { - "summary": "Create schedule", - "operationId": "projectsCreateSchedule", + "summary": "Create project Apple platform", + "operationId": "projectCreateApplePlatform", "consumes": [ "application\/json" ], @@ -46420,179 +47221,172 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Create a new schedule for a resource.", + "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", "responses": { "201": { - "description": "Schedule", + "description": "Platform Apple", "schema": { - "$ref": "#\/definitions\/schedule" + "$ref": "#\/definitions\/platformApple" } } }, "deprecated": false, "x-appwrite": { - "method": "createSchedule", - "group": "schedules", - "weight": 1028, + "method": "createApplePlatform", + "group": "platforms", + "weight": 1114, "cookies": false, "type": "", - "demo": "projects\/create-schedule.md", + "demo": "project\/create-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "schedules.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-schedule.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "resourceType": { + "platformId": { "type": "string", - "description": "The resource type for the schedule. Possible values: function, execution, message, backup.", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "function", - "enum": [ - "function", - "execution", - "message", - "backup" - ], - "x-enum-name": null, - "x-enum-keys": [] + "x-example": "" }, - "resourceId": { + "name": { "type": "string", - "description": "The resource ID to associate with this schedule.", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "schedule": { + "bundleIdentifier": { "type": "string", - "description": "Schedule CRON expression.", + "description": "Apple bundle identifier. Max length: 256 chars.", "default": null, - "x-example": null - }, - "active": { - "type": "boolean", - "description": "Whether the schedule is active.", - "default": false, - "x-example": false - }, - "data": { - "type": "object", - "description": "Schedule data as a JSON string. Used to store resource-specific context needed for execution.", - "default": {}, - "x-example": "{}" + "x-example": "" } }, "required": [ - "resourceType", - "resourceId", - "schedule" + "platformId", + "name", + "bundleIdentifier" ] } } ] } }, - "\/projects\/{projectId}\/schedules\/{scheduleId}": { - "get": { - "summary": "Get schedule", - "operationId": "projectsGetSchedule", - "consumes": [], + "\/project\/platforms\/apple\/{platformId}": { + "put": { + "summary": "Update project Apple platform", + "operationId": "projectUpdateApplePlatform", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Get a schedule by its unique ID.", + "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", "responses": { "200": { - "description": "Schedule", + "description": "Platform Apple", "schema": { - "$ref": "#\/definitions\/schedule" + "$ref": "#\/definitions\/platformApple" } } }, "deprecated": false, "x-appwrite": { - "method": "getSchedule", - "group": "schedules", - "weight": 432, + "method": "updateApplePlatform", + "group": "platforms", + "weight": 1109, "cookies": false, "type": "", - "demo": "projects\/get-schedule.md", + "demo": "project\/update-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "schedules.read", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-schedule.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "scheduleId", - "description": "Schedule ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "bundleIdentifier" + ] + } } ] } }, - "\/projects\/{projectId}\/status": { - "patch": { - "summary": "Update the status of a project", - "operationId": "projectsUpdateStatus", + "\/project\/platforms\/linux": { + "post": { + "summary": "Create project Linux platform", + "operationId": "projectCreateLinuxPlatform", "consumes": [ "application\/json" ], @@ -46600,80 +47394,85 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the status of a project. Can be used to archive\/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.\n", + "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Platform Linux", + "schema": { + "$ref": "#\/definitions\/platformLinux" + } } }, "deprecated": false, "x-appwrite": { - "method": "updateStatus", - "group": null, - "weight": 1023, + "method": "createLinuxPlatform", + "group": "platforms", + "weight": 1117, "cookies": false, "type": "", - "demo": "projects\/update-status.md", - "rate-limit": 10, + "demo": "project\/create-linux-platform.md", + "rate-limit": 0, "rate-time": 3600, - "rate-key": "ip:{ip},userId:{userId}", - "scope": "projects.write", + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-status.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "projectId", - "description": "Project ID", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "status": { + "platformId": { "type": "string", - "description": "New status for the project", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "active", - "enum": [ - "active" - ], - "x-enum-name": null, - "x-enum-keys": [] + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "default": null, + "x-example": "" } }, "required": [ - "status" + "platformId", + "name", + "packageName" ] } } ] } }, - "\/projects\/{projectId}\/team": { - "patch": { - "summary": "Update project team", - "operationId": "projectsUpdateTeam", + "\/project\/platforms\/linux\/{platformId}": { + "put": { + "summary": "Update project Linux platform", + "operationId": "projectUpdateLinuxPlatform", "consumes": [ "application\/json" ], @@ -46681,51 +47480,52 @@ "application\/json" ], "tags": [ - "projects" + "project" ], - "description": "Update the team ID of a project allowing for it to be transferred to another team.", + "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", "responses": { "200": { - "description": "Project", + "description": "Platform Linux", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/platformLinux" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTeam", - "group": "projects", - "weight": 1024, + "method": "updateLinuxPlatform", + "group": "platforms", + "weight": 1112, "cookies": false, "type": "", - "demo": "projects\/update-team.md", + "demo": "project\/update-linux-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "projects.write", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "projectId", - "description": "Project unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -46734,55 +47534,65 @@ "schema": { "type": "object", "properties": { - "teamId": { + "name": { "type": "string", - "description": "Team ID of the team to transfer project to.", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": "" + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "default": null, + "x-example": "" } }, "required": [ - "teamId" + "name", + "packageName" ] } } ] } }, - "\/proxy\/rules": { - "get": { - "summary": "List rules", - "operationId": "proxyListRules", - "consumes": [], + "\/project\/platforms\/web": { + "post": { + "summary": "Create project web platform", + "operationId": "projectCreateWebPlatform", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "proxy" + "project" ], - "description": "Get a list of all the proxy rules. You can use the query params to filter your results.", + "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Rule List", + "201": { + "description": "Platform Web", "schema": { - "$ref": "#\/definitions\/proxyRuleList" + "$ref": "#\/definitions\/platformWeb" } } }, "deprecated": false, "x-appwrite": { - "method": "listRules", - "group": null, - "weight": 1080, + "method": "createWebPlatform", + "group": "platforms", + "weight": 1113, "cookies": false, "type": "", - "demo": "proxy\/list-rules.md", + "demo": "project\/create-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.read", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -46792,47 +47602,50 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "default": null, + "x-example": "app.example.com" + } + }, + "required": [ + "platformId", + "name", + "hostname" + ] + } } ] } }, - "\/proxy\/rules\/api": { - "post": { - "summary": "Create API rule", - "operationId": "proxyCreateAPIRule", + "\/project\/platforms\/web\/{platformId}": { + "put": { + "summary": "Update project web platform", + "operationId": "projectUpdateWebPlatform", "consumes": [ "application\/json" ], @@ -46840,31 +47653,32 @@ "application\/json" ], "tags": [ - "proxy" + "project" ], - "description": "Create a new proxy rule for serving Appwrite's API on custom domain.", + "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", "responses": { - "201": { - "description": "Rule", + "200": { + "description": "Platform Web", "schema": { - "$ref": "#\/definitions\/proxyRule" + "$ref": "#\/definitions\/platformWeb" } } }, "deprecated": false, "x-appwrite": { - "method": "createAPIRule", - "group": null, - "weight": 1075, + "method": "updateWebPlatform", + "group": "platforms", + "weight": 1108, "cookies": false, "type": "", - "demo": "proxy\/create-api-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", - "scope": "rules.write", + "demo": "project\/update-web-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -46874,35 +47688,51 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "domain": { + "name": { "type": "string", - "description": "Domain name.", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": null + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "default": null, + "x-example": "app.example.com" } }, "required": [ - "domain" + "name", + "hostname" ] } } ] } }, - "\/proxy\/rules\/function": { + "\/project\/platforms\/windows": { "post": { - "summary": "Create function rule", - "operationId": "proxyCreateFunctionRule", + "summary": "Create project Windows platform", + "operationId": "projectCreateWindowsPlatform", "consumes": [ "application\/json" ], @@ -46910,31 +47740,32 @@ "application\/json" ], "tags": [ - "proxy" + "project" ], - "description": "Create a new proxy rule for executing Appwrite Function on custom domain.", + "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", "responses": { "201": { - "description": "Rule", + "description": "Platform Windows", "schema": { - "$ref": "#\/definitions\/proxyRule" + "$ref": "#\/definitions\/platformWindows" } } }, "deprecated": false, "x-appwrite": { - "method": "createFunctionRule", - "group": null, - "weight": 1077, + "method": "createWindowsPlatform", + "group": "platforms", + "weight": 1116, "cookies": false, "type": "", - "demo": "proxy\/create-function-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", - "scope": "rules.write", + "demo": "project\/create-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -46944,7 +47775,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -46954,38 +47786,39 @@ "schema": { "type": "object", "properties": { - "domain": { + "platformId": { "type": "string", - "description": "Domain name.", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": null + "x-example": "" }, - "functionId": { + "name": { "type": "string", - "description": "ID of function to be executed.", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "branch": { + "packageIdentifierName": { "type": "string", - "description": "Name of VCS branch to deploy changes automatically", - "default": "", - "x-example": "" + "description": "Windows package identifier name. Max length: 256 chars.", + "default": null, + "x-example": "" } }, "required": [ - "domain", - "functionId" + "platformId", + "name", + "packageIdentifierName" ] } } ] } }, - "\/proxy\/rules\/redirect": { - "post": { - "summary": "Create Redirect rule", - "operationId": "proxyCreateRedirectRule", + "\/project\/platforms\/windows\/{platformId}": { + "put": { + "summary": "Update project Windows platform", + "operationId": "projectUpdateWindowsPlatform", "consumes": [ "application\/json" ], @@ -46993,31 +47826,32 @@ "application\/json" ], "tags": [ - "proxy" + "project" ], - "description": "Create a new proxy rule for to redirect from custom domain to another domain.", + "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", "responses": { - "201": { - "description": "Rule", + "200": { + "description": "Platform Windows", "schema": { - "$ref": "#\/definitions\/proxyRule" + "$ref": "#\/definitions\/platformWindows" } } }, "deprecated": false, "x-appwrite": { - "method": "createRedirectRule", - "group": null, - "weight": 1078, + "method": "updateWindowsPlatform", + "group": "platforms", + "weight": 1111, "cookies": false, "type": "", - "demo": "proxy\/create-redirect-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", - "scope": "rules.write", + "demo": "project\/update-windows-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47027,118 +47861,163 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "domain": { + "name": { "type": "string", - "description": "Domain name.", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": null + "x-example": "" }, - "url": { + "packageIdentifierName": { "type": "string", - "description": "Target URL of redirection", + "description": "Windows package identifier name. Max length: 256 chars.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url" + "x-example": "" + } + }, + "required": [ + "name", + "packageIdentifierName" + ] + } + } + ] + } + }, + "\/project\/platforms\/{platformId}": { + "get": { + "summary": "Get project platform", + "operationId": "projectGetPlatform", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", + "responses": { + "200": { + "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", + "schema": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/platformWeb" }, - "statusCode": { - "type": "string", - "description": "Status code of redirection", - "default": null, - "x-example": "301", - "enum": [ - "301", - "302", - "307", - "308" - ], - "x-enum-name": null, - "x-enum-keys": [ - "Moved Permanently 301", - "Found 302", - "Temporary Redirect 307", - "Permanent Redirect 308" - ] + { + "$ref": "#\/definitions\/platformApple" }, - "resourceId": { - "type": "string", - "description": "ID of parent resource.", - "default": null, - "x-example": "" + { + "$ref": "#\/definitions\/platformAndroid" }, - "resourceType": { - "type": "string", - "description": "Type of parent resource.", - "default": null, - "x-example": "site", - "enum": [ - "site", - "function" - ], - "x-enum-name": "ProxyResourceType", - "x-enum-keys": [ - "Site", - "Function" - ] + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" } - }, - "required": [ - "domain", - "url", - "statusCode", - "resourceId", - "resourceType" - ] + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "web": "#\/definitions\/platformWeb", + "apple": "#\/definitions\/platformApple", + "android": "#\/definitions\/platformAndroid", + "windows": "#\/definitions\/platformWindows", + "linux": "#\/definitions\/platformLinux" + } + } } } + }, + "deprecated": false, + "x-appwrite": { + "method": "getPlatform", + "group": "platforms", + "weight": 1118, + "cookies": false, + "type": "", + "demo": "project\/get-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } ] - } - }, - "\/proxy\/rules\/site": { - "post": { - "summary": "Create site rule", - "operationId": "proxyCreateSiteRule", + }, + "delete": { + "summary": "Delete project platform", + "operationId": "projectDeletePlatform", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "proxy" + "project" ], - "description": "Create a new proxy rule for serving Appwrite Site on custom domain.", + "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", "responses": { - "201": { - "description": "Rule", - "schema": { - "$ref": "#\/definitions\/proxyRule" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createSiteRule", - "group": null, - "weight": 1076, + "method": "deletePlatform", + "group": "platforms", + "weight": 1107, "cookies": false, "type": "", - "demo": "proxy\/create-site-rule.md", - "rate-limit": 10, - "rate-time": 60, - "rate-key": "userId:{userId}, url:{url}", - "scope": "rules.write", + "demo": "project\/delete-platform.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47148,78 +48027,57 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "domain": { - "type": "string", - "description": "Domain name.", - "default": null, - "x-example": null - }, - "siteId": { - "type": "string", - "description": "ID of site to be executed.", - "default": null, - "x-example": "" - }, - "branch": { - "type": "string", - "description": "Name of VCS branch to deploy changes automatically", - "default": "", - "x-example": "" - } - }, - "required": [ - "domain", - "siteId" - ] - } + "name": "platformId", + "description": "Platform ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] } }, - "\/proxy\/rules\/{ruleId}": { + "\/project\/policies": { "get": { - "summary": "Get rule", - "operationId": "proxyGetRule", + "summary": "List project policies", + "operationId": "projectListPolicies", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "proxy" + "project" ], - "description": "Get a proxy rule by its unique ID.", + "description": "Get a list of all project policies and their current configuration.", "responses": { "200": { - "description": "Rule", + "description": "Policies List", "schema": { - "$ref": "#\/definitions\/proxyRule" + "$ref": "#\/definitions\/policyList" } } }, "deprecated": false, "x-appwrite": { - "method": "getRule", - "group": null, - "weight": 1079, + "method": "listPolicies", + "group": "policies", + "weight": 1125, "cookies": false, "type": "", - "demo": "proxy\/get-rule.md", + "demo": "project\/list-policies.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.read", + "scope": "policies.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47229,50 +48087,72 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - }, - "delete": { - "summary": "Delete rule", - "operationId": "proxyDeleteRule", + } + }, + "\/project\/policies\/membership-privacy": { + "patch": { + "summary": "Update membership privacy policy", + "operationId": "projectUpdateMembershipPrivacyPolicy", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "proxy" + "project" ], - "description": "Delete a proxy rule by its unique ID.", + "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteRule", - "group": null, - "weight": 1081, + "method": "updateMembershipPrivacyPolicy", + "group": "policies", + "weight": 1127, "cookies": false, "type": "", - "demo": "proxy\/delete-rule.md", + "demo": "project\/update-membership-privacy-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.write", + "scope": "policies.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47282,25 +48162,57 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "boolean", + "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", + "default": null, + "x-example": false + }, + "userEmail": { + "type": "boolean", + "description": "Set to true if you want make user email visible to all team members, or false to hide it.", + "default": null, + "x-example": false + }, + "userPhone": { + "type": "boolean", + "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", + "default": null, + "x-example": false + }, + "userName": { + "type": "boolean", + "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "default": null, + "x-example": false + }, + "userMFA": { + "type": "boolean", + "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "default": null, + "x-example": false + } + } + } } ] } }, - "\/proxy\/rules\/{ruleId}\/verification": { + "\/project\/policies\/password-dictionary": { "patch": { - "summary": "Update rule verification status", - "operationId": "proxyUpdateRuleVerification", + "summary": "Update password dictionary policy", + "operationId": "projectUpdatePasswordDictionaryPolicy", "consumes": [ "application\/json" ], @@ -47308,31 +48220,32 @@ "application\/json" ], "tags": [ - "proxy" + "project" ], - "description": "Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.", + "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", "responses": { "200": { - "description": "Rule", + "description": "Project", "schema": { - "$ref": "#\/definitions\/proxyRule" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRuleVerification", - "group": null, - "weight": 1082, + "method": "updatePasswordDictionaryPolicy", + "group": "policies", + "weight": 1128, "cookies": false, "type": "", - "demo": "proxy\/update-rule-verification.md", + "demo": "project\/update-password-dictionary-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "rules.write", + "scope": "policies.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47342,53 +48255,66 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "ruleId", - "description": "Rule ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] } }, - "\/sites": { - "get": { - "summary": "List sites", - "operationId": "sitesList", - "consumes": [], + "\/project\/policies\/password-history": { + "patch": { + "summary": "Update password history policy", + "operationId": "projectUpdatePasswordHistoryPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a list of all the project's sites. You can use the query params to filter your results.", + "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", "responses": { "200": { - "description": "Sites List", + "description": "Project", "schema": { - "$ref": "#\/definitions\/siteList" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "sites", - "weight": 491, + "method": "updatePasswordHistoryPolicy", + "group": "policies", + "weight": 1129, "cookies": false, "type": "", - "demo": "sites\/list.md", + "demo": "project\/update-password-history-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "policies.write", "platforms": [ "console", "server" @@ -47407,40 +48333,32 @@ ], "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: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } } ] - }, - "post": { - "summary": "Create site", - "operationId": "sitesCreate", + } + }, + "\/project\/policies\/password-personal-data": { + "patch": { + "summary": "Update password personal data policy", + "operationId": "projectUpdatePasswordPersonalDataPolicy", "consumes": [ "application\/json" ], @@ -47448,29 +48366,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a new site.", + "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", "responses": { - "201": { - "description": "Site", + "200": { + "description": "Project", "schema": { - "$ref": "#\/definitions\/site" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "sites", - "weight": 848, + "method": "updatePasswordPersonalDataPolicy", + "group": "policies", + "weight": 1130, "cookies": false, "type": "", - "demo": "sites\/create.md", + "demo": "project\/update-password-personal-data-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "policies.write", "platforms": [ "console", "server" @@ -47494,298 +48412,55 @@ "schema": { "type": "object", "properties": { - "siteId": { - "type": "string", - "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Site name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "framework": { - "type": "string", - "description": "Sites framework.", - "default": null, - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, "enabled": { "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "default": true, - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "default": true, + "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.", + "default": null, "x-example": false - }, - "timeout": { - "type": "integer", - "description": "Maximum request time in seconds.", - "default": 30, - "x-example": 1, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "Install Command.", - "default": "", - "x-example": "" - }, - "buildCommand": { - "type": "string", - "description": "Build Command.", - "default": "", - "x-example": "" - }, - "startCommand": { - "type": "string", - "description": "Custom start command. Leave empty to use default.", - "default": "", - "x-example": "" - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory for site.", - "default": "", - "x-example": "" - }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", - "default": null, - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dart-3.11", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "flutter-3.41" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "default": "", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "default": "", - "x-example": "" - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "default": "", - "x-example": "" - }, - "providerRepositoryId": { - "type": "string", - "description": "Repository ID of the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerBranch": { - "type": "string", - "description": "Production branch for the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", - "default": false, - "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "default": "", - "x-example": "" - }, - "buildSpecification": { - "type": "string", - "description": "Build specification for the site deployments.", - "default": {}, - "x-example": null - }, - "runtimeSpecification": { - "type": "string", - "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null - }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "default": 0, - "x-example": 0, - "format": "int32" } }, "required": [ - "siteId", - "name", - "framework", - "buildRuntime" + "enabled" ] } } ] } }, - "\/sites\/frameworks": { - "get": { - "summary": "List frameworks", - "operationId": "sitesListFrameworks", - "consumes": [], + "\/project\/policies\/session-alert": { + "patch": { + "summary": "Update session alert policy", + "operationId": "projectUpdateSessionAlertPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a list of all frameworks that are currently available on the server instance.", + "description": "Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.", "responses": { "200": { - "description": "Frameworks List", + "description": "Project", "schema": { - "$ref": "#\/definitions\/frameworkList" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "listFrameworks", - "group": "frameworks", - "weight": 494, + "method": "updateSessionAlertPolicy", + "group": "policies", + "weight": 1131, "cookies": false, "type": "", - "demo": "sites\/list-frameworks.md", + "demo": "project\/update-session-alert-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "policies.write", "platforms": [ "console", "server" @@ -47801,44 +48476,66 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } ] } }, - "\/sites\/specifications": { - "get": { - "summary": "List specifications", - "operationId": "sitesListSpecifications", - "consumes": [], + "\/project\/policies\/session-duration": { + "patch": { + "summary": "Update session duration policy", + "operationId": "projectUpdateSessionDurationPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "List allowed site specifications for this instance.", + "description": "Update maximum duration how long sessions created within a project should stay active for.", "responses": { "200": { - "description": "Specifications List", + "description": "Project", "schema": { - "$ref": "#\/definitions\/specificationList" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "listSpecifications", - "group": "frameworks", - "weight": 517, + "method": "updateSessionDurationPolicy", + "group": "policies", + "weight": 1132, "cookies": false, "type": "", - "demo": "sites\/list-specifications.md", + "demo": "project\/update-session-duration-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "policies.write", "platforms": [ - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47851,43 +48548,67 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "duration": { + "type": "integer", + "description": "Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.", + "default": null, + "x-example": 5, + "format": "int32" + } + }, + "required": [ + "duration" + ] + } + } ] } }, - "\/sites\/templates": { - "get": { - "summary": "List templates", - "operationId": "sitesListTemplates", - "consumes": [], + "\/project\/policies\/session-invalidation": { + "patch": { + "summary": "Update session invalidation policy", + "operationId": "projectUpdateSessionInvalidationPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "List available site templates. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.", + "description": "Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.", "responses": { "200": { - "description": "Site Templates List", + "description": "Project", "schema": { - "$ref": "#\/definitions\/templateSiteList" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "listTemplates", - "group": "templates", - "weight": 513, + "method": "updateSessionInvalidationPolicy", + "group": "policies", + "weight": 1133, "cookies": false, "type": "", - "demo": "sites\/list-templates.md", + "demo": "project\/update-session-invalidation-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "policies.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -47897,123 +48618,69 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "frameworks", - "description": "List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "default": [], - "in": "query" - }, - { - "name": "useCases", - "description": "List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "enum": [ - "portfolio", - "starter", - "events", - "ecommerce", - "documentation", - "blog", - "ai", - "forms", - "dashboard" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "default": [], - "in": "query" - }, - { - "name": "limit", - "description": "Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 1, - "default": 25, - "in": "query" - }, - { - "name": "offset", - "description": "Offset the list of returned templates. Maximum offset is 5000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] } }, - "\/sites\/templates\/{templateId}": { - "get": { - "summary": "Get site template", - "operationId": "sitesGetTemplate", - "consumes": [], + "\/project\/policies\/session-limit": { + "patch": { + "summary": "Update session limit policy", + "operationId": "projectUpdateSessionLimitPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a site template using ID. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.", + "description": "Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.", "responses": { "200": { - "description": "Template Site", + "description": "Project", "schema": { - "$ref": "#\/definitions\/templateSite" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getTemplate", - "group": "templates", - "weight": 514, + "method": "updateSessionLimitPolicy", + "group": "policies", + "weight": 1134, "cookies": false, "type": "", - "demo": "sites\/get-template.md", + "demo": "project\/update-session-limit-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "policies.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -48023,55 +48690,71 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "templateId", - "description": "Template ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } } ] } }, - "\/sites\/usage": { - "get": { - "summary": "Get sites usage", - "operationId": "sitesListUsage", - "consumes": [], + "\/project\/policies\/user-limit": { + "patch": { + "summary": "Update user limit policy", + "operationId": "projectUpdateUserLimitPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get usage metrics and statistics for all sites in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", + "description": "Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.", "responses": { "200": { - "description": "UsageSites", + "description": "Project", "schema": { - "$ref": "#\/definitions\/usageSites" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "listUsage", - "group": null, - "weight": 515, + "method": "updateUserLimitPolicy", + "group": "policies", + "weight": 1135, "cookies": false, "type": "", - "demo": "sites\/list-usage.md", + "demo": "project\/update-user-limit-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "policies.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -48081,65 +48764,108 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "range", - "description": "Date range.", - "required": false, - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } } ] } }, - "\/sites\/{siteId}": { + "\/project\/policies\/{policyId}": { "get": { - "summary": "Get site", - "operationId": "sitesGet", + "summary": "Get project policy", + "operationId": "projectGetPolicy", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a site by its unique ID.", + "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { "200": { - "description": "Site", + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy", "schema": { - "$ref": "#\/definitions\/site" + "x-oneOf": [ + { + "$ref": "#\/definitions\/policyPasswordDictionary" + }, + { + "$ref": "#\/definitions\/policyPasswordHistory" + }, + { + "$ref": "#\/definitions\/policyPasswordPersonalData" + }, + { + "$ref": "#\/definitions\/policySessionAlert" + }, + { + "$ref": "#\/definitions\/policySessionDuration" + }, + { + "$ref": "#\/definitions\/policySessionInvalidation" + }, + { + "$ref": "#\/definitions\/policySessionLimit" + }, + { + "$ref": "#\/definitions\/policyUserLimit" + }, + { + "$ref": "#\/definitions\/policyMembershipPrivacy" + } + ], + "x-discriminator": { + "propertyName": "$id", + "mapping": { + "password-dictionary": "#\/definitions\/policyPasswordDictionary", + "password-history": "#\/definitions\/policyPasswordHistory", + "password-personal-data": "#\/definitions\/policyPasswordPersonalData", + "session-alert": "#\/definitions\/policySessionAlert", + "session-duration": "#\/definitions\/policySessionDuration", + "session-invalidation": "#\/definitions\/policySessionInvalidation", + "session-limit": "#\/definitions\/policySessionLimit", + "user-limit": "#\/definitions\/policyUserLimit", + "membership-privacy": "#\/definitions\/policyMembershipPrivacy" + } + } } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "sites", - "weight": 490, + "method": "getPolicy", + "group": "policies", + "weight": 1126, "cookies": false, "type": "", - "demo": "sites\/get.md", + "demo": "project\/get-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "policies.read", "platforms": [ "console", "server" @@ -48158,18 +48884,33 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "policyId", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.", "required": true, "type": "string", - "x-example": "", + "x-example": "password-dictionary", + "enum": [ + "password-dictionary", + "password-history", + "password-personal-data", + "session-alert", + "session-duration", + "session-invalidation", + "session-limit", + "user-limit", + "membership-privacy" + ], + "x-enum-name": null, + "x-enum-keys": [], "in": "path" } ] - }, - "put": { - "summary": "Update site", - "operationId": "sitesUpdate", + } + }, + "\/project\/protocols\/{protocolId}": { + "patch": { + "summary": "Update project protocol", + "operationId": "projectUpdateProtocol", "consumes": [ "application\/json" ], @@ -48177,29 +48918,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Update site by its unique ID.", + "description": "Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project. ", "responses": { "200": { - "description": "Site", + "description": "Project", "schema": { - "$ref": "#\/definitions\/site" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "sites", - "weight": 849, + "method": "updateProtocol", + "group": null, + "weight": 1089, "cookies": false, "type": "", - "demo": "sites\/update.md", + "demo": "project\/update-protocol.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -48218,11 +48959,18 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "protocolId", + "description": "Protocol name. Can be one of: rest, graphql, websocket", "required": true, "type": "string", - "x-example": "", + "x-example": "rest", + "enum": [ + "rest", + "graphql", + "websocket" + ], + "x-enum-name": null, + "x-enum-keys": [], "in": "path" }, { @@ -48231,285 +48979,55 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Site name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "framework": { - "type": "string", - "description": "Sites framework.", - "default": null, - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, "enabled": { "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "default": true, - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "default": true, - "x-example": false - }, - "timeout": { - "type": "integer", - "description": "Maximum request time in seconds.", - "default": 30, - "x-example": 1, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "Install Command.", - "default": "", - "x-example": "" - }, - "buildCommand": { - "type": "string", - "description": "Build Command.", - "default": "", - "x-example": "" - }, - "startCommand": { - "type": "string", - "description": "Custom start command. Leave empty to use default.", - "default": "", - "x-example": "" - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory for site.", - "default": "", - "x-example": "" - }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", - "default": "", - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dart-3.11", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "flutter-3.41" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "default": "", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "default": "", - "x-example": "" - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "default": "", - "x-example": "" - }, - "providerRepositoryId": { - "type": "string", - "description": "Repository ID of the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerBranch": { - "type": "string", - "description": "Production branch for the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", - "default": false, + "description": "Protocol status.", + "default": null, "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "default": "", - "x-example": "" - }, - "buildSpecification": { - "type": "string", - "description": "Build specification for the site deployments.", - "default": {}, - "x-example": null - }, - "runtimeSpecification": { - "type": "string", - "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null - }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "default": 0, - "x-example": 0, - "format": "int32" } }, "required": [ - "name", - "framework" + "enabled" ] } } ] - }, - "delete": { - "summary": "Delete site", - "operationId": "sitesDelete", + } + }, + "\/project\/services\/{serviceId}": { + "patch": { + "summary": "Update project service", + "operationId": "projectUpdateService", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "sites" + "project" ], - "description": "Delete a site by its unique ID.", + "description": "Update properties of a specific service. Use this endpoint to enable or disable a service in your project. ", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "sites", - "weight": 493, + "method": "updateService", + "group": null, + "weight": 1090, "cookies": false, "type": "", - "demo": "sites\/delete.md", + "demo": "project\/update-service.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -48528,20 +49046,59 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "serviceId", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", "required": true, "type": "string", - "x-example": "", + "x-example": "account", + "enum": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging" + ], + "x-enum-name": null, + "x-enum-keys": [], "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Service status.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] } }, - "\/sites\/{siteId}\/deployment": { + "\/project\/smtp": { "patch": { - "summary": "Update site's deployment", - "operationId": "sitesUpdateSiteDeployment", + "summary": "Update project SMTP configuration", + "operationId": "projectUpdateSMTP", "consumes": [ "application\/json" ], @@ -48549,29 +49106,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.", "responses": { "200": { - "description": "Site", + "description": "Project", "schema": { - "$ref": "#\/definitions\/site" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSiteDeployment", - "group": "sites", - "weight": 500, + "method": "updateSMTP", + "group": "smtp", + "weight": 1091, "cookies": false, "type": "", - "demo": "sites\/update-site-deployment.md", + "demo": "project\/update-smtp.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -48589,259 +49146,126 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "deploymentId": { + "host": { "type": "string", - "description": "Deployment ID.", + "description": "SMTP server hostname (domain)", "default": null, - "x-example": "" - } - }, - "required": [ - "deploymentId" - ] - } - } - ] - } - }, - "\/sites\/{siteId}\/deployments": { - "get": { - "summary": "List deployments", - "operationId": "sitesListDeployments", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Deployments List", - "schema": { - "$ref": "#\/definitions\/deploymentList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listDeployments", - "group": "deployments", - "weight": 499, - "cookies": false, - "type": "", - "demo": "sites\/list-deployments.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } - ] - }, - "post": { - "summary": "Create deployment", - "operationId": "sitesCreateDeployment", - "consumes": [ - "multipart\/form-data" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.", - "responses": { - "202": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" + "x-example": null, + "x-nullable": true + }, + "port": { + "type": "integer", + "description": "SMTP server port", + "default": null, + "x-example": null, + "format": "int32", + "x-nullable": true + }, + "username": { + "type": "string", + "description": "SMTP server username. Leave empty for no authorization.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "password": { + "type": "string", + "description": "SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).", + "default": null, + "x-example": "", + "x-nullable": true + }, + "senderEmail": { + "type": "string", + "description": "Email address shown in inbox as the sender of the email.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "senderName": { + "type": "string", + "description": "Name shown in inbox as the sender of the email.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "replyToEmail": { + "type": "string", + "description": "Email used when user replies to the email.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToName": { + "type": "string", + "description": "Name used when user replies to the email.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secure": { + "type": "string", + "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", + "default": null, + "x-example": "tls", + "enum": [ + "tls", + "ssl" + ], + "x-enum-name": null, + "x-enum-keys": [], + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", + "default": null, + "x-example": false, + "x-nullable": true + } + } } } - }, - "deprecated": false, - "x-appwrite": { - "method": "createDeployment", - "group": "deployments", - "weight": 495, - "cookies": false, - "type": "upload", - "demo": "sites\/create-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": true, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "installCommand", - "description": "Install Commands.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "buildCommand", - "description": "Build Commands.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "outputDirectory", - "description": "Output Directory.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "code", - "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "required": true, - "type": "file", - "in": "formData" - }, - { - "name": "activate", - "description": "Automatically activate the deployment when it is finished building.", - "required": false, - "type": "boolean", - "x-example": false, - "default": false, - "in": "formData" - } ] } }, - "\/sites\/{siteId}\/deployments\/duplicate": { + "\/project\/smtp\/tests": { "post": { - "summary": "Create duplicate deployment", - "operationId": "sitesCreateDuplicateDeployment", + "summary": "Create project SMTP test", + "operationId": "projectCreateSMTPTest", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "sites" + "project" ], - "description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.", + "description": "Send a test email to verify SMTP configuration. ", "responses": { - "202": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createDuplicateDeployment", - "group": "deployments", - "weight": 503, + "method": "createSMTPTest", + "group": "smtp", + "weight": 1092, "cookies": false, "type": "", - "demo": "sites\/create-duplicate-deployment.md", + "demo": "project\/create-smtp-test.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -48859,69 +49283,62 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "deploymentId": { - "type": "string", - "description": "Deployment ID.", + "emails": { + "type": "array", + "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", "default": null, - "x-example": "" + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "deploymentId" + "emails" ] } } ] } }, - "\/sites\/{siteId}\/deployments\/template": { - "post": { - "summary": "Create template deployment", - "operationId": "sitesCreateTemplateDeployment", - "consumes": [ - "application\/json" - ], + "\/project\/templates\/email": { + "get": { + "summary": "List project email templates", + "operationId": "projectListEmailTemplates", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", + "description": "Get a list of all custom email templates configured for the project. This endpoint returns an array of all configured email templates and their locales.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "Email Templates List", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/emailTemplateList" } } }, "deprecated": false, "x-appwrite": { - "method": "createTemplateDeployment", - "group": "deployments", - "weight": 496, + "method": "listEmailTemplates", + "group": "templates", + "weight": 1093, "cookies": false, "type": "", - "demo": "sites\/create-template-deployment.md", + "demo": "project\/list-email-templates.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "templates.read", "platforms": [ "console", "server" @@ -48940,79 +49357,31 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "repository": { - "type": "string", - "description": "Repository name of the template.", - "default": null, - "x-example": "" - }, - "owner": { - "type": "string", - "description": "The name of the owner of the template.", - "default": null, - "x-example": "" - }, - "rootDirectory": { - "type": "string", - "description": "Path to site code in the template repo.", - "default": null, - "x-example": "" - }, - "type": { - "type": "string", - "description": "Type for the reference provided. Can be commit, branch, or tag", - "default": null, - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "TemplateReferenceType", - "x-enum-keys": [] - }, - "reference": { - "type": "string", - "description": "Reference value, can be a commit hash, branch name, or release tag", - "default": null, - "x-example": "" - }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "default": false, - "x-example": false - } - }, - "required": [ - "repository", - "owner", - "rootDirectory", - "type", - "reference" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/sites\/{siteId}\/deployments\/vcs": { - "post": { - "summary": "Create VCS deployment", - "operationId": "sitesCreateVcsDeployment", + }, + "patch": { + "summary": "Update project email template", + "operationId": "projectUpdateEmailTemplate", "consumes": [ "application\/json" ], @@ -49020,29 +49389,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", + "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "EmailTemplate", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/emailTemplate" } } }, "deprecated": false, "x-appwrite": { - "method": "createVcsDeployment", - "group": "deployments", - "weight": 497, + "method": "updateEmailTemplate", + "group": "templates", + "weight": 1095, "cookies": false, "type": "", - "demo": "sites\/create-vcs-deployment.md", + "demo": "project\/update-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "templates.write", "platforms": [ "console", "server" @@ -49060,150 +49429,255 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "type": { + "templateId": { "type": "string", - "description": "Type of reference passed. Allowed values are: branch, commit", + "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", "default": null, - "x-example": "branch", + "x-example": "verification", "enum": [ - "branch", - "commit", - "tag" + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" ], - "x-enum-name": "VCSReferenceType", + "x-enum-name": "EmailTemplateType", "x-enum-keys": [] }, - "reference": { + "locale": { "type": "string", - "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "default": null, - "x-example": "" - }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "default": false, - "x-example": false - } - }, - "required": [ - "type", - "reference" - ] - } - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}": { - "get": { - "summary": "Get deployment", - "operationId": "sitesGetDeployment", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a site deployment by its unique ID.", - "responses": { - "200": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getDeployment", - "group": "deployments", - "weight": 498, - "cookies": false, - "type": "", - "demo": "sites\/get-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", + "default": "", + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "EmailTemplateLocale", + "x-enum-keys": [] + }, + "subject": { + "type": "string", + "description": "Subject of the email template. Can be up to 255 characters.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "message": { + "type": "string", + "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "senderName": { + "type": "string", + "description": "Name of the email sender.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "senderEmail": { + "type": "string", + "description": "Email of the sender.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToEmail": { + "type": "string", + "description": "Reply to email.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToName": { + "type": "string", + "description": "Reply to name.", + "default": null, + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "templateId" + ] + } } ] - }, - "delete": { - "summary": "Delete deployment", - "operationId": "sitesDeleteDeployment", - "consumes": [ + } + }, + "\/project\/templates\/email\/{templateId}": { + "get": { + "summary": "Get project email template", + "operationId": "projectGetEmailTemplate", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "sites" + "project" ], - "description": "Delete a site deployment by its unique ID.", + "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "EmailTemplate", + "schema": { + "$ref": "#\/definitions\/emailTemplate" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDeployment", - "group": "deployments", - "weight": 501, + "method": "getEmailTemplate", + "group": "templates", + "weight": 1094, "cookies": false, "type": "", - "demo": "sites\/delete-deployment.md", + "demo": "project\/get-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "templates.read", "platforms": [ "console", "server" @@ -49222,210 +49696,290 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "templateId", + "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", "required": true, "type": "string", - "x-example": "", + "x-example": "verification", + "enum": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ], + "x-enum-name": "EmailTemplateType", + "x-enum-keys": [], "in": "path" }, { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, + "name": "locale", + "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "EmailTemplateLocale", + "x-enum-keys": [], + "default": "", + "in": "query" } ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { + "\/project\/usage": { "get": { - "summary": "Get deployment download", - "operationId": "sitesGetDeploymentDownload", + "summary": "Get project usage stats", + "operationId": "projectGetUsage", "consumes": [], "produces": [ - "*\/*" + "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.", "responses": { "200": { - "description": "File", + "description": "UsageProject", "schema": { - "type": "file" + "$ref": "#\/definitions\/usageProject" } } }, "deprecated": false, "x-appwrite": { - "method": "getDeploymentDownload", - "group": "deployments", - "weight": 502, + "method": "getUsage", + "group": null, + "weight": 682, "cookies": false, - "type": "location", - "demo": "sites\/get-deployment-download.md", + "type": "", + "demo": "project\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "projects.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "startDate", + "description": "Starting date for the usage", "required": true, "type": "string", - "x-example": "", - "in": "path" + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00", + "in": "query" }, { - "name": "deploymentId", - "description": "Deployment ID.", + "name": "endDate", + "description": "End date for the usage", "required": true, "type": "string", - "x-example": "", - "in": "path" + "format": "datetime", + "x-example": "2020-10-15T06:38:00.000+00:00", + "in": "query" }, { - "name": "type", - "description": "Deployment file to download. Can be: \"source\", \"output\".", + "name": "period", + "description": "Period used", "required": false, "type": "string", - "x-example": "source", + "x-example": "1h", "enum": [ - "source", - "output" + "1h", + "1d" ], - "x-enum-name": "DeploymentDownloadType", - "x-enum-keys": [], - "default": "source", + "x-enum-name": "ProjectUsageRange", + "x-enum-keys": [ + "One Hour", + "One Day" + ], + "default": "1d", "in": "query" } ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { - "patch": { - "summary": "Update deployment status", - "operationId": "sitesUpdateDeploymentStatus", - "consumes": [ - "application\/json" - ], + "\/project\/variables": { + "get": { + "summary": "List project variables", + "operationId": "projectListVariables", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", + "description": "Get a list of all project environment variables.", "responses": { "200": { - "description": "Deployment", + "description": "Variables List", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/variableList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDeploymentStatus", - "group": "deployments", - "weight": 504, + "method": "listVariables", + "group": "variables", + "weight": 1097, "cookies": false, "type": "", - "demo": "sites\/update-deployment-status.md", + "demo": "project\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/logs": { - "get": { - "summary": "List logs", - "operationId": "sitesListLogs", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a list of all site logs. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Executions List", - "schema": { - "$ref": "#\/definitions\/executionList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 506, - "cookies": false, - "type": "", - "demo": "sites\/list-logs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "project.read", "platforms": [ "console", "server" @@ -49443,17 +49997,9 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", + "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: key, resourceType, resourceId, secret", "required": false, "type": "array", "collectionFormat": "multi", @@ -49473,281 +50019,10 @@ "in": "query" } ] - } - }, - "\/sites\/{siteId}\/logs\/{logId}": { - "get": { - "summary": "Get log", - "operationId": "sitesGetLog", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a site request log by its unique ID.", - "responses": { - "200": { - "description": "Execution", - "schema": { - "$ref": "#\/definitions\/execution" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getLog", - "group": "logs", - "weight": 505, - "cookies": false, - "type": "", - "demo": "sites\/get-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete log", - "operationId": "sitesDeleteLog", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Delete a site log by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteLog", - "group": "logs", - "weight": 507, - "cookies": false, - "type": "", - "demo": "sites\/delete-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/usage": { - "get": { - "summary": "Get site usage", - "operationId": "sitesGetUsage", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get usage metrics and statistics for a for a specific site. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", - "responses": { - "200": { - "description": "UsageSite", - "schema": { - "$ref": "#\/definitions\/usageSite" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 516, - "cookies": false, - "type": "", - "demo": "sites\/get-usage.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "range", - "description": "Date range.", - "required": false, - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" - } - ] - } - }, - "\/sites\/{siteId}\/variables": { - "get": { - "summary": "List variables", - "operationId": "sitesListVariables", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a list of all variables of a specific site.", - "responses": { - "200": { - "description": "Variables List", - "schema": { - "$ref": "#\/definitions\/variableList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 510, - "cookies": false, - "type": "", - "demo": "sites\/list-variables.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] }, "post": { - "summary": "Create variable", - "operationId": "sitesCreateVariable", + "summary": "Create project variable", + "operationId": "projectCreateVariable", "consumes": [ "application\/json" ], @@ -49755,9 +50030,9 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", "responses": { "201": { "description": "Variable", @@ -49770,14 +50045,14 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 850, + "weight": 1096, "cookies": false, "type": "", - "demo": "sites\/create-variable.md", + "demo": "project\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -49795,20 +50070,18 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", @@ -49823,12 +50096,13 @@ }, "secret": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", "default": true, "x-example": false } }, "required": [ + "variableId", "key", "value" ] @@ -49837,18 +50111,18 @@ ] } }, - "\/sites\/{siteId}\/variables\/{variableId}": { + "\/project\/variables\/{variableId}": { "get": { - "summary": "Get variable", - "operationId": "sitesGetVariable", + "summary": "Get project variable", + "operationId": "projectGetVariable", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a variable by its unique ID.", + "description": "Get a variable by its unique ID. ", "responses": { "200": { "description": "Variable", @@ -49861,14 +50135,14 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 509, + "weight": 1098, "cookies": false, "type": "", - "demo": "sites\/get-variable.md", + "demo": "project\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "project.read", "platforms": [ "console", "server" @@ -49886,17 +50160,9 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "variableId", - "description": "Variable unique ID.", + "description": "Variable ID.", "required": true, "type": "string", "x-example": "", @@ -49905,8 +50171,8 @@ ] }, "put": { - "summary": "Update variable", - "operationId": "sitesUpdateVariable", + "summary": "Update project variable", + "operationId": "projectUpdateVariable", "consumes": [ "application\/json" ], @@ -49914,7 +50180,7 @@ "application\/json" ], "tags": [ - "sites" + "project" ], "description": "Update variable by its unique ID.", "responses": { @@ -49929,14 +50195,14 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 511, + "weight": 1100, "cookies": false, "type": "", - "demo": "sites\/update-variable.md", + "demo": "project\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -49954,17 +50220,9 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "variableId", - "description": "Variable unique ID.", + "description": "Variable ID.", "required": true, "type": "string", "x-example": "", @@ -49980,7 +50238,8 @@ "type": "string", "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, "value": { "type": "string", @@ -49991,30 +50250,27 @@ }, "secret": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", "default": null, "x-example": false, "x-nullable": true } - }, - "required": [ - "key" - ] + } } } ] }, "delete": { - "summary": "Delete variable", - "operationId": "sitesDeleteVariable", + "summary": "Delete project variable", + "operationId": "projectDeleteVariable", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "sites" + "project" ], - "description": "Delete a variable by its unique ID.", + "description": "Delete a variable by its unique ID. ", "responses": { "204": { "description": "No content" @@ -50024,14 +50280,14 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 512, + "weight": 1099, "cookies": false, "type": "", - "demo": "sites\/delete-variable.md", + "demo": "project\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "project.write", "platforms": [ "console", "server" @@ -50049,17 +50305,9 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "variableId", - "description": "Variable unique ID.", + "description": "Variable ID.", "required": true, "type": "string", "x-example": "", @@ -50068,59 +50316,56 @@ ] } }, - "\/storage\/buckets": { + "\/projects": { "get": { - "summary": "List buckets", - "operationId": "storageListBuckets", + "summary": "List projects", + "operationId": "projectsList", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", + "description": "Get a list of all projects. You can use the query params to filter your results. ", "responses": { "200": { - "description": "Buckets List", + "description": "Projects List", "schema": { - "$ref": "#\/definitions\/bucketList" + "$ref": "#\/definitions\/projectList" } } }, "deprecated": false, "x-appwrite": { - "method": "listBuckets", - "group": "buckets", - "weight": 558, + "method": "list", + "group": "projects", + "weight": 1085, "cookies": false, "type": "", - "demo": "storage\/list-buckets.md", + "demo": "projects\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "projects.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "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: name, teamId, labels, search", "required": false, "type": "array", "collectionFormat": "multi", @@ -50151,8 +50396,8 @@ ] }, "post": { - "summary": "Create bucket", - "operationId": "storageCreateBucket", + "summary": "Create project", + "operationId": "projectsCreate", "consumes": [ "application\/json" ], @@ -50160,44 +50405,42 @@ "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Create a new storage bucket.", + "description": "Create a new project. You can create a maximum of 100 projects per account. ", "responses": { "201": { - "description": "Bucket", + "description": "Project", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "createBucket", - "group": "buckets", - "weight": 556, + "method": "create", + "group": "projects", + "weight": 1083, "cookies": false, "type": "", - "demo": "storage\/create-bucket.md", + "demo": "projects\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "projects.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ @@ -50207,160 +50450,167 @@ "schema": { "type": "object", "properties": { - "bucketId": { + "projectId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "" + "x-example": null }, "name": { "type": "string", - "description": "Bucket name", + "description": "Project name. Max length: 128 chars.", "default": null, "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "teamId": { + "type": "string", + "description": "Team unique ID.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, - "x-example": false - }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "default": {}, - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } + "x-example": "" }, - "compression": { + "region": { "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", + "description": "Project Region.", + "default": "fra", + "x-example": "fra", "enum": [ - "none", - "gzip", - "zstd" + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" ], "x-enum-name": null, "x-enum-keys": [] }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, - "x-example": false + "description": { + "type": "string", + "description": "Project description. Max length: 256 chars.", + "default": "", + "x-example": "" }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, - "x-example": false + "logo": { + "type": "string", + "description": "Project logo.", + "default": "", + "x-example": "" }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "default": true, - "x-example": false + "url": { + "type": "string", + "description": "Project URL.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "legalName": { + "type": "string", + "description": "Project legal Name. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalCountry": { + "type": "string", + "description": "Project legal Country. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalState": { + "type": "string", + "description": "Project legal State. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalCity": { + "type": "string", + "description": "Project legal City. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalAddress": { + "type": "string", + "description": "Project legal Address. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "legalTaxId": { + "type": "string", + "description": "Project legal Tax ID. Max length: 256 chars.", + "default": "", + "x-example": "" } }, "required": [ - "bucketId", - "name" + "projectId", + "name", + "teamId" ] } } ] } }, - "\/storage\/buckets\/{bucketId}": { + "\/projects\/{projectId}": { "get": { - "summary": "Get bucket", - "operationId": "storageGetBucket", + "summary": "Get project", + "operationId": "projectsGet", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", + "description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ", "responses": { "200": { - "description": "Bucket", + "description": "Project", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getBucket", - "group": "buckets", - "weight": 557, + "method": "get", + "group": "projects", + "weight": 57, "cookies": false, "type": "", - "demo": "storage\/get-bucket.md", + "demo": "projects\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "projects.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "put": { - "summary": "Update bucket", - "operationId": "storageUpdateBucket", + "patch": { + "summary": "Update project", + "operationId": "projectsUpdate", "consumes": [ "application\/json" ], @@ -50368,53 +50618,51 @@ "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Update a storage bucket by its unique ID.", + "description": "Update a project by its unique ID.", "responses": { "200": { - "description": "Bucket", + "description": "Project", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "updateBucket", - "group": "buckets", - "weight": 559, + "method": "update", + "group": "projects", + "weight": 1084, "cookies": false, "type": "", - "demo": "storage\/update-bucket.md", + "demo": "projects\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "projects.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -50425,78 +50673,64 @@ "properties": { "name": { "type": "string", - "description": "Bucket name", + "description": "Project name. Max length: 128 chars.", "default": null, "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "description": { + "type": "string", + "description": "Project description. Max length: 256 chars.", + "default": "", + "x-example": "" }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false + "logo": { + "type": "string", + "description": "Project logo.", + "default": "", + "x-example": "" }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, - "x-example": false + "url": { + "type": "string", + "description": "Project URL.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "default": {}, - "x-example": 1, - "format": "int32" + "legalName": { + "type": "string", + "description": "Project legal name. Max length: 256 chars.", + "default": "", + "x-example": "" }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } + "legalCountry": { + "type": "string", + "description": "Project legal country. Max length: 256 chars.", + "default": "", + "x-example": "" }, - "compression": { + "legalState": { "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] + "description": "Project legal state. Max length: 256 chars.", + "default": "", + "x-example": "" }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, - "x-example": false + "legalCity": { + "type": "string", + "description": "Project legal city. Max length: 256 chars.", + "default": "", + "x-example": "" }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, - "x-example": false + "legalAddress": { + "type": "string", + "description": "Project legal address. Max length: 256 chars.", + "default": "", + "x-example": "" }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "default": true, - "x-example": false + "legalTaxId": { + "type": "string", + "description": "Project legal tax ID. Max length: 256 chars.", + "default": "", + "x-example": "" } }, "required": [ @@ -50505,18 +50739,22 @@ } } ] - }, - "delete": { - "summary": "Delete bucket", - "operationId": "storageDeleteBucket", + } + }, + "\/projects\/{projectId}\/console-access": { + "patch": { + "summary": "Record console access to a project", + "operationId": "projectsUpdateConsoleAccess", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "storage" + "projects" ], - "description": "Delete a storage bucket by its unique ID.", + "description": "Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.\n", "responses": { "204": { "description": "No content" @@ -50524,108 +50762,101 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteBucket", - "group": "buckets", - "weight": 560, + "method": "updateConsoleAccess", + "group": null, + "weight": 1080, "cookies": false, "type": "", - "demo": "storage\/delete-bucket.md", + "demo": "projects\/update-console-access.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "projects.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "projectId", + "description": "Project ID", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/storage\/buckets\/{bucketId}\/files": { + "\/projects\/{projectId}\/dev-keys": { "get": { - "summary": "List files", - "operationId": "storageListFiles", + "summary": "List dev keys", + "operationId": "projectsListDevKeys", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Get a list of all the user files. You can use the query params to filter your results.", + "description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'", "responses": { "200": { - "description": "Files List", + "description": "Dev Keys List", "schema": { - "$ref": "#\/definitions\/fileList" + "$ref": "#\/definitions\/devKeyList" } } }, "deprecated": false, "x-appwrite": { - "method": "listFiles", - "group": "files", - "weight": 563, + "method": "listDevKeys", + "group": "devKeys", + "weight": 404, "cookies": false, "type": "", - "demo": "storage\/list-files.md", + "demo": "projects\/list-dev-keys.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "devKeys.read", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "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: accessedAt, expire", "required": false, "type": "array", "collectionFormat": "multi", @@ -50634,192 +50865,162 @@ }, "default": [], "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" } ] }, "post": { - "summary": "Create file", - "operationId": "storageCreateFile", + "summary": "Create dev key", + "operationId": "projectsCreateDevKey", "consumes": [ - "multipart\/form-data" + "application\/json" ], "produces": [ "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.", "responses": { "201": { - "description": "File", + "description": "DevKey", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/devKey" } } }, "deprecated": false, "x-appwrite": { - "method": "createFile", - "group": "files", - "weight": 1073, + "method": "createDevKey", + "group": "devKeys", + "weight": 401, "cookies": false, - "type": "upload", - "demo": "storage\/create-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", - "scope": "files.write", + "type": "", + "demo": "projects\/create-dev-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "devKeys.write", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "required": true, - "x-upload-id": true, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "file", - "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "required": true, - "type": "file", - "in": "formData" - }, - { - "name": "permissions", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "x-example": "[\"read(\"any\")\"]", - "in": "formData" - } - ] - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "Get file", - "operationId": "storageGetFile", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "storage" - ], - "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", - "responses": { - "200": { - "description": "File", - "schema": { - "$ref": "#\/definitions\/file" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Key name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" + } + }, + "required": [ + "name", + "expire" + ] + } + } + ] + } + }, + "\/projects\/{projectId}\/dev-keys\/{keyId}": { + "get": { + "summary": "Get dev key", + "operationId": "projectsGetDevKey", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.", + "responses": { + "200": { + "description": "DevKey", + "schema": { + "$ref": "#\/definitions\/devKey" } } }, "deprecated": false, "x-appwrite": { - "method": "getFile", - "group": "files", - "weight": 562, + "method": "getDevKey", + "group": "devKeys", + "weight": 403, "cookies": false, "type": "", - "demo": "storage\/get-file.md", + "demo": "projects\/get-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "devKeys.read", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, "put": { - "summary": "Update file", - "operationId": "storageUpdateFile", + "summary": "Update dev key", + "operationId": "projectsUpdateDevKey", "consumes": [ "application\/json" ], @@ -50827,63 +51028,58 @@ "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", + "description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'", "responses": { "200": { - "description": "File", + "description": "DevKey", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/devKey" } } }, "deprecated": false, "x-appwrite": { - "method": "updateFile", - "group": "files", - "weight": 564, + "method": "updateDevKey", + "group": "devKeys", + "weight": 402, "cookies": false, "type": "", - "demo": "storage\/update-file.md", + "demo": "projects\/update-dev-key.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.write", + "scope": "devKeys.write", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -50894,36 +51090,37 @@ "properties": { "name": { "type": "string", - "description": "File name.", + "description": "Key name. Max length: 128 chars.", "default": null, "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "expire": { + "type": "string", + "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime" } - } + }, + "required": [ + "name", + "expire" + ] } } ] }, "delete": { - "summary": "Delete file", - "operationId": "storageDeleteFile", + "summary": "Delete dev key", + "operationId": "projectsDeleteDevKey", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "storage" + "projects" ], - "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.", "responses": { "204": { "description": "No content" @@ -50931,532 +51128,429 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteFile", - "group": "files", - "weight": 565, + "method": "deleteDevKey", + "group": "devKeys", + "weight": 405, "cookies": false, "type": "", - "demo": "storage\/delete-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "files.write", + "demo": "projects\/delete-dev-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "devKeys.write", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "keyId", + "description": "Key unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "\/projects\/{projectId}\/schedules": { "get": { - "summary": "Get file for download", - "operationId": "storageGetFileDownload", + "summary": "List schedules", + "operationId": "projectsListSchedules", "consumes": [], "produces": [ - "*\/*" + "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "description": "Get a list of all the project's schedules. You can use the query params to filter your results.", "responses": { "200": { - "description": "File", + "description": "Schedules List", "schema": { - "type": "file" + "$ref": "#\/definitions\/scheduleList" } } }, "deprecated": false, "x-appwrite": { - "method": "getFileDownload", - "group": "files", - "weight": 567, + "method": "listSchedules", + "group": "schedules", + "weight": 412, "cookies": false, - "type": "location", - "demo": "storage\/get-file-download.md", + "type": "", + "demo": "projects\/list-schedules.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "schedules.read", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-schedules.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "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: resourceType, resourceId, projectId, schedule, active, region", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create schedule", + "operationId": "projectsCreateSchedule", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Create a new schedule for a resource.", + "responses": { + "201": { + "description": "Schedule", + "schema": { + "$ref": "#\/definitions\/schedule" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSchedule", + "group": "schedules", + "weight": 1086, + "cookies": false, + "type": "", + "demo": "projects\/create-schedule.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "schedules.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-schedule.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type for the schedule. Possible values: function, execution, message, backup.", + "default": null, + "x-example": "function", + "enum": [ + "function", + "execution", + "message", + "backup" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "resourceId": { + "type": "string", + "description": "The resource ID to associate with this schedule.", + "default": null, + "x-example": "" + }, + "schedule": { + "type": "string", + "description": "Schedule CRON expression.", + "default": null, + "x-example": null + }, + "active": { + "type": "boolean", + "description": "Whether the schedule is active.", + "default": false, + "x-example": false + }, + "data": { + "type": "object", + "description": "Schedule data as a JSON string. Used to store resource-specific context needed for execution.", + "default": {}, + "x-example": "{}" + } + }, + "required": [ + "resourceType", + "resourceId", + "schedule" + ] + } } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { + "\/projects\/{projectId}\/schedules\/{scheduleId}": { "get": { - "summary": "Get file preview", - "operationId": "storageGetFilePreview", + "summary": "Get schedule", + "operationId": "projectsGetSchedule", "consumes": [], "produces": [ - "image\/*" + "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", + "description": "Get a schedule by its unique ID.", "responses": { "200": { - "description": "Image", + "description": "Schedule", "schema": { - "type": "file" + "$ref": "#\/definitions\/schedule" } } }, "deprecated": false, "x-appwrite": { - "method": "getFilePreview", - "group": "files", - "weight": 566, + "method": "getSchedule", + "group": "schedules", + "weight": 411, "cookies": false, - "type": "location", - "demo": "storage\/get-file-preview.md", + "type": "", + "demo": "projects\/get-schedule.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "schedules.read", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-schedule.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID", + "name": "scheduleId", + "description": "Schedule ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "width", - "description": "Resize preview image width, Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, + } + ] + } + }, + "\/projects\/{projectId}\/status": { + "patch": { + "summary": "Update the status of a project", + "operationId": "projectsUpdateStatus", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "projects" + ], + "description": "Update the status of a project. Can be used to archive\/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.\n", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateStatus", + "group": null, + "weight": 1081, + "cookies": false, + "type": "", + "demo": "projects\/update-status.md", + "rate-limit": 10, + "rate-time": 3600, + "rate-key": "ip:{ip},userId:{userId}", + "scope": "projects.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-status.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "height", - "description": "Resize preview image height, Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, + "Project": [] + } + ], + "parameters": [ { - "name": "gravity", - "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", - "required": false, + "name": "projectId", + "description": "Project ID", + "required": true, "type": "string", - "x-example": "center", - "enum": [ - "center", - "top-left", - "top", - "top-right", - "left", - "right", - "bottom-left", - "bottom", - "bottom-right" - ], - "x-enum-name": "ImageGravity", - "x-enum-keys": [], - "default": "center", - "in": "query" - }, - { - "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1, - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "borderWidth", - "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "borderColor", - "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", - "required": false, - "type": "string", - "default": "", - "in": "query" - }, - { - "name": "borderRadius", - "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "opacity", - "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", - "required": false, - "type": "number", - "format": "float", - "x-example": 0, - "default": 1, - "in": "query" - }, - { - "name": "rotation", - "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -360, - "default": 0, - "in": "query" - }, - { - "name": "background", - "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", - "required": false, - "type": "string", - "default": "", - "in": "query" - }, - { - "name": "output", - "description": "Output format type (jpeg, jpg, png, gif and webp).", - "required": false, - "type": "string", - "x-example": "jpg", - "enum": [ - "jpg", - "jpeg", - "png", - "webp", - "heic", - "avif", - "gif" - ], - "x-enum-name": "ImageFormat", - "x-enum-keys": [], - "default": "", - "in": "query" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - } - ] - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { - "get": { - "summary": "Get file for view", - "operationId": "storageGetFileView", - "consumes": [], - "produces": [ - "*\/*" - ], - "tags": [ - "storage" - ], - "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", - "responses": { - "200": { - "description": "File", + "name": "payload", + "in": "body", "schema": { - "type": "file" + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "New status for the project", + "default": null, + "x-example": "active", + "enum": [ + "active" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "status" + ] } } - }, - "deprecated": false, - "x-appwrite": { - "method": "getFileView", - "group": "files", - "weight": 568, - "cookies": false, - "type": "location", - "demo": "storage\/get-file-view.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", - "platforms": [ - "console", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - } ] } }, - "\/storage\/usage": { - "get": { - "summary": "Get storage usage stats", - "operationId": "storageGetUsage", - "consumes": [], - "produces": [ + "\/projects\/{projectId}\/team": { + "patch": { + "summary": "Update project team", + "operationId": "projectsUpdateTeam", + "consumes": [ "application\/json" ], - "tags": [ - "storage" - ], - "description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", - "responses": { - "200": { - "description": "StorageUsage", - "schema": { - "$ref": "#\/definitions\/usageStorage" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 570, - "cookies": false, - "type": "", - "demo": "storage\/get-usage.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "range", - "description": "Date range.", - "required": false, - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" - } - ] - } - }, - "\/storage\/{bucketId}\/usage": { - "get": { - "summary": "Get bucket usage stats", - "operationId": "storageGetBucketUsage", - "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "projects" ], - "description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", + "description": "Update the team ID of a project allowing for it to be transferred to another team.", "responses": { "200": { - "description": "UsageBuckets", + "description": "Project", "schema": { - "$ref": "#\/definitions\/usageBuckets" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getBucketUsage", - "group": null, - "weight": 571, + "method": "updateTeam", + "group": "projects", + "weight": 1082, "cookies": false, "type": "", - "demo": "storage\/get-bucket-usage.md", + "demo": "projects\/update-team.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "projects.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md", "auth": { "Project": [] } @@ -51468,89 +51562,84 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Bucket ID.", + "name": "projectId", + "description": "Project unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "range", - "description": "Date range.", - "required": false, - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team ID of the team to transfer project to.", + "default": null, + "x-example": "" + } + }, + "required": [ + "teamId" + ] + } } ] } }, - "\/tablesdb": { + "\/proxy\/rules": { "get": { - "summary": "List databases", - "operationId": "tablesDBList", + "summary": "List rules", + "operationId": "proxyListRules", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "proxy" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "Get a list of all the proxy rules. You can use the query params to filter your results.", "responses": { "200": { - "description": "Databases List", + "description": "Rule List", "schema": { - "$ref": "#\/definitions\/databaseList" + "$ref": "#\/definitions\/proxyRuleList" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "tablesdb", - "weight": 709, + "method": "listRules", + "group": null, + "weight": 1193, "cookies": false, "type": "", - "demo": "tablesdb\/list.md", + "demo": "proxy\/list-rules.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "rules.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "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 columns: name", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch", "required": false, "type": "array", "collectionFormat": "multi", @@ -51579,10 +51668,12 @@ "in": "query" } ] - }, + } + }, + "\/proxy\/rules\/api": { "post": { - "summary": "Create database", - "operationId": "tablesDBCreate", + "summary": "Create API rule", + "operationId": "proxyCreateAPIRule", "consumes": [ "application\/json" ], @@ -51590,44 +51681,41 @@ "application\/json" ], "tags": [ - "tablesDB" + "proxy" ], - "description": "Create a new Database.\n", + "description": "Create a new proxy rule for serving Appwrite's API on custom domain.", "responses": { "201": { - "description": "Database", + "description": "Rule", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/proxyRule" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "tablesdb", - "weight": 705, + "method": "createAPIRule", + "group": null, + "weight": 1188, "cookies": false, "type": "", - "demo": "tablesdb\/create.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "demo": "proxy\/create-api-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ @@ -51637,106 +51725,108 @@ "schema": { "type": "object", "properties": { - "databaseId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { + "domain": { "type": "string", - "description": "Database name. Max length: 128 chars.", + "description": "Domain name.", "default": null, - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "default": true, - "x-example": false + "x-example": null } }, "required": [ - "databaseId", - "name" + "domain" ] } } ] } }, - "\/tablesdb\/transactions": { - "get": { - "summary": "List transactions", - "operationId": "tablesDBListTransactions", - "consumes": [], + "\/proxy\/rules\/function": { + "post": { + "summary": "Create function rule", + "operationId": "proxyCreateFunctionRule", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "proxy" ], - "description": "List transactions across all databases.", + "description": "Create a new proxy rule for executing Appwrite Function on custom domain.", "responses": { - "200": { - "description": "Transaction List", + "201": { + "description": "Rule", "schema": { - "$ref": "#\/definitions\/transactionList" + "$ref": "#\/definitions\/proxyRule" } } }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 776, + "method": "createFunctionRule", + "group": null, + "weight": 1190, "cookies": false, "type": "", - "demo": "tablesdb\/list-transactions.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "demo": "proxy\/create-function-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", "platforms": [ - "console", - "server", - "client" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "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).", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "default": null, + "x-example": null + }, + "functionId": { + "type": "string", + "description": "ID of function to be executed.", + "default": null, + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "default": "", + "x-example": "" + } + }, + "required": [ + "domain", + "functionId" + ] + } } ] - }, + } + }, + "\/proxy\/rules\/redirect": { "post": { - "summary": "Create transaction", - "operationId": "tablesDBCreateTransaction", + "summary": "Create Redirect rule", + "operationId": "proxyCreateRedirectRule", "consumes": [ "application\/json" ], @@ -51744,49 +51834,41 @@ "application\/json" ], "tags": [ - "tablesDB" + "proxy" ], - "description": "Create a new transaction.", + "description": "Create a new proxy rule for to redirect from custom domain to another domain.", "responses": { "201": { - "description": "Transaction", + "description": "Rule", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/proxyRule" } } }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 772, + "method": "createRedirectRule", + "group": null, + "weight": 1191, "cookies": false, "type": "", - "demo": "tablesdb\/create-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "demo": "proxy\/create-redirect-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", "platforms": [ - "console", - "server", - "client" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ @@ -51796,182 +51878,223 @@ "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "default": 300, - "x-example": 60, - "format": "int32" + "domain": { + "type": "string", + "description": "Domain name.", + "default": null, + "x-example": null + }, + "url": { + "type": "string", + "description": "Target URL of redirection", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url" + }, + "statusCode": { + "type": "string", + "description": "Status code of redirection", + "default": null, + "x-example": "301", + "enum": [ + "301", + "302", + "307", + "308" + ], + "x-enum-name": null, + "x-enum-keys": [ + "Moved Permanently 301", + "Found 302", + "Temporary Redirect 307", + "Permanent Redirect 308" + ] + }, + "resourceId": { + "type": "string", + "description": "ID of parent resource.", + "default": null, + "x-example": "" + }, + "resourceType": { + "type": "string", + "description": "Type of parent resource.", + "default": null, + "x-example": "site", + "enum": [ + "site", + "function" + ], + "x-enum-name": "ProxyResourceType", + "x-enum-keys": [ + "Site", + "Function" + ] } - } + }, + "required": [ + "domain", + "url", + "statusCode", + "resourceId", + "resourceType" + ] } } ] } }, - "\/tablesdb\/transactions\/{transactionId}": { - "get": { - "summary": "Get transaction", - "operationId": "tablesDBGetTransaction", - "consumes": [], + "\/proxy\/rules\/site": { + "post": { + "summary": "Create site rule", + "operationId": "proxyCreateSiteRule", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "proxy" ], - "description": "Get a transaction by its unique ID.", + "description": "Create a new proxy rule for serving Appwrite Site on custom domain.", "responses": { - "200": { - "description": "Transaction", + "201": { + "description": "Rule", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/proxyRule" } } }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 773, + "method": "createSiteRule", + "group": null, + "weight": 1189, "cookies": false, "type": "", - "demo": "tablesdb\/get-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "demo": "proxy\/create-site-rule.md", + "rate-limit": 10, + "rate-time": 60, + "rate-key": "userId:{userId}, url:{url}", + "scope": "rules.write", "platforms": [ - "console", - "server", - "client" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name.", + "default": null, + "x-example": null + }, + "siteId": { + "type": "string", + "description": "ID of site to be executed.", + "default": null, + "x-example": "" + }, + "branch": { + "type": "string", + "description": "Name of VCS branch to deploy changes automatically", + "default": "", + "x-example": "" + } + }, + "required": [ + "domain", + "siteId" + ] + } } ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "tablesDBUpdateTransaction", - "consumes": [ - "application\/json" - ], + } + }, + "\/proxy\/rules\/{ruleId}": { + "get": { + "summary": "Get rule", + "operationId": "proxyGetRule", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "proxy" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Get a proxy rule by its unique ID.", "responses": { "200": { - "description": "Transaction", + "description": "Rule", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/proxyRule" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 774, + "method": "getRule", + "group": null, + "weight": 1192, "cookies": false, "type": "", - "demo": "tablesdb\/update-transaction.md", + "demo": "proxy\/get-rule.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "rules.read", "platforms": [ - "console", - "server", - "client" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "ruleId", + "description": "Rule ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false - } - } - } } ] }, "delete": { - "summary": "Delete transaction", - "operationId": "tablesDBDeleteTransaction", + "summary": "Delete rule", + "operationId": "proxyDeleteRule", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "tablesDB" + "proxy" ], - "description": "Delete a transaction by its unique ID.", + "description": "Delete a proxy rule by its unique ID.", "responses": { "204": { "description": "No content" @@ -51979,54 +52102,46 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 775, + "method": "deleteRule", + "group": null, + "weight": 1194, "cookies": false, "type": "", - "demo": "tablesdb\/delete-transaction.md", + "demo": "proxy\/delete-rule.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "rules.write", "platforms": [ - "console", - "server", - "client" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "ruleId", + "description": "Rule ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/tablesdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "tablesDBCreateOperations", + "\/proxy\/rules\/{ruleId}\/verification": { + "patch": { + "summary": "Update rule verification status", + "operationId": "proxyUpdateRuleVerification", "consumes": [ "application\/json" ], @@ -52034,217 +52149,175 @@ "application\/json" ], "tags": [ - "tablesDB" + "proxy" ], - "description": "Create multiple operations in a single transaction.", + "description": "Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "Rule", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/proxyRule" } } }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 777, + "method": "updateRuleVerification", + "group": null, + "weight": 1195, "cookies": false, "type": "", - "demo": "tablesdb\/create-operations.md", + "demo": "proxy\/update-rule-verification.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "rules.write", "platforms": [ - "console", - "server", - "client" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "ruleId", + "description": "Rule ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } - } - } - } } ] } }, - "\/tablesdb\/usage": { + "\/sites": { "get": { - "summary": "Get TablesDB usage stats", - "operationId": "tablesDBListUsage", + "summary": "List sites", + "operationId": "sitesList", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Get a list of all the project's sites. You can use the query params to filter your results.", "responses": { "200": { - "description": "UsageDatabases", + "description": "Sites List", "schema": { - "$ref": "#\/definitions\/usageDatabases" + "$ref": "#\/definitions\/siteList" } } }, "deprecated": false, "x-appwrite": { - "method": "listUsage", - "group": null, - "weight": 711, + "method": "list", + "group": "sites", + "weight": 470, "cookies": false, "type": "", - "demo": "tablesdb\/list-usage.md", + "demo": "sites\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "sites.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md", - "methods": [ - { - "name": "listUsage", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "range" - ], - "required": [], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/usageDatabases" - } - ], - "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", - "demo": "tablesdb\/list-usage.md", - "public": true - } - ], "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "range", - "description": "Date range.", + "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: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", "required": false, "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}": { - "get": { - "summary": "Get database", - "operationId": "tablesDBGet", - "consumes": [], + }, + "post": { + "summary": "Create site", + "operationId": "sitesCreate", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "description": "Create a new site.", "responses": { - "200": { - "description": "Database", + "201": { + "description": "Site", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "tablesdb", - "weight": 706, + "method": "create", + "group": "sites", + "weight": 903, "cookies": false, "type": "", - "demo": "tablesdb\/get.md", + "demo": "sites\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [] } @@ -52257,55 +52330,310 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "put": { - "summary": "Update database", - "operationId": "tablesDBUpdate", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tablesDB" - ], - "description": "Update a database by its unique ID.", - "responses": { - "200": { - "description": "Database", + "name": "payload", + "in": "body", "schema": { - "$ref": "#\/definitions\/database" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "update", - "group": "tablesdb", - "weight": 707, + "type": "object", + "properties": { + "siteId": { + "type": "string", + "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Site name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "framework": { + "type": "string", + "description": "Sites framework.", + "default": null, + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "enabled": { + "type": "boolean", + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "default": true, + "x-example": false + }, + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "default": 30, + "x-example": 1, + "format": "int32" + }, + "installCommand": { + "type": "string", + "description": "Install Command.", + "default": "", + "x-example": "" + }, + "buildCommand": { + "type": "string", + "description": "Build Command.", + "default": "", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "default": "", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "default": null, + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { + "type": "string", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "default": "", + "x-example": "static", + "enum": [ + "static", + "ssr" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "default": "", + "x-example": "" + }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "default": "", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerSilentMode": { + "type": "boolean", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", + "default": false, + "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "default": "", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "default": {}, + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" + } + }, + "required": [ + "siteId", + "name", + "framework", + "buildRuntime" + ] + } + } + ] + } + }, + "\/sites\/frameworks": { + "get": { + "summary": "List frameworks", + "operationId": "sitesListFrameworks", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "Get a list of all frameworks that are currently available on the server instance.", + "responses": { + "200": { + "description": "Frameworks List", + "schema": { + "$ref": "#\/definitions\/frameworkList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listFrameworks", + "group": "frameworks", + "weight": 473, "cookies": false, "type": "", - "demo": "tablesdb\/update.md", + "demo": "sites\/list-frameworks.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "public", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [] } @@ -52315,74 +52643,47 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "default": true, - "x-example": false - } - } - } - } ] - }, - "delete": { - "summary": "Delete database", - "operationId": "tablesDBDelete", - "consumes": [ + } + }, + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "tablesDB" + "sites" ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "description": "List allowed site specifications for this instance.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Specifications List", + "schema": { + "$ref": "#\/definitions\/specificationList" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "tablesdb", - "weight": 708, + "method": "listSpecifications", + "group": "frameworks", + "weight": 496, "cookies": false, "type": "", - "demo": "tablesdb\/delete.md", + "demo": "sites\/list-specifications.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "sites.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [] } @@ -52392,284 +52693,301 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } ] } }, - "\/tablesdb\/{databaseId}\/tables": { + "\/sites\/templates": { "get": { - "summary": "List tables", - "operationId": "tablesDBListTables", + "summary": "List templates", + "operationId": "sitesListTemplates", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "description": "List available site templates. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.", "responses": { "200": { - "description": "Tables List", + "description": "Site Templates List", "schema": { - "$ref": "#\/definitions\/tableList" + "$ref": "#\/definitions\/templateSiteList" } } }, "deprecated": false, "x-appwrite": { - "method": "listTables", - "group": "tables", - "weight": 716, + "method": "listTemplates", + "group": "templates", + "weight": 492, "cookies": false, "type": "", - "demo": "tablesdb\/list-tables.md", + "demo": "sites\/list-templates.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "public", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "frameworks", + "description": "List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "default": [], + "in": "query" }, { - "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 columns: name, enabled, rowSecurity", + "name": "useCases", + "description": "List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.", "required": false, "type": "array", "collectionFormat": "multi", "items": { - "type": "string" + "type": "string", + "enum": [ + "portfolio", + "starter", + "events", + "ecommerce", + "documentation", + "blog", + "ai", + "forms", + "dashboard" + ], + "x-enum-name": null, + "x-enum-keys": [] }, "default": [], "in": "query" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", + "name": "limit", + "description": "Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.", "required": false, - "type": "string", - "x-example": "", - "default": "", + "type": "integer", + "format": "int32", + "x-example": 1, + "default": 25, "in": "query" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "name": "offset", + "description": "Offset the list of returned templates. Maximum offset is 5000.", "required": false, - "type": "boolean", - "x-example": false, - "default": true, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, "in": "query" } ] - }, - "post": { - "summary": "Create table", - "operationId": "tablesDBCreateTable", - "consumes": [ - "application\/json" - ], + } + }, + "\/sites\/templates\/{templateId}": { + "get": { + "summary": "Get site template", + "operationId": "sitesGetTemplate", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Get a site template using ID. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.", "responses": { - "201": { - "description": "Table", + "200": { + "description": "Template Site", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/templateSite" } } }, "deprecated": false, "x-appwrite": { - "method": "createTable", - "group": "tables", - "weight": 712, + "method": "getTemplate", + "group": "templates", + "weight": 493, "cookies": false, "type": "", - "demo": "tablesdb\/create-table.md", + "demo": "sites\/get-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "public", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "templateId", + "description": "Template ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", + } + ] + } + }, + "\/sites\/usage": { + "get": { + "summary": "Get sites usage", + "operationId": "sitesListUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "Get usage metrics and statistics for all sites in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", + "responses": { + "200": { + "description": "UsageSites", "schema": { - "type": "object", - "properties": { - "tableId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "rowSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", - "default": true, - "x-example": false - }, - "columns": { - "type": "array", - "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, - "indexes": { - "type": "array", - "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - } - }, - "required": [ - "tableId", - "name" - ] + "$ref": "#\/definitions\/usageSites" } } + }, + "deprecated": false, + "x-appwrite": { + "method": "listUsage", + "group": null, + "weight": 494, + "cookies": false, + "type": "", + "demo": "sites\/list-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "range", + "description": "Date range.", + "required": false, + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" + } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "\/sites\/{siteId}": { "get": { - "summary": "Get table", - "operationId": "tablesDBGetTable", + "summary": "Get site", + "operationId": "sitesGet", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "description": "Get a site by its unique ID.", "responses": { "200": { - "description": "Table", + "description": "Site", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "getTable", - "group": "tables", - "weight": 713, + "method": "get", + "group": "sites", + "weight": 469, "cookies": false, "type": "", - "demo": "tablesdb\/get-table.md", + "demo": "sites\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [] } @@ -52682,26 +53000,18 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, "put": { - "summary": "Update table", - "operationId": "tablesDBUpdateTable", + "summary": "Update site", + "operationId": "sitesUpdate", "consumes": [ "application\/json" ], @@ -52709,39 +53019,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a table by its unique ID.", + "description": "Update site by its unique ID.", "responses": { "200": { - "description": "Table", + "description": "Site", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTable", - "group": "tables", - "weight": 714, + "method": "update", + "group": "sites", + "weight": 904, "cookies": false, "type": "", - "demo": "tablesdb\/update-table.md", + "demo": "sites\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [] } @@ -52754,19 +53060,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -52777,54 +53075,267 @@ "properties": { "name": { "type": "string", - "description": "Table name. Max length: 128 chars.", + "description": "Site name. Max length: 128 chars.", "default": null, "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "framework": { + "type": "string", + "description": "Sites framework.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] }, - "rowSecurity": { + "enabled": { "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", + "default": true, "x-example": false }, - "enabled": { + "logging": { "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", "default": true, "x-example": false }, - "purge": { + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "default": 30, + "x-example": 1, + "format": "int32" + }, + "installCommand": { + "type": "string", + "description": "Install Command.", + "default": "", + "x-example": "" + }, + "buildCommand": { + "type": "string", + "description": "Build Command.", + "default": "", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "default": "", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "default": "", + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { + "type": "string", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "default": "", + "x-example": "static", + "enum": [ + "static", + "ssr" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "default": "", + "x-example": "" + }, + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "default": "", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerSilentMode": { "type": "boolean", - "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", "default": false, "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "default": "", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "default": {}, + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } - } + }, + "required": [ + "name", + "framework" + ] } } ] }, "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + "summary": "Delete site", + "operationId": "sitesDelete", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "tablesDB" + "sites" ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Delete a site by its unique ID.", "responses": { "204": { "description": "No content" @@ -52832,26 +53343,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 715, + "method": "delete", + "group": "sites", + "weight": 472, "cookies": false, "type": "", - "demo": "tablesdb\/delete-table.md", + "demo": "sites\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [] } @@ -52864,66 +53371,56 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", - "consumes": [], + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "List columns in the table.", + "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", "responses": { "200": { - "description": "Columns List", + "description": "Site", "schema": { - "$ref": "#\/definitions\/columnList" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "listColumns", - "group": "columns", - "weight": 721, + "method": "updateSiteDeployment", + "group": "sites", + "weight": 479, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "sites\/update-site-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [] } @@ -52936,24 +53433,94 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, + "\/sites\/{siteId}\/deployments": { + "get": { + "summary": "List deployments", + "operationId": "sitesListDeployments", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Deployments List", + "schema": { + "$ref": "#\/definitions\/deploymentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDeployments", + "group": "deployments", + "weight": 478, + "cookies": false, + "type": "", + "demo": "sites\/list-deployments.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", "required": false, "type": "array", "collectionFormat": "multi", @@ -52963,6 +53530,15 @@ "default": [], "in": "query" }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -52973,52 +53549,46 @@ "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + }, "post": { - "summary": "Create boolean column", - "operationId": "tablesDBCreateBooleanColumn", + "summary": "Create deployment", + "operationId": "sitesCreateDeployment", "consumes": [ - "application\/json" + "multipart\/form-data" ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a boolean column.\n", + "description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.", "responses": { "202": { - "description": "ColumnBoolean", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnBoolean" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "createBooleanColumn", - "group": "columns", - "weight": 722, + "method": "createDeployment", + "group": "deployments", + "weight": 474, "cookies": false, - "type": "", - "demo": "tablesdb\/create-boolean-column.md", + "type": "upload", + "demo": "sites\/create-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], - "packaging": false, + "packaging": true, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [] } @@ -53031,66 +53601,60 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "installCommand", + "description": "Install Commands.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "in": "formData" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": false, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } + "name": "buildCommand", + "description": "Build Commands.", + "required": false, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "outputDirectory", + "description": "Output Directory.", + "required": false, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "code", + "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", + "required": true, + "type": "file", + "in": "formData" + }, + { + "name": "activate", + "description": "Automatically activate the deployment when it is finished building.", + "required": false, + "type": "boolean", + "x-example": false, + "default": false, + "in": "formData" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { - "patch": { - "summary": "Update boolean column", - "operationId": "tablesDBUpdateBooleanColumn", + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", "consumes": [ "application\/json" ], @@ -53098,39 +53662,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.", "responses": { - "200": { - "description": "ColumnBoolean", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnBoolean" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "updateBooleanColumn", - "group": "columns", - "weight": 723, + "method": "createDuplicateDeployment", + "group": "deployments", + "weight": 482, "cookies": false, "type": "", - "demo": "tablesdb\/update-boolean-column.md", + "demo": "sites\/create-duplicate-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [] } @@ -53143,26 +53703,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -53171,40 +53716,25 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": false, - "x-nullable": true - }, - "newKey": { + "deploymentId": { "type": "string", - "description": "New Column Key.", + "description": "Deployment ID.", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "" } }, "required": [ - "required", - "default" + "deploymentId" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "\/sites\/{siteId}\/deployments\/template": { "post": { - "summary": "Create datetime column", - "operationId": "tablesDBCreateDatetimeColumn", + "summary": "Create template deployment", + "operationId": "sitesCreateTemplateDeployment", "consumes": [ "application\/json" ], @@ -53212,39 +53742,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a date time column according to the ISO 8601 standard.", + "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", "responses": { "202": { - "description": "ColumnDatetime", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnDatetime" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "createDatetimeColumn", - "group": "columns", - "weight": 724, + "method": "createTemplateDeployment", + "group": "deployments", + "weight": 475, "cookies": false, "type": "", - "demo": "tablesdb\/create-datetime-column.md", + "demo": "sites\/create-template-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [] } @@ -53257,19 +53783,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -53278,46 +53796,66 @@ "schema": { "type": "object", "properties": { - "key": { + "repository": { "type": "string", - "description": "Column Key.", + "description": "Repository name of the template.", "default": null, - "x-example": null + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", + "owner": { + "type": "string", + "description": "The name of the owner of the template.", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "rootDirectory": { "type": "string", - "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "description": "Path to site code in the template repo.", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true + "x-example": "" }, - "array": { + "type": { + "type": "string", + "description": "Type for the reference provided. Can be commit, branch, or tag", + "default": null, + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [] + }, + "reference": { + "type": "string", + "description": "Reference value, can be a commit hash, branch name, or release tag", + "default": null, + "x-example": "" + }, + "activate": { "type": "boolean", - "description": "Is column an array?", + "description": "Automatically activate the deployment when it is finished building.", "default": false, "x-example": false } }, "required": [ - "key", - "required" + "repository", + "owner", + "rootDirectory", + "type", + "reference" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { - "patch": { - "summary": "Update dateTime column", - "operationId": "tablesDBUpdateDatetimeColumn", + "\/sites\/{siteId}\/deployments\/vcs": { + "post": { + "summary": "Create VCS deployment", + "operationId": "sitesCreateVcsDeployment", "consumes": [ "application\/json" ], @@ -53325,39 +53863,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", "responses": { - "200": { - "description": "ColumnDatetime", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnDatetime" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDatetimeColumn", - "group": "columns", - "weight": 725, + "method": "createVcsDeployment", + "group": "deployments", + "weight": 476, "cookies": false, "type": "", - "demo": "tablesdb\/update-datetime-column.md", + "demo": "sites\/create-vcs-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [] } @@ -53370,26 +53904,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -53398,81 +53917,79 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { + "type": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Type of reference passed. Allowed values are: branch, commit", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [] }, - "newKey": { + "reference": { "type": "string", - "description": "New Column Key.", + "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "" + }, + "activate": { + "type": "boolean", + "description": "Automatically activate the deployment when it is finished building.", + "default": false, + "x-example": false } }, "required": [ - "required", - "default" + "type", + "reference" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { - "post": { - "summary": "Create email column", - "operationId": "tablesDBCreateEmailColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/deployments\/{deploymentId}": { + "get": { + "summary": "Get deployment", + "operationId": "sitesGetDeployment", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create an email column.\n", + "description": "Get a site deployment by its unique ID.", "responses": { - "202": { - "description": "ColumnEmail", + "200": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnEmail" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "createEmailColumn", - "group": "columns", - "weight": 726, + "method": "getDeployment", + "group": "deployments", + "weight": 477, "cookies": false, "type": "", - "demo": "tablesdb\/create-email-column.md", + "demo": "sites\/get-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [] } @@ -53485,107 +54002,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { - "patch": { - "summary": "Update email column", - "operationId": "tablesDBUpdateEmailColumn", + }, + "delete": { + "summary": "Delete deployment", + "operationId": "sitesDeleteDeployment", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "sites" ], - "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "description": "Delete a site deployment by its unique ID.", "responses": { - "200": { - "description": "ColumnEmail", - "schema": { - "$ref": "#\/definitions\/columnEmail" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateEmailColumn", - "group": "columns", - "weight": 727, + "method": "deleteDeployment", + "group": "deployments", + "weight": 480, "cookies": false, "type": "", - "demo": "tablesdb\/update-email-column.md", + "demo": "sites\/delete-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [] } @@ -53598,109 +54065,62 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { - "post": { - "summary": "Create enum column", - "operationId": "tablesDBCreateEnumColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { + "get": { + "summary": "Get deployment download", + "operationId": "sitesGetDeploymentDownload", + "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "responses": { - "202": { - "description": "ColumnEnum", + "200": { + "description": "File", "schema": { - "$ref": "#\/definitions\/columnEnum" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "createEnumColumn", - "group": "columns", - "weight": 728, + "method": "getDeploymentDownload", + "group": "deployments", + "weight": 481, "cookies": false, - "type": "", - "demo": "tablesdb\/create-enum-column.md", + "type": "location", + "demo": "sites\/get-deployment-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [] } @@ -53708,81 +54128,49 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "elements": { - "type": "array", - "description": "Array of enum values.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "elements", - "required" - ] - } + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { "patch": { - "summary": "Update enum column", - "operationId": "tablesDBUpdateEnumColumn", + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", "consumes": [ "application\/json" ], @@ -53790,39 +54178,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", "responses": { "200": { - "description": "ColumnEnum", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnEnum" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEnumColumn", - "group": "columns", - "weight": 729, + "method": "updateDeploymentStatus", + "group": "deployments", + "weight": 483, "cookies": false, "type": "", - "demo": "tablesdb\/update-enum-column.md", + "demo": "sites\/update-deployment-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [] } @@ -53835,118 +54219,143 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, + } + ] + } + }, + "\/sites\/{siteId}\/logs": { + "get": { + "summary": "List logs", + "operationId": "sitesListLogs", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "Get a list of all site logs. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Executions List", + "schema": { + "$ref": "#\/definitions\/executionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listLogs", + "group": "logs", + "weight": 485, + "cookies": false, + "type": "", + "demo": "sites\/list-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "log.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "key", - "description": "Column Key.", + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "elements": { - "type": "array", - "description": "Updated list of enum values.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "elements", - "required", - "default" - ] - } + "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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { - "post": { - "summary": "Create float column", - "operationId": "tablesDBCreateFloatColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/logs\/{logId}": { + "get": { + "summary": "Get log", + "operationId": "sitesGetLog", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "description": "Get a site request log by its unique ID.", "responses": { - "202": { - "description": "ColumnFloat", + "200": { + "description": "Execution", "schema": { - "$ref": "#\/definitions\/columnFloat" + "$ref": "#\/definitions\/execution" } } }, "deprecated": false, "x-appwrite": { - "method": "createFloatColumn", - "group": "columns", - "weight": 730, + "method": "getLog", + "group": "logs", + "weight": 484, "cookies": false, "type": "", - "demo": "tablesdb\/create-float-column.md", + "demo": "sites\/get-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [] } @@ -53959,83 +54368,26 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "logId", + "description": "Log ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "min": { - "type": "number", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { - "patch": { - "summary": "Update float column", - "operationId": "tablesDBUpdateFloatColumn", + }, + "delete": { + "summary": "Delete log", + "operationId": "sitesDeleteLog", "consumes": [ "application\/json" ], @@ -54043,39 +54395,32 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "description": "Delete a site log by its unique ID.", "responses": { - "200": { - "description": "ColumnFloat", - "schema": { - "$ref": "#\/definitions\/columnFloat" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateFloatColumn", - "group": "columns", - "weight": 731, + "method": "deleteLog", + "group": "logs", + "weight": 486, "cookies": false, "type": "", - "demo": "tablesdb\/update-float-column.md", + "demo": "sites\/delete-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [] } @@ -54088,254 +54433,140 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "logId", + "description": "Log ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "min": { - "type": "number", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { - "post": { - "summary": "Create integer column", - "operationId": "tablesDBCreateIntegerColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/usage": { + "get": { + "summary": "Get site usage", + "operationId": "sitesGetUsage", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "description": "Get usage metrics and statistics for a for a specific site. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", "responses": { - "202": { - "description": "ColumnInteger", + "200": { + "description": "UsageSite", "schema": { - "$ref": "#\/definitions\/columnInteger" + "$ref": "#\/definitions\/usageSite" } } }, "deprecated": false, "x-appwrite": { - "method": "createIntegerColumn", - "group": "columns", - "weight": 732, + "method": "getUsage", + "group": null, + "weight": 495, "cookies": false, "type": "", - "demo": "tablesdb\/create-integer-column.md", + "demo": "sites\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "min": { - "type": "integer", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { - "patch": { - "summary": "Update integer column", - "operationId": "tablesDBUpdateIntegerColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/variables": { + "get": { + "summary": "List variables", + "operationId": "sitesListVariables", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a list of all variables of a specific site.", "responses": { "200": { - "description": "ColumnInteger", + "description": "Variables List", "schema": { - "$ref": "#\/definitions\/columnInteger" + "$ref": "#\/definitions\/variableList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateIntegerColumn", - "group": "columns", - "weight": 733, + "method": "listVariables", + "group": "variables", + "weight": 489, "cookies": false, "type": "", - "demo": "tablesdb\/update-integer-column.md", + "demo": "sites\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [] } @@ -54348,85 +54579,18 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "min": { - "type": "integer", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + }, "post": { - "summary": "Create IP address column", - "operationId": "tablesDBCreateIpColumn", + "summary": "Create variable", + "operationId": "sitesCreateVariable", "consumes": [ "application\/json" ], @@ -54434,39 +54598,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create IP address column.\n", + "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", "responses": { - "202": { - "description": "ColumnIP", + "201": { + "description": "Variable", "schema": { - "$ref": "#\/definitions\/columnIp" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "createIpColumn", - "group": "columns", - "weight": 734, + "method": "createVariable", + "group": "variables", + "weight": 905, "cookies": false, "type": "", - "demo": "tablesdb\/create-ip-column.md", + "demo": "sites\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [] } @@ -54479,19 +54639,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -54502,83 +54654,70 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", + "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "value": { "type": "string", - "description": "Default value. Cannot be set when column is required.", + "description": "Variable value. Max length: 8192 chars.", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "" }, - "array": { + "secret": { "type": "boolean", - "description": "Is column an array?", - "default": false, + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "default": true, "x-example": false } }, "required": [ "key", - "required" + "value" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { - "patch": { - "summary": "Update IP address column", - "operationId": "tablesDBUpdateIpColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/variables\/{variableId}": { + "get": { + "summary": "Get variable", + "operationId": "sitesGetVariable", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a variable by its unique ID.", "responses": { "200": { - "description": "ColumnIP", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/columnIp" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "updateIpColumn", - "group": "columns", - "weight": 735, + "method": "getVariable", + "group": "variables", + "weight": 488, "cookies": false, "type": "", - "demo": "tablesdb\/update-ip-column.md", + "demo": "sites\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [] } @@ -54591,68 +54730,26 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value. Cannot be set when column is required.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { - "post": { - "summary": "Create line column", - "operationId": "tablesDBCreateLineColumn", + }, + "put": { + "summary": "Update variable", + "operationId": "sitesUpdateVariable", "consumes": [ "application\/json" ], @@ -54660,39 +54757,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a geometric line column.", + "description": "Update variable by its unique ID.", "responses": { - "202": { - "description": "ColumnLine", + "200": { + "description": "Variable", "schema": { - "$ref": "#\/definitions\/columnLine" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "createLineColumn", - "group": "columns", - "weight": 736, + "method": "updateVariable", + "group": "variables", + "weight": 490, "cookies": false, "type": "", - "demo": "tablesdb\/create-line-column.md", + "demo": "sites\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [] } @@ -54705,19 +54798,19 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -54728,77 +54821,66 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", + "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": null + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", "default": null, - "x-example": false + "x-example": "", + "x-nullable": true }, - "default": { - "type": "array", - "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", "default": null, - "x-example": "[[1, 2], [3, 4], [5, 6]]", + "x-example": false, "x-nullable": true } }, "required": [ - "key", - "required" + "key" ] } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { - "patch": { - "summary": "Update line column", - "operationId": "tablesDBUpdateLineColumn", + }, + "delete": { + "summary": "Delete variable", + "operationId": "sitesDeleteVariable", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a line column. Changing the `default` value will not update already existing rows.", + "description": "Delete a variable by its unique ID.", "responses": { - "200": { - "description": "ColumnLine", - "schema": { - "$ref": "#\/definitions\/columnLine" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateLineColumn", - "group": "columns", - "weight": 737, + "method": "deleteVariable", + "group": "variables", + "weight": 491, "cookies": false, "type": "", - "demo": "tablesdb\/update-line-column.md", + "demo": "sites\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [] } @@ -54811,107 +54893,63 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", - "default": null, - "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { - "post": { - "summary": "Create longtext column", - "operationId": "tablesDBCreateLongtextColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets": { + "get": { + "summary": "List buckets", + "operationId": "storageListBuckets", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a longtext column.\n", + "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnLongtext", + "200": { + "description": "Buckets List", "schema": { - "$ref": "#\/definitions\/columnLongtext" + "$ref": "#\/definitions\/bucketList" } } }, "deprecated": false, "x-appwrite": { - "method": "createLongtextColumn", - "group": "columns", - "weight": 754, + "method": "listBuckets", + "group": "buckets", + "weight": 539, "cookies": false, "type": "", - "demo": "tablesdb\/create-longtext-column.md", + "demo": "storage\/list-buckets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [] } @@ -54924,72 +54962,40 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { - "patch": { - "summary": "Update longtext column", - "operationId": "tablesDBUpdateLongtextColumn", + }, + "post": { + "summary": "Create bucket", + "operationId": "storageCreateBucket", "consumes": [ "application\/json" ], @@ -54997,39 +55003,36 @@ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a new storage bucket.", "responses": { - "200": { - "description": "ColumnLongtext", + "201": { + "description": "Bucket", "schema": { - "$ref": "#\/definitions\/columnLongtext" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextColumn", - "group": "columns", - "weight": 755, + "method": "createBucket", + "group": "buckets", + "weight": 537, "cookies": false, "type": "", - "demo": "tablesdb\/update-longtext-column.md", + "demo": "storage\/create-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", "auth": { "Project": [] } @@ -55041,109 +55044,142 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", + "bucketId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "name": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Bucket name", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], "x-example": null, - "x-nullable": true + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false } }, "required": [ - "required", - "default" + "bucketId", + "name" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { - "post": { - "summary": "Create mediumtext column", - "operationId": "tablesDBCreateMediumtextColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}": { + "get": { + "summary": "Get bucket", + "operationId": "storageGetBucket", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a mediumtext column.\n", + "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", "responses": { - "202": { - "description": "ColumnMediumtext", + "200": { + "description": "Bucket", "schema": { - "$ref": "#\/definitions\/columnMediumtext" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "createMediumtextColumn", - "group": "columns", - "weight": 752, + "method": "getBucket", + "group": "buckets", + "weight": 538, "cookies": false, "type": "", - "demo": "tablesdb\/create-mediumtext-column.md", + "demo": "storage\/get-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [] } @@ -55156,72 +55192,18 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { - "patch": { - "summary": "Update mediumtext column", - "operationId": "tablesDBUpdateMediumtextColumn", + }, + "put": { + "summary": "Update bucket", + "operationId": "storageUpdateBucket", "consumes": [ "application\/json" ], @@ -55229,39 +55211,36 @@ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a storage bucket by its unique ID.", "responses": { "200": { - "description": "ColumnMediumtext", + "description": "Bucket", "schema": { - "$ref": "#\/definitions\/columnMediumtext" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMediumtextColumn", - "group": "columns", - "weight": 753, + "method": "updateBucket", + "group": "buckets", + "weight": 540, "cookies": false, "type": "", - "demo": "tablesdb\/update-mediumtext-column.md", + "demo": "storage\/update-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [] } @@ -55274,26 +55253,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -55302,80 +55266,124 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { + "name": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Bucket name", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], "x-example": null, - "x-nullable": true + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false } }, "required": [ - "required", - "default" + "name" ] } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { - "post": { - "summary": "Create point column", - "operationId": "tablesDBCreatePointColumn", + }, + "delete": { + "summary": "Delete bucket", + "operationId": "storageDeleteBucket", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a geometric point column.", + "description": "Delete a storage bucket by its unique ID.", "responses": { - "202": { - "description": "ColumnPoint", - "schema": { - "$ref": "#\/definitions\/columnPoint" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createPointColumn", - "group": "columns", - "weight": 738, + "method": "deleteBucket", + "group": "buckets", + "weight": 541, "cookies": false, "type": "", - "demo": "tablesdb\/create-point-column.md", + "demo": "storage\/delete-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [] } @@ -55388,100 +55396,56 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", - "default": null, - "x-example": "[1, 2]", - "x-nullable": true - } - }, - "required": [ - "key", - "required" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { - "patch": { - "summary": "Update point column", - "operationId": "tablesDBUpdatePointColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files": { + "get": { + "summary": "List files", + "operationId": "storageListFiles", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a point column. Changing the `default` value will not update already existing rows.", + "description": "Get a list of all the user files. You can use the query params to filter your results.", "responses": { "200": { - "description": "ColumnPoint", + "description": "Files List", "schema": { - "$ref": "#\/definitions\/columnPoint" + "$ref": "#\/definitions\/fileList" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePointColumn", - "group": "columns", - "weight": 739, + "method": "listFiles", + "group": "files", + "weight": 544, "cookies": false, "type": "", - "demo": "tablesdb\/update-point-column.md", + "demo": "storage\/list-files.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [] } @@ -55489,112 +55453,92 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", - "default": null, - "x-example": "[1, 2]", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + }, "post": { - "summary": "Create polygon column", - "operationId": "tablesDBCreatePolygonColumn", + "summary": "Create file", + "operationId": "storageCreateFile", "consumes": [ - "application\/json" + "multipart\/form-data" ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a geometric polygon column.", + "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", "responses": { - "202": { - "description": "ColumnPolygon", + "201": { + "description": "File", "schema": { - "$ref": "#\/definitions\/columnPolygon" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "createPolygonColumn", - "group": "columns", - "weight": 740, + "method": "createFile", + "group": "files", + "weight": 1186, "cookies": false, - "type": "", - "demo": "tablesdb\/create-polygon-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "type": "upload", + "demo": "storage\/create-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", + "scope": "files.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [] } @@ -55602,105 +55546,90 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "required": true, + "x-upload-id": true, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "in": "formData" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", - "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true - } - }, - "required": [ - "key", - "required" - ] - } + "name": "file", + "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", + "required": true, + "type": "file", + "in": "formData" + }, + { + "name": "permissions", + "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "x-example": "[\"read(\"any\")\"]", + "in": "formData" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { - "patch": { - "summary": "Update polygon column", - "operationId": "tablesDBUpdatePolygonColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "get": { + "summary": "Get file", + "operationId": "storageGetFile", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", + "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", "responses": { "200": { - "description": "ColumnPolygon", + "description": "File", "schema": { - "$ref": "#\/definitions\/columnPolygon" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePolygonColumn", - "group": "columns", - "weight": 741, + "method": "getFile", + "group": "files", + "weight": 543, "cookies": false, "type": "", - "demo": "tablesdb\/update-polygon-column.md", + "demo": "storage\/get-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [] } @@ -55708,72 +55637,32 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", - "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { - "post": { - "summary": "Create relationship column", - "operationId": "tablesDBCreateRelationshipColumn", + }, + "put": { + "summary": "Update file", + "operationId": "storageUpdateFile", "consumes": [ "application\/json" ], @@ -55781,39 +55670,37 @@ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", "responses": { - "202": { - "description": "ColumnRelationship", + "200": { + "description": "File", "schema": { - "$ref": "#\/definitions\/columnRelationship" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "createRelationshipColumn", - "group": "columns", - "weight": 742, + "method": "updateFile", + "group": "files", + "weight": 545, "cookies": false, "type": "", - "demo": "tablesdb\/create-relationship-column.md", + "demo": "storage\/update-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [] } @@ -55821,24 +55708,25 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -55847,117 +55735,63 @@ "schema": { "type": "object", "properties": { - "relatedTableId": { - "type": "string", - "description": "Related Table ID.", - "default": null, - "x-example": "" - }, - "type": { - "type": "string", - "description": "Relation type", - "default": null, - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] - }, - "twoWay": { - "type": "boolean", - "description": "Is Two Way?", - "default": false, - "x-example": false - }, - "key": { + "name": { "type": "string", - "description": "Column Key.", + "description": "File name.", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "" }, - "twoWayKey": { - "type": "string", - "description": "Two Way Column Key.", + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, - "x-example": null, - "x-nullable": true - }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": "restrict", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } } - }, - "required": [ - "relatedTableId", - "type" - ] + } } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { - "post": { - "summary": "Create string column", - "operationId": "tablesDBCreateStringColumn", + }, + "delete": { + "summary": "Delete file", + "operationId": "storageDeleteFile", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a string column.\n", + "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "202": { - "description": "ColumnString", - "schema": { - "$ref": "#\/definitions\/columnString" - } + "204": { + "description": "No content" } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createStringColumn", - "group": "columns", - "weight": 744, + "method": "deleteFile", + "group": "files", + "weight": 546, "cookies": false, "type": "", - "demo": "tablesdb\/create-string-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "demo": "storage\/delete-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "files.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", - "deprecated": { - "since": "1.9.0", - "replaceWith": "tablesDB.createTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [] } @@ -55965,129 +55799,70 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for text columns, in number of characters.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { - "patch": { - "summary": "Update string column", - "operationId": "tablesDBUpdateStringColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "get": { + "summary": "Get file for download", + "operationId": "storageGetFileDownload", + "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "responses": { "200": { - "description": "ColumnString", + "description": "File", "schema": { - "$ref": "#\/definitions\/columnString" + "type": "file" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateStringColumn", - "group": "columns", - "weight": 745, + "method": "getFileDownload", + "group": "files", + "weight": 548, "cookies": false, - "type": "", - "demo": "tablesdb\/update-string-column.md", + "type": "location", + "demo": "storage\/get-file-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [] } @@ -56095,121 +55870,79 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "token", + "description": "File token for accessing this file.", + "required": false, "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string column.", - "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "x-example": "", + "default": "", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { - "post": { - "summary": "Create text column", - "operationId": "tablesDBCreateTextColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { + "get": { + "summary": "Get file preview", + "operationId": "storageGetFilePreview", + "consumes": [], "produces": [ - "application\/json" + "image\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a text column.\n", + "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { - "202": { - "description": "ColumnText", + "200": { + "description": "Image", "schema": { - "$ref": "#\/definitions\/columnText" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "createTextColumn", - "group": "columns", - "weight": 750, + "method": "getFilePreview", + "group": "files", + "weight": 547, "cookies": false, - "type": "", - "demo": "tablesdb\/create-text-column.md", + "type": "location", + "demo": "storage\/get-file-preview.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [] } @@ -56217,117 +55950,207 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { - "patch": { - "summary": "Update text column", - "operationId": "tablesDBUpdateTextColumn", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tablesDB" - ], - "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", - "responses": { - "200": { - "description": "ColumnText", - "schema": { - "$ref": "#\/definitions\/columnText" + "name": "width", + "description": "Resize preview image width, Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "height", + "description": "Resize preview image height, Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "gravity", + "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", + "required": false, + "type": "string", + "x-example": "center", + "enum": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], + "x-enum-name": "ImageGravity", + "x-enum-keys": [], + "default": "center", + "in": "query" + }, + { + "name": "quality", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1, + "in": "query" + }, + { + "name": "borderWidth", + "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "borderColor", + "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", + "required": false, + "type": "string", + "default": "", + "in": "query" + }, + { + "name": "borderRadius", + "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "opacity", + "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", + "required": false, + "type": "number", + "format": "float", + "x-example": 0, + "default": 1, + "in": "query" + }, + { + "name": "rotation", + "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -360, + "default": 0, + "in": "query" + }, + { + "name": "background", + "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", + "required": false, + "type": "string", + "default": "", + "in": "query" + }, + { + "name": "output", + "description": "Output format type (jpeg, jpg, png, gif and webp).", + "required": false, + "type": "string", + "x-example": "jpg", + "enum": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ], + "x-enum-name": "ImageFormat", + "x-enum-keys": [], + "default": "", + "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { + "get": { + "summary": "Get file for view", + "operationId": "storageGetFileView", + "consumes": [], + "produces": [ + "*\/*" + ], + "tags": [ + "storage" + ], + "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", + "responses": { + "200": { + "description": "File", + "schema": { + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTextColumn", - "group": "columns", - "weight": 751, + "method": "getFileView", + "group": "files", + "weight": 549, "cookies": false, - "type": "", - "demo": "tablesdb\/update-text-column.md", + "type": "location", + "demo": "storage\/get-file-view.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [] } @@ -56335,341 +56158,228 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "token", + "description": "File token for accessing this file.", + "required": false, "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "x-example": "", + "default": "", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { - "post": { - "summary": "Create URL column", - "operationId": "tablesDBCreateUrlColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/usage": { + "get": { + "summary": "Get storage usage stats", + "operationId": "storageGetUsage", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a URL column.\n", + "description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", "responses": { - "202": { - "description": "ColumnURL", + "200": { + "description": "StorageUsage", "schema": { - "$ref": "#\/definitions\/columnUrl" + "$ref": "#\/definitions\/usageStorage" } } }, "deprecated": false, "x-appwrite": { - "method": "createUrlColumn", - "group": "columns", - "weight": 746, + "method": "getUsage", + "group": null, + "weight": 551, "cookies": false, "type": "", - "demo": "tablesdb\/create-url-column.md", + "demo": "storage\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { - "patch": { - "summary": "Update URL column", - "operationId": "tablesDBUpdateUrlColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/{bucketId}\/usage": { + "get": { + "summary": "Get bucket usage stats", + "operationId": "storageGetBucketUsage", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", "responses": { "200": { - "description": "ColumnURL", + "description": "UsageBuckets", "schema": { - "$ref": "#\/definitions\/columnUrl" + "$ref": "#\/definitions\/usageBuckets" } } }, "deprecated": false, "x-appwrite": { - "method": "updateUrlColumn", - "group": "columns", - "weight": 747, + "method": "getBucketUsage", + "group": null, + "weight": 552, "cookies": false, "type": "", - "demo": "tablesdb\/update-url-column.md", + "demo": "storage\/get-bucket-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "bucketId", + "description": "Bucket ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { - "post": { - "summary": "Create varchar column", - "operationId": "tablesDBCreateVarcharColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb": { + "get": { + "summary": "List databases", + "operationId": "tablesDBList", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Create a varchar column.\n", + "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", "responses": { - "202": { - "description": "ColumnVarchar", + "200": { + "description": "Databases List", "schema": { - "$ref": "#\/definitions\/columnVarchar" + "$ref": "#\/definitions\/databaseList" } } }, "deprecated": false, "x-appwrite": { - "method": "createVarcharColumn", - "group": "columns", - "weight": 748, + "method": "list", + "group": "tablesdb", + "weight": 761, "cookies": false, "type": "", - "demo": "tablesdb\/create-varchar-column.md", + "demo": "tablesdb\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [] } @@ -56682,80 +56392,40 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { - "patch": { - "summary": "Update varchar column", - "operationId": "tablesDBUpdateVarcharColumn", + }, + "post": { + "summary": "Create database", + "operationId": "tablesDBCreate", "consumes": [ "application\/json" ], @@ -56765,37 +56435,34 @@ "tags": [ "tablesDB" ], - "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a new Database.\n", "responses": { - "200": { - "description": "ColumnVarchar", + "201": { + "description": "Database", "schema": { - "$ref": "#\/definitions\/columnVarchar" + "$ref": "#\/definitions\/database" } } }, "deprecated": false, "x-appwrite": { - "method": "updateVarcharColumn", - "group": "columns", - "weight": 749, + "method": "create", + "group": "tablesdb", + "weight": 757, "cookies": false, "type": "", - "demo": "tablesdb\/update-varchar-column.md", + "demo": "tablesdb\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [] } @@ -56807,77 +56474,44 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { + "databaseId": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar column.", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true + "x-example": "" }, - "newKey": { + "name": { "type": "string", - "description": "New Column Key.", + "description": "Database name. Max length: 128 chars.", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "default": true, + "x-example": false } }, "required": [ - "required", - "default" + "databaseId", + "name" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "\/tablesdb\/transactions": { "get": { - "summary": "Get column", - "operationId": "tablesDBGetColumn", + "summary": "List transactions", + "operationId": "tablesDBListTransactions", "consumes": [], "produces": [ "application\/json" @@ -56885,119 +56519,38 @@ "tags": [ "tablesDB" ], - "description": "Get column by ID.", + "description": "List transactions across all databases.", "responses": { "200": { - "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "description": "Transaction List", "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/columnBoolean" - }, - { - "$ref": "#\/definitions\/columnInteger" - }, - { - "$ref": "#\/definitions\/columnFloat" - }, - { - "$ref": "#\/definitions\/columnEmail" - }, - { - "$ref": "#\/definitions\/columnEnum" - }, - { - "$ref": "#\/definitions\/columnUrl" - }, - { - "$ref": "#\/definitions\/columnIp" - }, - { - "$ref": "#\/definitions\/columnDatetime" - }, - { - "$ref": "#\/definitions\/columnRelationship" - }, - { - "$ref": "#\/definitions\/columnString" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/definitions\/columnBoolean", - "integer": "#\/definitions\/columnInteger", - "double": "#\/definitions\/columnFloat", - "string": "#\/definitions\/columnString", - "datetime": "#\/definitions\/columnDatetime", - "relationship": "#\/definitions\/columnRelationship" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/definitions\/columnBoolean": { - "type": "boolean" - }, - "#\/definitions\/columnInteger": { - "type": "integer" - }, - "#\/definitions\/columnFloat": { - "type": "double" - }, - "#\/definitions\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/definitions\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/definitions\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/definitions\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/definitions\/columnDatetime": { - "type": "datetime" - }, - "#\/definitions\/columnRelationship": { - "type": "relationship" - }, - "#\/definitions\/columnString": { - "type": "string" - } - } - } + "$ref": "#\/definitions\/transactionList" } } }, "deprecated": false, "x-appwrite": { - "method": "getColumn", - "group": "columns", - "weight": 719, + "method": "listTransactions", + "group": "transactions", + "weight": 828, "cookies": false, "type": "", - "demo": "tablesdb\/get-column.md", + "demo": "tablesdb\/list-transactions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [] } @@ -57005,73 +56558,69 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" } ] }, - "delete": { - "summary": "Delete column", - "operationId": "tablesDBDeleteColumn", + "post": { + "summary": "Create transaction", + "operationId": "tablesDBCreateTransaction", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "tablesDB" ], - "description": "Deletes a column.", + "description": "Create a new transaction.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteColumn", - "group": "columns", - "weight": 720, + "method": "createTransaction", + "group": "transactions", + "weight": 824, "cookies": false, "type": "", - "demo": "tablesdb\/delete-column.md", + "demo": "tablesdb\/create-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [] } @@ -57079,80 +56628,73 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60, + "format": "int32" + } + } + } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { - "patch": { - "summary": "Update relationship column", - "operationId": "tablesDBUpdateRelationshipColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "tablesDBGetTransaction", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "ColumnRelationship", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/columnRelationship" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRelationshipColumn", - "group": "columns", - "weight": 743, + "method": "getTransaction", + "group": "transactions", + "weight": 825, "cookies": false, "type": "", - "demo": "tablesdb\/update-relationship-column.md", + "demo": "tablesdb\/get-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.read", + "rows.read" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [] } @@ -57160,108 +56702,65 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": null, - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - } - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": { - "get": { - "summary": "List indexes", - "operationId": "tablesDBListIndexes", - "consumes": [], + }, + "patch": { + "summary": "Update transaction", + "operationId": "tablesDBUpdateTransaction", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "List indexes on the table.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { "200": { - "description": "Column Indexes List", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/columnIndexList" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 759, + "method": "updateTransaction", + "group": "transactions", + "weight": 826, "cookies": false, "type": "", - "demo": "tablesdb\/list-indexes.md", + "demo": "tablesdb\/update-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [] } @@ -57269,52 +56768,108 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "default": false, + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete transaction", + "operationId": "tablesDBDeleteTransaction", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "tablesDB" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 827, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "documents.write", + "rows.write" + ], + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "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 columns: key, type, status, attributes, error", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - }, + } + }, + "\/tablesdb\/transactions\/{transactionId}\/operations": { "post": { - "summary": "Create index", - "operationId": "tablesDBCreateIndex", + "summary": "Create operations", + "operationId": "tablesDBCreateOperations", "consumes": [ "application\/json" ], @@ -57324,37 +56879,38 @@ "tags": [ "tablesDB" ], - "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.", + "description": "Create multiple operations in a single transaction.", "responses": { - "202": { - "description": "Index", + "201": { + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/columnIndex" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 756, + "method": "createOperations", + "group": "transactions", + "weight": 829, "cookies": false, "type": "", - "demo": "tablesdb\/create-index.md", + "demo": "tablesdb\/create-operations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [] } @@ -57362,24 +56918,17 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -57388,74 +56937,25 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Index Key.", - "default": null, - "x-example": null - }, - "type": { - "type": "string", - "description": "Index type.", - "default": null, - "x-example": "key", - "enum": [ - "key", - "fulltext", - "unique", - "spatial" - ], - "x-enum-name": "TablesDBIndexType", - "x-enum-keys": [] - }, - "columns": { - "type": "array", - "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "default": [], - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } - }, - "lengths": { + "operations": { "type": "array", - "description": "Length of index. Maximum of 100", + "description": "Array of staged operations.", "default": [], - "x-example": null, + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", "items": { - "type": "integer" + "type": "object" } } - }, - "required": [ - "key", - "type", - "columns" - ] + } } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "\/tablesdb\/usage": { "get": { - "summary": "Get index", - "operationId": "tablesDBGetIndex", + "summary": "Get TablesDB usage stats", + "operationId": "tablesDBListUsage", "consumes": [], "produces": [ "application\/json" @@ -57463,23 +56963,23 @@ "tags": [ "tablesDB" ], - "description": "Get index by ID.", + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { "200": { - "description": "Index", + "description": "UsageDatabases", "schema": { - "$ref": "#\/definitions\/columnIndex" + "$ref": "#\/definitions\/usageDatabases" } } }, "deprecated": false, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 757, + "method": "listUsage", + "group": null, + "weight": 763, "cookies": false, "type": "", - "demo": "tablesdb\/get-index.md", + "demo": "tablesdb\/list-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -57487,13 +56987,107 @@ "tables.read", "collections.read" ], + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md", + "methods": [ + { + "name": "listUsage", + "namespace": "tablesDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "range" + ], + "required": [], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/usageDatabases" + } + ], + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "tablesdb\/list-usage.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "range", + "description": "Date range.", + "required": false, + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" + } + ] + } + }, + "\/tablesdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "tablesDBGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "tablesdb", + "weight": 758, + "cookies": false, + "type": "", + "demo": "tablesdb\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [] } @@ -57512,62 +57106,49 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "type": "string", - "in": "path" } ] }, - "delete": { - "summary": "Delete index", - "operationId": "tablesDBDeleteIndex", + "put": { + "summary": "Update database", + "operationId": "tablesDBUpdate", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "tablesDB" ], - "description": "Delete an index.", + "description": "Update a database by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 758, + "method": "update", + "group": "tablesdb", + "weight": 759, "cookies": false, "type": "", - "demo": "tablesdb\/delete-index.md", + "demo": "tablesdb\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [] } @@ -57588,71 +57169,71 @@ "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "type": "string", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + } + } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/logs": { - "get": { - "summary": "List table logs", - "operationId": "tablesDBListTableLogs", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete database", + "operationId": "tablesDBDelete", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ "tablesDB" ], - "description": "Get the table activity logs list by its unique ID.", + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", "responses": { - "200": { - "description": "Logs List", - "schema": { - "$ref": "#\/definitions\/logList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "listTableLogs", - "group": "tables", - "weight": 717, + "method": "delete", + "group": "tablesdb", + "weight": 760, "cookies": false, "type": "", - "demo": "tablesdb\/list-table-logs.md", + "demo": "tablesdb\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "databases.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -57663,34 +57244,14 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": { + "\/tablesdb\/{databaseId}\/tables": { "get": { - "summary": "List rows", - "operationId": "tablesDBListRows", + "summary": "List tables", + "operationId": "tablesDBListTables", "consumes": [], "produces": [ "application\/json" @@ -57698,38 +57259,37 @@ "tags": [ "tablesDB" ], - "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", "responses": { "200": { - "description": "Rows List", + "description": "Tables List", "schema": { - "$ref": "#\/definitions\/rowList" + "$ref": "#\/definitions\/tableList" } } }, "deprecated": false, "x-appwrite": { - "method": "listRows", - "group": "rows", + "method": "listTables", + "group": "tables", "weight": 768, "cookies": false, "type": "", - "demo": "tablesdb\/list-rows.md", + "demo": "tablesdb\/list-tables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "tables.read", + "collections.read" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [] } @@ -57737,8 +57297,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -57750,17 +57309,9 @@ "x-example": "", "in": "path" }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "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 columns: name, enabled, rowSecurity", "required": false, "type": "array", "collectionFormat": "multi", @@ -57771,11 +57322,12 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", "required": false, "type": "string", - "x-example": "", + "x-example": "", + "default": "", "in": "query" }, { @@ -57786,22 +57338,12 @@ "x-example": false, "default": true, "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" } ] }, "post": { - "summary": "Create row", - "operationId": "tablesDBCreateRow", + "summary": "Create table", + "operationId": "tablesDBCreateTable", "consumes": [ "application\/json" ], @@ -57811,99 +57353,37 @@ "tags": [ "tablesDB" ], - "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { "201": { - "description": "Row", + "description": "Table", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "createRow", - "group": "rows", - "weight": 760, + "method": "createTable", + "group": "tables", + "weight": 764, "cookies": false, "type": "", - "demo": "tablesdb\/create-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md", - "methods": [ - { - "name": "createRow", - "namespace": "tablesDB", - "desc": "Create row", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rowId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rowId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/row" - } - ], - "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/create-row.md", - "public": true - }, - { - "name": "createRows", - "namespace": "tablesDB", - "desc": "Create rows", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rows", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rows" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/rowList" - } - ], - "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/create-rows.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [] } @@ -57911,8 +57391,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -57924,35 +57403,27 @@ "x-example": "", "in": "path" }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "rowId": { + "tableId": { "type": "string", - "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": "", - "x-example": "" + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" }, - "data": { - "type": "object", - "description": "Row data as JSON object.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, "x-example": "[\"read(\"any\")\"]", "x-nullable": true, @@ -57960,62 +57431,80 @@ "type": "string" } }, - "rows": { + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "columns": { "type": "array", - "description": "Array of rows data as JSON objects.", + "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "default": [], "x-example": null, "items": { "type": "object" } }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true + "indexes": { + "type": "array", + "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "default": [], + "x-example": null, + "items": { + "type": "object" + } } - } + }, + "required": [ + "tableId", + "name" + ] } } ] - }, - "put": { - "summary": "Upsert rows", - "operationId": "tablesDBUpsertRows", - "consumes": [ - "application\/json" - ], + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesDBGetTable", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", "responses": { - "201": { - "description": "Rows List", + "200": { + "description": "Table", "schema": { - "$ref": "#\/definitions\/rowList" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "upsertRows", - "group": "rows", + "method": "getTable", + "group": "tables", "weight": 765, "cookies": false, "type": "", - "demo": "tablesdb\/upsert-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -58023,37 +57512,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md", - "methods": [ - { - "name": "upsertRows", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rows", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rows" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/rowList" - } - ], - "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", - "demo": "tablesdb\/upsert-rows.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [] } @@ -58080,40 +57539,12 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "rows": { - "type": "array", - "description": "Array of row data as JSON objects. May contain partial rows.", - "default": null, - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - }, - "required": [ - "rows" - ] - } } ] }, - "patch": { - "summary": "Update rows", - "operationId": "tablesDBUpdateRows", + "put": { + "summary": "Update table", + "operationId": "tablesDBUpdateTable", "consumes": [ "application\/json" ], @@ -58123,29 +57554,29 @@ "tags": [ "tablesDB" ], - "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "description": "Update a table by its unique ID.", "responses": { "200": { - "description": "Rows List", + "description": "Table", "schema": { - "$ref": "#\/definitions\/rowList" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRows", - "group": "rows", - "weight": 763, + "method": "updateTable", + "group": "tables", + "weight": 766, "cookies": false, "type": "", - "demo": "tablesdb\/update-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", @@ -58153,7 +57584,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [] } @@ -58187,27 +57618,39 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only column and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" }, - "queries": { + "permissions": { "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "default": [], - "x-example": null, + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, "items": { "type": "string" } }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false } } } @@ -58215,40 +57658,35 @@ ] }, "delete": { - "summary": "Delete rows", - "operationId": "tablesDBDeleteRows", + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "tablesDB" ], - "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "200": { - "description": "Rows List", - "schema": { - "$ref": "#\/definitions\/rowList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "deleteRows", - "group": "rows", + "method": "deleteTable", + "group": "tables", "weight": 767, "cookies": false, "type": "", - "demo": "tablesdb\/delete-rows.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", @@ -58256,7 +57694,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [] } @@ -58278,44 +57716,19 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { "get": { - "summary": "Get row", - "operationId": "tablesDBGetRow", + "summary": "List columns", + "operationId": "tablesDBListColumns", "consumes": [], "produces": [ "application\/json" @@ -58323,38 +57736,39 @@ "tags": [ "tablesDB" ], - "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "description": "List columns in the table.", "responses": { "200": { - "description": "Row", + "description": "Columns List", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/columnList" } } }, "deprecated": false, "x-appwrite": { - "method": "getRow", - "group": "rows", - "weight": 761, + "method": "listColumns", + "group": "columns", + "weight": 773, "cookies": false, "type": "", - "demo": "tablesdb\/get-row.md", + "demo": "tablesdb\/list-columns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "tables.read", + "collections.read", + "columns.read", + "attributes.read" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [] } @@ -58362,8 +57776,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -58377,23 +57790,15 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "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 columns: key, type, size, required, array, status, error", "required": false, "type": "array", "collectionFormat": "multi", @@ -58404,18 +57809,21 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, - "type": "string", - "x-example": "", + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] - }, - "put": { - "summary": "Upsert a row", - "operationId": "tablesDBUpsertRow", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesDBCreateBooleanColumn", "consumes": [ "application\/json" ], @@ -58425,70 +57833,39 @@ "tags": [ "tablesDB" ], - "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a boolean column.\n", "responses": { - "201": { - "description": "Row", + "202": { + "description": "ColumnBoolean", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/columnBoolean" } } }, "deprecated": false, "x-appwrite": { - "method": "upsertRow", - "group": "rows", - "weight": 764, + "method": "createBooleanColumn", + "group": "columns", + "weight": 774, "cookies": false, "type": "", - "demo": "tablesdb\/upsert-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md", - "methods": [ - { - "name": "upsertRow", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rowId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rowId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/row" - } - ], - "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/upsert-row.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [] } @@ -58496,8 +57873,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -58511,57 +57887,57 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": false }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "", + "x-example": false, "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } ] - }, + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { "patch": { - "summary": "Update row", - "operationId": "tablesDBUpdateRow", + "summary": "Update boolean column", + "operationId": "tablesDBUpdateBooleanColumn", "consumes": [ "application\/json" ], @@ -58571,38 +57947,39 @@ "tags": [ "tablesDB" ], - "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Row", + "description": "ColumnBoolean", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/columnBoolean" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRow", - "group": "rows", - "weight": 762, + "method": "updateBooleanColumn", + "group": "columns", + "weight": 775, "cookies": false, "type": "", - "demo": "tablesdb\/update-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-boolean-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [] } @@ -58610,8 +57987,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -58625,18 +58001,17 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "rowId", - "description": "Row ID.", + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -58645,73 +58020,82 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only columns and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": false, + "x-nullable": true }, - "transactionId": { + "newKey": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "New Column Key.", "default": null, - "x-example": "", + "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } ] - }, - "delete": { - "summary": "Delete row", - "operationId": "tablesDBDeleteRow", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesDBCreateDatetimeColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "tablesDB" ], - "description": "Delete a row by its unique ID.", + "description": "Create a date time column according to the ISO 8601 standard.", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnDatetime", + "schema": { + "$ref": "#\/definitions\/columnDatetime" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteRow", - "group": "rows", - "weight": 766, + "method": "createDatetimeColumn", + "group": "columns", + "weight": 776, "cookies": false, "type": "", - "demo": "tablesdb\/delete-row.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-datetime-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [] } @@ -58719,8 +58103,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -58734,87 +58117,108 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "transactionId": { + "key": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "Column Key.", "default": null, - "x-example": "", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { - "get": { - "summary": "List row logs", - "operationId": "tablesDBListRowLogs", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesDBUpdateDatetimeColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Get the row activity logs list by its unique ID.", + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Logs List", + "description": "ColumnDatetime", "schema": { - "$ref": "#\/definitions\/logList" + "$ref": "#\/definitions\/columnDatetime" } } }, "deprecated": false, "x-appwrite": { - "method": "listRowLogs", - "group": "logs", - "weight": 769, + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 777, "cookies": false, "type": "", - "demo": "tablesdb\/list-row-logs.md", + "demo": "tablesdb\/update-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -58835,32 +58239,53 @@ "in": "path" }, { - "name": "rowId", - "description": "Row ID.", + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { - "patch": { - "summary": "Decrement row column", - "operationId": "tablesDBDecrementRowColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesDBCreateEmailColumn", "consumes": [ "application\/json" ], @@ -58870,38 +58295,39 @@ "tags": [ "tablesDB" ], - "description": "Decrement a specific column of a row by a given value.", + "description": "Create an email column.\n", "responses": { - "200": { - "description": "Row", + "202": { + "description": "ColumnEmail", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/columnEmail" } } }, "deprecated": false, "x-appwrite": { - "method": "decrementRowColumn", - "group": "rows", - "weight": 771, + "method": "createEmailColumn", + "group": "columns", + "weight": 778, "cookies": false, "type": "", - "demo": "tablesdb\/decrement-row-column.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "client", - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [] } @@ -58909,7 +58335,6 @@ "security": [ { "Project": [], - "JWT": [], "Key": [] } ], @@ -58930,59 +58355,52 @@ "x-example": "", "in": "path" }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "column", - "description": "Column key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the column by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null }, - "min": { - "type": "number", - "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": null, - "format": "float", - "x-nullable": true + "x-example": false }, - "transactionId": { + "default": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "", + "x-example": "email@example.com", + "format": "email", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { "patch": { - "summary": "Increment row column", - "operationId": "tablesDBIncrementRowColumn", + "summary": "Update email column", + "operationId": "tablesDBUpdateEmailColumn", "consumes": [ "application\/json" ], @@ -58992,38 +58410,39 @@ "tags": [ "tablesDB" ], - "description": "Increment a specific column of a row by a given value.", + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Row", + "description": "ColumnEmail", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/columnEmail" } } }, "deprecated": false, "x-appwrite": { - "method": "incrementRowColumn", - "group": "rows", - "weight": 770, + "method": "updateEmailColumn", + "group": "columns", + "weight": 779, "cookies": false, "type": "", - "demo": "tablesdb\/increment-row-column.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-email-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "client", - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [] } @@ -59031,7 +58450,6 @@ "security": [ { "Project": [], - "JWT": [], "Key": [] } ], @@ -59053,16 +58471,8 @@ "in": "path" }, { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "column", - "description": "Column key.", + "name": "key", + "description": "Column Key.", "required": true, "type": "string", "in": "path" @@ -59073,82 +58483,91 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the column by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false }, - "max": { - "type": "number", - "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, - "format": "float", + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, - "transactionId": { + "newKey": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "New Column Key.", "default": null, - "x-example": "", + "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/usage": { - "get": { - "summary": "Get table usage stats", - "operationId": "tablesDBGetTableUsage", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "post": { + "summary": "Create enum column", + "operationId": "tablesDBCreateEnumColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", "responses": { - "200": { - "description": "UsageTable", + "202": { + "description": "ColumnEnum", "schema": { - "$ref": "#\/definitions\/usageTable" + "$ref": "#\/definitions\/columnEnum" } } }, "deprecated": false, "x-appwrite": { - "method": "getTableUsage", - "group": null, - "weight": 718, + "method": "createEnumColumn", + "group": "columns", + "weight": 780, "cookies": false, "type": "", - "demo": "tablesdb\/get-table-usage.md", + "demo": "tablesdb\/create-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -59160,26 +58579,6 @@ "x-example": "", "in": "path" }, - { - "name": "range", - "description": "Date range.", - "required": false, - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" - }, { "name": "tableId", "description": "Table ID.", @@ -59187,84 +58586,112 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "elements", + "required" + ] + } } ] } }, - "\/tablesdb\/{databaseId}\/usage": { - "get": { - "summary": "Get TablesDB usage stats", - "operationId": "tablesDBGetUsage", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesDBUpdateEnumColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "UsageDatabase", + "description": "ColumnEnum", "schema": { - "$ref": "#\/definitions\/usageDatabase" + "$ref": "#\/definitions\/columnEnum" } } }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 710, + "method": "updateEnumColumn", + "group": "columns", + "weight": 781, "cookies": false, "type": "", - "demo": "tablesdb\/get-usage.md", + "demo": "tablesdb\/update-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "tables.write", + "collections.write", + "columns.write", + "attributes.write" ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-database-usage.md", - "methods": [ - { - "name": "getUsage", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "range" - ], - "required": [ - "databaseId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/usageDatabase" - } - ], - "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", - "demo": "tablesdb\/get-usage.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -59277,68 +58704,112 @@ "in": "path" }, { - "name": "range", - "description": "Date range.", - "required": false, + "name": "tableId", + "description": "Table ID.", + "required": true, "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "elements", + "required", + "default" + ] + } } ] } }, - "\/teams": { - "get": { - "summary": "List teams", - "operationId": "teamsList", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesDBCreateFloatColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.", + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", "responses": { - "200": { - "description": "Teams List", + "202": { + "description": "ColumnFloat", "schema": { - "$ref": "#\/definitions\/teamList" + "$ref": "#\/definitions\/columnFloat" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "teams", - "weight": 539, + "method": "createFloatColumn", + "group": "columns", + "weight": 782, "cookies": false, "type": "", - "demo": "teams\/list.md", + "demo": "tablesdb\/create-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [] } @@ -59346,46 +58817,88 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "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: name, total, billingPlan", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID.", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, - "post": { - "summary": "Create team", - "operationId": "teamsCreate", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "patch": { + "summary": "Update float column", + "operationId": "tablesDBUpdateFloatColumn", "consumes": [ "application\/json" ], @@ -59393,37 +58906,41 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.", + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "Team", + "200": { + "description": "ColumnFloat", "schema": { - "$ref": "#\/definitions\/team" + "$ref": "#\/definitions\/columnFloat" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "teams", - "weight": 537, + "method": "updateFloatColumn", + "group": "columns", + "weight": 783, "cookies": false, "type": "", - "demo": "teams\/create.md", + "demo": "tablesdb\/update-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [] } @@ -59431,90 +58948,132 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "teamId": { - "type": "string", - "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "" + "x-example": false }, - "name": { - "type": "string", - "description": "Team name. Max length: 128 chars.", + "min": { + "type": "number", + "description": "Minimum value", "default": null, - "x-example": "" + "x-example": null, + "format": "float", + "x-nullable": true }, - "roles": { - "type": "array", - "description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", - "default": [ - "owner" - ], + "max": { + "type": "number", + "description": "Maximum value", + "default": null, "x-example": null, - "items": { - "type": "string" - } + "format": "float", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "teamId", - "name" + "required", + "default" ] } } ] } }, - "\/teams\/{teamId}": { - "get": { - "summary": "Get team", - "operationId": "teamsGet", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesDBCreateIntegerColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get a team by its ID. All team members have read access for this resource.", + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", "responses": { - "200": { - "description": "Team", + "202": { + "description": "ColumnInteger", "schema": { - "$ref": "#\/definitions\/team" + "$ref": "#\/definitions\/columnInteger" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "teams", - "weight": 538, + "method": "createIntegerColumn", + "group": "columns", + "weight": 784, "cookies": false, "type": "", - "demo": "teams\/get.md", + "demo": "tablesdb\/create-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [] } @@ -59522,24 +59081,88 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, - "put": { - "summary": "Update name", - "operationId": "teamsUpdateName", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesDBUpdateIntegerColumn", "consumes": [ "application\/json" ], @@ -59547,37 +59170,41 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Update the team's name by its unique ID.", + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Team", + "description": "ColumnInteger", "schema": { - "$ref": "#\/definitions\/team" + "$ref": "#\/definitions\/columnInteger" } } }, "deprecated": false, "x-appwrite": { - "method": "updateName", - "group": "teams", - "weight": 541, + "method": "updateIntegerColumn", + "group": "columns", + "weight": 785, "cookies": false, "type": "", - "demo": "teams\/update-name.md", + "demo": "tablesdb\/update-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [] } @@ -59585,17 +59212,31 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -59604,56 +59245,99 @@ "schema": { "type": "object", "properties": { - "name": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { "type": "string", - "description": "New team name. Max length: 128 chars.", + "description": "New Column Key.", "default": null, - "x-example": "" + "x-example": null, + "x-nullable": true } }, "required": [ - "name" + "required", + "default" ] } } ] - }, - "delete": { - "summary": "Delete team", - "operationId": "teamsDelete", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "post": { + "summary": "Create IP address column", + "operationId": "tablesDBCreateIpColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "teams" + "tablesDB" ], - "description": "Delete a team using its ID. Only team members with the owner role can delete the team.", + "description": "Create IP address column.\n", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnIP", + "schema": { + "$ref": "#\/definitions\/columnIp" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "teams", - "weight": 540, + "method": "createIpColumn", + "group": "columns", + "weight": 786, "cookies": false, "type": "", - "demo": "teams\/delete.md", + "demo": "tablesdb\/create-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [] } @@ -59661,142 +59345,229 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] } }, - "\/teams\/{teamId}\/logs": { - "get": { - "summary": "List team logs", - "operationId": "teamsListLogs", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesDBUpdateIpColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get the team activity logs list by its unique ID.", + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Logs List", + "description": "ColumnIP", "schema": { - "$ref": "#\/definitions\/logList" + "$ref": "#\/definitions\/columnIp" } } }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 550, + "method": "updateIpColumn", + "group": "columns", + "weight": 787, "cookies": false, "type": "", - "demo": "teams\/list-logs.md", + "demo": "tablesdb\/update-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } }, - "\/teams\/{teamId}\/memberships": { - "get": { - "summary": "List team memberships", - "operationId": "teamsListMemberships", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { + "post": { + "summary": "Create line column", + "operationId": "tablesDBCreateLineColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "description": "Create a geometric line column.", "responses": { - "200": { - "description": "Memberships List", + "202": { + "description": "ColumnLine", "schema": { - "$ref": "#\/definitions\/membershipList" + "$ref": "#\/definitions\/columnLine" } } }, "deprecated": false, "x-appwrite": { - "method": "listMemberships", - "group": "memberships", - "weight": 546, + "method": "createLineColumn", + "group": "columns", + "weight": 788, "cookies": false, "type": "", - "demo": "teams\/list-memberships.md", + "demo": "tablesdb\/create-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [] } @@ -59804,54 +59575,65 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", + "default": null, + "x-example": "[[1, 2], [3, 4], [5, 6]]", + "x-nullable": true + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, - "post": { - "summary": "Create team membership", - "operationId": "teamsCreateMembership", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { + "patch": { + "summary": "Update line column", + "operationId": "tablesDBUpdateLineColumn", "consumes": [ "application\/json" ], @@ -59859,37 +59641,41 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n", + "description": "Update a line column. Changing the `default` value will not update already existing rows.", "responses": { - "201": { - "description": "Membership", + "200": { + "description": "ColumnLine", "schema": { - "$ref": "#\/definitions\/membership" + "$ref": "#\/definitions\/columnLine" } } }, "deprecated": false, "x-appwrite": { - "method": "createMembership", - "group": "memberships", - "weight": 544, + "method": "updateLineColumn", + "group": "columns", + "weight": 789, "cookies": false, "type": "", - "demo": "teams\/create-membership.md", - "rate-limit": 10, + "demo": "tablesdb\/update-line-column.md", + "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [] } @@ -59897,17 +59683,31 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -59916,97 +59716,81 @@ "schema": { "type": "object", "properties": { - "email": { - "type": "string", - "description": "Email of the new team member.", - "default": "", - "x-example": "email@example.com", - "format": "email" - }, - "userId": { - "type": "string", - "description": "ID of the user to be added to a team.", - "default": "", - "x-example": "" - }, - "phone": { - "type": "string", - "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "default": "", - "x-example": "+12065550100", - "format": "phone" + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false }, - "roles": { + "default": { "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "url": { - "type": "string", - "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "default": "", - "x-example": "https:\/\/example.com", - "format": "url" + "x-example": "[[1, 2], [3, 4], [5, 6]]", + "x-nullable": true }, - "name": { + "newKey": { "type": "string", - "description": "Name of the new team member. Max length: 128 chars.", - "default": "", - "x-example": "" + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "roles" + "required" ] } } ] } }, - "\/teams\/{teamId}\/memberships\/{membershipId}": { - "get": { - "summary": "Get team membership", - "operationId": "teamsGetMembership", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + "post": { + "summary": "Create longtext column", + "operationId": "tablesDBCreateLongtextColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "description": "Create a longtext column.\n", "responses": { - "200": { - "description": "Membership", + "202": { + "description": "ColumnLongtext", "schema": { - "$ref": "#\/definitions\/membership" + "$ref": "#\/definitions\/columnLongtext" } } }, "deprecated": false, "x-appwrite": { - "method": "getMembership", - "group": "memberships", - "weight": 545, + "method": "createLongtextColumn", + "group": "columns", + "weight": 806, "cookies": false, "type": "", - "demo": "teams\/get-membership.md", + "demo": "tablesdb\/create-longtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", "auth": { "Project": [] } @@ -60014,32 +59798,77 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { "patch": { - "summary": "Update team membership", - "operationId": "teamsUpdateMembership", + "summary": "Update longtext column", + "operationId": "tablesDBUpdateLongtextColumn", "consumes": [ "application\/json" ], @@ -60047,37 +59876,41 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n", + "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Membership", + "description": "ColumnLongtext", "schema": { - "$ref": "#\/definitions\/membership" + "$ref": "#\/definitions\/columnLongtext" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMembership", - "group": "memberships", - "weight": 547, + "method": "updateLongtextColumn", + "group": "columns", + "weight": 807, "cookies": false, "type": "", - "demo": "teams\/update-membership.md", + "demo": "tablesdb\/update-longtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", "auth": { "Project": [] } @@ -60085,25 +59918,31 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -60112,59 +59951,82 @@ "schema": { "type": "object", "properties": { - "roles": { - "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", "default": null, "x-example": null, - "items": { - "type": "string" - } + "x-nullable": true } }, "required": [ - "roles" + "required", + "default" ] } } ] - }, - "delete": { - "summary": "Delete team membership", - "operationId": "teamsDeleteMembership", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { + "post": { + "summary": "Create mediumtext column", + "operationId": "tablesDBCreateMediumtextColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "teams" + "tablesDB" ], - "description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.", + "description": "Create a mediumtext column.\n", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnMediumtext", + "schema": { + "$ref": "#\/definitions\/columnMediumtext" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteMembership", - "group": "memberships", - "weight": 1074, + "method": "createMediumtextColumn", + "group": "columns", + "weight": 804, "cookies": false, "type": "", - "demo": "teams\/delete-membership.md", + "demo": "tablesdb\/create-mediumtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", "auth": { "Project": [] } @@ -60172,34 +60034,77 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] } }, - "\/teams\/{teamId}\/memberships\/{membershipId}\/status": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { "patch": { - "summary": "Update team membership status", - "operationId": "teamsUpdateMembershipStatus", + "summary": "Update mediumtext column", + "operationId": "tablesDBUpdateMediumtextColumn", "consumes": [ "application\/json" ], @@ -60207,37 +60112,41 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n", + "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Membership", + "description": "ColumnMediumtext", "schema": { - "$ref": "#\/definitions\/membership" + "$ref": "#\/definitions\/columnMediumtext" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipStatus", - "group": "memberships", - "weight": 549, + "method": "updateMediumtextColumn", + "group": "columns", + "weight": 805, "cookies": false, "type": "", - "demo": "teams\/update-membership-status.md", + "demo": "tablesdb\/update-mediumtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", "auth": { "Project": [] } @@ -60245,24 +60154,31 @@ "security": [ { "Project": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -60271,68 +60187,82 @@ "schema": { "type": "object", "properties": { - "userId": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { "type": "string", - "description": "User ID.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "secret": { + "newKey": { "type": "string", - "description": "Secret key.", + "description": "New Column Key.", "default": null, - "x-example": "" + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "secret" + "required", + "default" ] } } ] } }, - "\/teams\/{teamId}\/prefs": { - "get": { - "summary": "Get team preferences", - "operationId": "teamsGetPrefs", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { + "post": { + "summary": "Create point column", + "operationId": "tablesDBCreatePointColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).", + "description": "Create a geometric point column.", "responses": { - "200": { - "description": "Preferences", + "202": { + "description": "ColumnPoint", "schema": { - "$ref": "#\/definitions\/preferences" + "$ref": "#\/definitions\/columnPoint" } } }, "deprecated": false, "x-appwrite": { - "method": "getPrefs", - "group": "teams", - "weight": 542, + "method": "createPointColumn", + "group": "columns", + "weight": 790, "cookies": false, "type": "", - "demo": "teams\/get-prefs.md", + "demo": "tablesdb\/create-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [] } @@ -60340,23 +60270,65 @@ "security": [ { "Project": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", + "default": null, + "x-example": "[1, 2]", + "x-nullable": true + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, - "put": { - "summary": "Update team preferences", - "operationId": "teamsUpdatePrefs", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "patch": { + "summary": "Update point column", + "operationId": "tablesDBUpdatePointColumn", "consumes": [ "application\/json" ], @@ -60364,37 +60336,41 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.", + "description": "Update a point column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Preferences", + "description": "ColumnPoint", "schema": { - "$ref": "#\/definitions\/preferences" + "$ref": "#\/definitions\/columnPoint" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePrefs", - "group": "teams", - "weight": 543, + "method": "updatePointColumn", + "group": "columns", + "weight": 791, "cookies": false, "type": "", - "demo": "teams\/update-prefs.md", + "demo": "tablesdb\/update-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [] } @@ -60402,16 +60378,31 @@ "security": [ { "Project": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -60420,59 +60411,81 @@ "schema": { "type": "object", "properties": { - "prefs": { - "type": "object", - "description": "Prefs key-value JSON object.", - "default": {}, - "x-example": "{}" + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", + "default": null, + "x-example": "[1, 2]", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "prefs" + "required" ] } } ] } }, - "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "List tokens", - "operationId": "tokensList", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "post": { + "summary": "Create polygon column", + "operationId": "tablesDBCreatePolygonColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tokens" + "tablesDB" ], - "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", + "description": "Create a geometric polygon column.", "responses": { - "200": { - "description": "Resource Tokens List", + "202": { + "description": "ColumnPolygon", "schema": { - "$ref": "#\/definitions\/resourceTokenList" + "$ref": "#\/definitions\/columnPolygon" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "files", - "weight": 553, + "method": "createPolygonColumn", + "group": "columns", + "weight": 792, "cookies": false, "type": "", - "demo": "tokens\/list.md", + "demo": "tablesdb\/create-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", "auth": { "Project": [] } @@ -60485,47 +60498,60 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File unique ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire", - "required": false, - "type": "array", - "collectionFormat": "multi", - "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, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", + "default": null, + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-nullable": true + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, - "post": { - "summary": "Create file token", - "operationId": "tokensCreateFileToken", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "patch": { + "summary": "Update polygon column", + "operationId": "tablesDBUpdatePolygonColumn", "consumes": [ "application\/json" ], @@ -60533,35 +60559,41 @@ "application\/json" ], "tags": [ - "tokens" + "tablesDB" ], - "description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.", + "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", "responses": { - "201": { - "description": "ResourceToken", + "200": { + "description": "ColumnPolygon", "schema": { - "$ref": "#\/definitions\/resourceToken" + "$ref": "#\/definitions\/columnPolygon" } } }, "deprecated": false, "x-appwrite": { - "method": "createFileToken", - "group": "files", - "weight": 551, + "method": "updatePolygonColumn", + "group": "columns", + "weight": 793, "cookies": false, "type": "", - "demo": "tokens\/create-file-token.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/update-polygon-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", "auth": { "Project": [] } @@ -60574,19 +60606,26 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File unique ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -60595,58 +60634,81 @@ "schema": { "type": "object", "properties": { - "expire": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", + "default": null, + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-nullable": true + }, + "newKey": { "type": "string", - "description": "Token expiry date", + "description": "New Column Key.", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required" + ] } } ] } }, - "\/tokens\/{tokenId}": { - "get": { - "summary": "Get token", - "operationId": "tokensGet", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesDBCreateRelationshipColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tokens" + "tablesDB" ], - "description": "Get a token by its unique ID.", + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "200": { - "description": "ResourceToken", + "202": { + "description": "ColumnRelationship", "schema": { - "$ref": "#\/definitions\/resourceToken" + "$ref": "#\/definitions\/columnRelationship" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "tokens", - "weight": 552, + "method": "createRelationshipColumn", + "group": "columns", + "weight": 794, "cookies": false, "type": "", - "demo": "tokens\/get.md", + "demo": "tablesdb\/create-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", "auth": { "Project": [] } @@ -60659,18 +60721,94 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, + "x-example": false + }, + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] + } + }, + "required": [ + "relatedTableId", + "type" + ] + } } ] - }, - "patch": { - "summary": "Update token", - "operationId": "tokensUpdate", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { + "post": { + "summary": "Create string column", + "operationId": "tablesDBCreateStringColumn", "consumes": [ "application\/json" ], @@ -60678,35 +60816,45 @@ "application\/json" ], "tags": [ - "tokens" + "tablesDB" ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", + "description": "Create a string column.\n", "responses": { - "200": { - "description": "ResourceToken", + "202": { + "description": "ColumnString", "schema": { - "$ref": "#\/definitions\/resourceToken" + "$ref": "#\/definitions\/columnString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "update", - "group": "tokens", - "weight": 554, + "method": "createStringColumn", + "group": "columns", + "weight": 796, "cookies": false, "type": "", - "demo": "tokens\/update.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/create-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", + "deprecated": { + "since": "1.9.0", + "replaceWith": "tablesDB.createTextColumn" + }, "auth": { "Project": [] } @@ -60719,11 +60867,19 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token unique ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -60732,54 +60888,106 @@ "schema": { "type": "object", "properties": { - "expire": { + "key": { "type": "string", - "description": "File token expiry date", + "description": "Column Key.", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "x-example": null + }, + "size": { + "type": "integer", + "description": "Column size for text columns, in number of characters.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false } - } + }, + "required": [ + "key", + "size", + "required" + ] } } ] - }, - "delete": { - "summary": "Delete token", - "operationId": "tokensDelete", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesDBUpdateStringColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "tokens" + "tablesDB" ], - "description": "Delete a token by its unique ID.", + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnString", + "schema": { + "$ref": "#\/definitions\/columnString" + } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "delete", - "group": "tokens", - "weight": 555, + "method": "updateStringColumn", + "group": "columns", + "weight": 797, "cookies": false, "type": "", - "demo": "tokens\/delete.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/update-string-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "auth": { + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateTextColumn" + }, + "auth": { "Project": [] } }, @@ -60791,55 +60999,118 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } }, - "\/users": { - "get": { - "summary": "List users", - "operationId": "usersList", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { + "post": { + "summary": "Create text column", + "operationId": "tablesDBCreateTextColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get a list of all the project's users. You can use the query params to filter your results.", + "description": "Create a text column.\n", "responses": { - "200": { - "description": "Users List", + "202": { + "description": "ColumnText", "schema": { - "$ref": "#\/definitions\/userList" + "$ref": "#\/definitions\/columnText" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "users", - "weight": 76, + "method": "createTextColumn", + "group": "columns", + "weight": 802, "cookies": false, "type": "", - "demo": "users\/list.md", + "demo": "tablesdb\/create-text-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", "auth": { "Project": [] } @@ -60852,40 +61123,72 @@ ], "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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, - "post": { - "summary": "Create user", - "operationId": "usersCreate", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { + "patch": { + "summary": "Update text column", + "operationId": "tablesDBUpdateTextColumn", "consumes": [ "application\/json" ], @@ -60893,36 +61196,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user.", + "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnText", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnText" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "users", - "weight": 67, + "method": "updateTextColumn", + "group": "columns", + "weight": 803, "cookies": false, "type": "", - "demo": "users\/create.md", + "demo": "tablesdb\/update-text-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", "auth": { "Project": [] } @@ -60934,59 +61242,69 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "" + "x-example": false }, - "email": { + "default": { "type": "string", - "description": "User email.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "", "x-nullable": true }, - "phone": { + "newKey": { "type": "string", - "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "description": "New Column Key.", "default": null, - "x-example": "+12065550100", - "format": "phone", + "x-example": null, "x-nullable": true - }, - "password": { - "type": "string", - "description": "Plain text user password. Must be at least 8 chars.", - "default": "", - "x-example": null - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" } }, "required": [ - "userId" + "required", + "default" ] } } ] } }, - "\/users\/argon2": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { "post": { - "summary": "Create user with Argon2 password", - "operationId": "usersCreateArgon2User", + "summary": "Create URL column", + "operationId": "tablesDBCreateUrlColumn", "consumes": [ "application\/json" ], @@ -60994,36 +61312,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a URL column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnURL", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnUrl" } } }, "deprecated": false, "x-appwrite": { - "method": "createArgon2User", - "group": "users", - "weight": 70, + "method": "createUrlColumn", + "group": "columns", + "weight": 798, "cookies": false, "type": "", - "demo": "users\/create-argon-2-user.md", + "demo": "tablesdb\/create-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", "auth": { "Project": [] } @@ -61035,53 +61358,68 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Column Key.", "default": null, - "x-example": "" + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": false }, - "password": { + "default": { "type": "string", - "description": "User password hashed using Argon2.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "password", - "format": "password" + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } }, "required": [ - "userId", - "email", - "password" + "key", + "required" ] } } ] } }, - "\/users\/bcrypt": { - "post": { - "summary": "Create user with bcrypt password", - "operationId": "usersCreateBcryptUser", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesDBUpdateUrlColumn", "consumes": [ "application\/json" ], @@ -61089,36 +61427,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnURL", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnUrl" } } }, "deprecated": false, "x-appwrite": { - "method": "createBcryptUser", - "group": "users", - "weight": 68, + "method": "updateUrlColumn", + "group": "columns", + "weight": 799, "cookies": false, "type": "", - "demo": "users\/create-bcrypt-user.md", + "demo": "tablesdb\/update-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", "auth": { "Project": [] } @@ -61130,88 +61473,112 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "" + "x-example": false }, - "email": { + "default": { "type": "string", - "description": "User email.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, - "password": { + "newKey": { "type": "string", - "description": "User password hashed using Bcrypt.", + "description": "New Column Key.", "default": null, - "x-example": "password", - "format": "password" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "required", + "default" ] } } ] } }, - "\/users\/identities": { - "get": { - "summary": "List identities", - "operationId": "usersListIdentities", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { + "post": { + "summary": "Create varchar column", + "operationId": "tablesDBCreateVarcharColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get identities for all users.", + "description": "Create a varchar column.\n", "responses": { - "200": { - "description": "Identities List", + "202": { + "description": "ColumnVarchar", "schema": { - "$ref": "#\/definitions\/identityList" + "$ref": "#\/definitions\/columnVarchar" } } }, "deprecated": false, "x-appwrite": { - "method": "listIdentities", - "group": "identities", - "weight": 84, + "method": "createVarcharColumn", + "group": "columns", + "weight": 800, "cookies": false, "type": "", - "demo": "users\/list-identities.md", + "demo": "tablesdb\/create-varchar-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", "auth": { "Project": [] } @@ -61224,74 +61591,122 @@ ], "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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "databaseId", + "description": "Database ID.", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "size": { + "type": "integer", + "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "size", + "required" + ] + } } ] } }, - "\/users\/identities\/{identityId}": { - "delete": { - "summary": "Delete identity", - "operationId": "usersDeleteIdentity", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { + "patch": { + "summary": "Update varchar column", + "operationId": "tablesDBUpdateVarcharColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "users" + "tablesDB" ], - "description": "Delete an identity by its unique ID.", + "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnVarchar", + "schema": { + "$ref": "#\/definitions\/columnVarchar" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteIdentity", - "group": "identities", - "weight": 108, + "method": "updateVarcharColumn", + "group": "columns", + "weight": 801, "cookies": false, "type": "", - "demo": "users\/delete-identity.md", + "demo": "tablesdb\/update-varchar-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", "auth": { "Project": [] } @@ -61304,57 +61719,198 @@ ], "parameters": [ { - "name": "identityId", - "description": "Identity ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the varchar column.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } }, - "\/users\/md5": { - "post": { - "summary": "Create user with MD5 password", - "operationId": "usersCreateMD5User", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "get": { + "summary": "Get column", + "operationId": "tablesDBGetColumn", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Get column by ID.", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", "schema": { - "$ref": "#\/definitions\/user" + "x-oneOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/definitions\/columnBoolean", + "integer": "#\/definitions\/columnInteger", + "double": "#\/definitions\/columnFloat", + "string": "#\/definitions\/columnString", + "datetime": "#\/definitions\/columnDatetime", + "relationship": "#\/definitions\/columnRelationship" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/definitions\/columnBoolean": { + "type": "boolean" + }, + "#\/definitions\/columnInteger": { + "type": "integer" + }, + "#\/definitions\/columnFloat": { + "type": "double" + }, + "#\/definitions\/columnEmail": { + "type": "string", + "format": "email" + }, + "#\/definitions\/columnEnum": { + "type": "string", + "format": "enum" + }, + "#\/definitions\/columnUrl": { + "type": "string", + "format": "url" + }, + "#\/definitions\/columnIp": { + "type": "string", + "format": "ip" + }, + "#\/definitions\/columnDatetime": { + "type": "datetime" + }, + "#\/definitions\/columnRelationship": { + "type": "relationship" + }, + "#\/definitions\/columnString": { + "type": "string" + } + } + } } } }, "deprecated": false, "x-appwrite": { - "method": "createMD5User", - "group": "users", - "weight": 69, + "method": "getColumn", + "group": "columns", + "weight": 771, "cookies": false, "type": "", - "demo": "users\/create-md-5-user.md", + "demo": "tablesdb\/get-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read", + "columns.read", + "attributes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md", "auth": { "Project": [] } @@ -61367,89 +61923,70 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "default": null, - "x-example": "email@example.com", - "format": "email" - }, - "password": { - "type": "string", - "description": "User password hashed using MD5.", - "default": null, - "x-example": "password", - "format": "password" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" - } - }, - "required": [ - "userId", - "email", - "password" - ] - } + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" } ] - } - }, - "\/users\/phpass": { - "post": { - "summary": "Create user with PHPass password", - "operationId": "usersCreatePHPassUser", + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDBDeleteColumn", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Deletes a column.", "responses": { - "201": { - "description": "User", - "schema": { - "$ref": "#\/definitions\/user" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createPHPassUser", - "group": "users", - "weight": 72, + "method": "deleteColumn", + "group": "columns", + "weight": 772, "cookies": false, "type": "", - "demo": "users\/create-ph-pass-user.md", + "demo": "tablesdb\/delete-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md", "auth": { "Project": [] } @@ -61462,52 +61999,35 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "default": null, - "x-example": "email@example.com", - "format": "email" - }, - "password": { - "type": "string", - "description": "User password hashed using PHPass.", - "default": null, - "x-example": "password", - "format": "password" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" - } - }, - "required": [ - "userId", - "email", - "password" - ] - } + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" } ] } }, - "\/users\/scrypt": { - "post": { - "summary": "Create user with Scrypt password", - "operationId": "usersCreateScryptUser", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesDBUpdateRelationshipColumn", "consumes": [ "application\/json" ], @@ -61515,36 +62035,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnRelationship", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnRelationship" } } }, "deprecated": false, "x-appwrite": { - "method": "createScryptUser", - "group": "users", - "weight": 73, + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 795, "cookies": false, "type": "", - "demo": "users\/create-scrypt-user.md", + "demo": "tablesdb\/update-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md", "auth": { "Project": [] } @@ -61556,129 +62081,105 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { + "onDelete": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Constraints option", "default": null, - "x-example": "" + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [], + "x-nullable": true }, - "email": { + "newKey": { "type": "string", - "description": "User email.", - "default": null, - "x-example": "email@example.com", - "format": "email" - }, - "password": { - "type": "string", - "description": "User password hashed using Scrypt.", - "default": null, - "x-example": "password", - "format": "password" - }, - "passwordSalt": { - "type": "string", - "description": "Optional salt used to hash password.", - "default": null, - "x-example": "" - }, - "passwordCpu": { - "type": "integer", - "description": "Optional CPU cost used to hash password.", - "default": null, - "x-example": null, - "format": "int32" - }, - "passwordMemory": { - "type": "integer", - "description": "Optional memory cost used to hash password.", - "default": null, - "x-example": null, - "format": "int32" - }, - "passwordParallel": { - "type": "integer", - "description": "Optional parallelization cost used to hash password.", - "default": null, - "x-example": null, - "format": "int32" - }, - "passwordLength": { - "type": "integer", - "description": "Optional hash length used to hash password.", + "description": "New Column Key.", "default": null, "x-example": null, - "format": "int32" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "x-nullable": true } - }, - "required": [ - "userId", - "email", - "password", - "passwordSalt", - "passwordCpu", - "passwordMemory", - "passwordParallel", - "passwordLength" - ] + } } } ] } }, - "\/users\/scrypt-modified": { - "post": { - "summary": "Create user with Scrypt modified password", - "operationId": "usersCreateScryptModifiedUser", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesDBListIndexes", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "List indexes on the table.", "responses": { - "201": { - "description": "User", + "200": { + "description": "Column Indexes List", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnIndexList" } } }, "deprecated": false, "x-appwrite": { - "method": "createScryptModifiedUser", - "group": "users", - "weight": 74, + "method": "listIndexes", + "group": "indexes", + "weight": 811, "cookies": false, "type": "", - "demo": "users\/create-scrypt-modified-user.md", + "demo": "tablesdb\/list-indexes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read", + "indexes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md", "auth": { "Project": [] } @@ -61691,73 +62192,47 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", - "default": null, - "x-example": "email@example.com", - "format": "email" - }, - "password": { - "type": "string", - "description": "User password hashed using Scrypt Modified.", - "default": null, - "x-example": "password", - "format": "password" - }, - "passwordSalt": { - "type": "string", - "description": "Salt used to hash password.", - "default": null, - "x-example": "" - }, - "passwordSaltSeparator": { - "type": "string", - "description": "Salt separator used to hash password.", - "default": null, - "x-example": "" - }, - "passwordSignerKey": { - "type": "string", - "description": "Signer key used to hash password.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" - } - }, - "required": [ - "userId", - "email", - "password", - "passwordSalt", - "passwordSaltSeparator", - "passwordSignerKey" - ] - } + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, status, attributes, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/users\/sha": { + }, "post": { - "summary": "Create user with SHA password", - "operationId": "usersCreateSHAUser", + "summary": "Create index", + "operationId": "tablesDBCreateIndex", "consumes": [ "application\/json" ], @@ -61765,36 +62240,40 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.", "responses": { - "201": { - "description": "User", + "202": { + "description": "Index", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnIndex" } } }, "deprecated": false, "x-appwrite": { - "method": "createSHAUser", - "group": "users", - "weight": 71, + "method": "createIndex", + "group": "indexes", + "weight": 808, "cookies": false, "type": "", - "demo": "users\/create-sha-user.md", + "demo": "tablesdb\/create-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "indexes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md", "auth": { "Project": [] } @@ -61806,180 +62285,135 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "email": { + "key": { "type": "string", - "description": "User email.", + "description": "Index Key.", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": null }, - "password": { + "type": { "type": "string", - "description": "User password hashed using SHA.", + "description": "Index type.", "default": null, - "x-example": "password", - "format": "password" - }, - "passwordVersion": { - "type": "string", - "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", - "default": "", - "x-example": "sha1", + "x-example": "key", "enum": [ - "sha1", - "sha224", - "sha256", - "sha384", - "sha512\/224", - "sha512\/256", - "sha512", - "sha3-224", - "sha3-256", - "sha3-384", - "sha3-512" + "key", + "fulltext", + "unique", + "spatial" ], - "x-enum-name": "PasswordHash", + "x-enum-name": "TablesDBIndexType", "x-enum-keys": [] }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } } }, "required": [ - "userId", - "email", - "password" + "key", + "type", + "columns" ] } } ] } }, - "\/users\/usage": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { "get": { - "summary": "Get users usage stats", - "operationId": "usersGetUsage", + "summary": "Get index", + "operationId": "tablesDBGetIndex", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", + "description": "Get index by ID.", "responses": { "200": { - "description": "UsageUsers", + "description": "Index", "schema": { - "$ref": "#\/definitions\/usageUsers" + "$ref": "#\/definitions\/columnIndex" } } }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 110, + "method": "getIndex", + "group": "indexes", + "weight": 809, "cookies": false, "type": "", - "demo": "users\/get-usage.md", + "demo": "tablesdb\/get-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", - "platforms": [ - "console" + "scope": [ + "tables.read", + "collections.read", + "indexes.read" ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-usage.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "range", - "description": "Date range.", - "required": false, - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" - } - ] - } - }, - "\/users\/{userId}": { - "get": { - "summary": "Get user", - "operationId": "usersGet", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "users" - ], - "description": "Get a user by its unique ID.", - "responses": { - "200": { - "description": "User", - "schema": { - "$ref": "#\/definitions\/user" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "get", - "group": "users", - "weight": 77, - "cookies": false, - "type": "", - "demo": "users\/get.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md", "auth": { "Project": [] } @@ -61992,26 +62426,41 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", "required": true, "type": "string", - "x-example": "", "in": "path" } ] }, "delete": { - "summary": "Delete user", - "operationId": "usersDelete", + "summary": "Delete index", + "operationId": "tablesDBDeleteIndex", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "users" + "tablesDB" ], - "description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.", + "description": "Delete an index.", "responses": { "204": { "description": "No content" @@ -62019,23 +62468,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "users", - "weight": 106, + "method": "deleteIndex", + "group": "indexes", + "weight": 810, "cookies": false, "type": "", - "demo": "users\/delete.md", + "demo": "tablesdb\/delete-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "indexes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md", "auth": { "Project": [] } @@ -62048,139 +62501,156 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", "required": true, "type": "string", - "x-example": "", "in": "path" } ] } }, - "\/users\/{userId}\/email": { - "patch": { - "summary": "Update email", - "operationId": "usersUpdateEmail", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/logs": { + "get": { + "summary": "List table logs", + "operationId": "tablesDBListTableLogs", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user email by its unique ID.", + "description": "Get the table activity logs list by its unique ID.", "responses": { "200": { - "description": "User", + "description": "Logs List", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/logList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmail", - "group": "users", - "weight": 91, + "method": "listTableLogs", + "group": "tables", + "weight": 769, "cookies": false, "type": "", - "demo": "users\/update-email.md", + "demo": "tablesdb\/list-table-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read" + ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-logs.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "User email.", - "default": null, - "x-example": "email@example.com", - "format": "email" - } - }, - "required": [ - "email" - ] - } + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" } ] } }, - "\/users\/{userId}\/impersonator": { - "patch": { - "summary": "Update user impersonator capability", - "operationId": "usersUpdateImpersonator", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesDBListRows", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.\n", + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", "responses": { "200": { - "description": "User", + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/rowList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateImpersonator", - "group": "users", - "weight": 87, + "method": "listRows", + "group": "rows", + "weight": 899, "cookies": false, "type": "", - "demo": "users\/update-impersonator.md", + "demo": "tablesdb\/list-rows.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-impersonator.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md", "auth": { "Project": [] } @@ -62188,43 +62658,71 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "impersonator": { - "type": "boolean", - "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", - "default": null, - "x-example": false - } - }, - "required": [ - "impersonator" - ] - } + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" } ] - } - }, - "\/users\/{userId}\/jwts": { + }, "post": { - "summary": "Create user JWT", - "operationId": "usersCreateJWT", + "summary": "Create row", + "operationId": "tablesDBCreateRow", "consumes": [ "application\/json" ], @@ -62232,36 +62730,101 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.", + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { "201": { - "description": "JWT", + "description": "Row", "schema": { - "$ref": "#\/definitions\/jwt" + "$ref": "#\/definitions\/row" } } }, "deprecated": false, "x-appwrite": { - "method": "createJWT", - "group": "sessions", - "weight": 109, + "method": "createRow", + "group": "rows", + "weight": 812, "cookies": false, "type": "", - "demo": "users\/create-jwt.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/create-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md", + "methods": [ + { + "name": "createRow", + "namespace": "tablesDB", + "desc": "Create row", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/create-row.md", + "public": true + }, + { + "name": "createRows", + "namespace": "tablesDB", + "desc": "Create rows", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows", + "transactionId" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/create-rows.md", + "public": true + } + ], "auth": { "Project": [] } @@ -62269,16 +62832,25 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -62287,29 +62859,52 @@ "schema": { "type": "object", "properties": { - "sessionId": { + "rowId": { "type": "string", - "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "" + "x-example": "" }, - "duration": { - "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", - "default": 900, - "x-example": 0, - "format": "int32" + "data": { + "type": "object", + "description": "Row data as JSON object.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of rows data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true } } } } ] - } - }, - "\/users\/{userId}\/labels": { + }, "put": { - "summary": "Update user labels", - "operationId": "usersUpdateLabels", + "summary": "Upsert rows", + "operationId": "tablesDBUpsertRows", "consumes": [ "application\/json" ], @@ -62317,36 +62912,69 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.", + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", "responses": { - "200": { - "description": "User", + "201": { + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/rowList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLabels", - "group": "users", - "weight": 86, + "method": "upsertRows", + "group": "rows", + "weight": 817, "cookies": false, "type": "", - "demo": "users\/update-labels.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/upsert-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md", + "methods": [ + { + "name": "upsertRows", + "namespace": "tablesDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows", + "transactionId" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", + "demo": "tablesdb\/upsert-rows.md", + "public": true + } + ], "auth": { "Project": [] } @@ -62359,11 +62987,19 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -62372,63 +63008,73 @@ "schema": { "type": "object", "properties": { - "labels": { + "rows": { "type": "array", - "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "description": "Array of row data as JSON objects. May contain partial rows.", "default": null, "x-example": null, "items": { - "type": "string" + "type": "object" } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true } }, "required": [ - "labels" + "rows" ] } } ] - } - }, - "\/users\/{userId}\/logs": { - "get": { - "summary": "List user logs", - "operationId": "usersListLogs", - "consumes": [], + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesDBUpdateRows", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get the user activity logs list by its unique ID.", + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", "responses": { "200": { - "description": "Logs List", + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/logList" + "$ref": "#\/definitions\/rowList" } } }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 82, + "method": "updateRows", + "group": "rows", + "weight": 815, "cookies": false, "type": "", - "demo": "users\/list-logs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/update-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", "auth": { "Project": [] } @@ -62441,76 +63087,195 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } + } + ] + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDBDeleteRows", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "schema": { + "$ref": "#\/definitions\/rowList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "weight": 819, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-rows.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] } }, - "\/users\/{userId}\/memberships": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { "get": { - "summary": "List user memberships", - "operationId": "usersListMemberships", + "summary": "Get row", + "operationId": "tablesDBGetRow", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get the user membership list by its unique ID.", + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", "responses": { "200": { - "description": "Memberships List", + "description": "Row", "schema": { - "$ref": "#\/definitions\/membershipList" + "$ref": "#\/definitions\/row" } } }, "deprecated": false, "x-appwrite": { - "method": "listMemberships", - "group": "memberships", - "weight": 81, + "method": "getRow", + "group": "rows", + "weight": 813, "cookies": false, "type": "", - "demo": "users\/list-memberships.md", + "demo": "tablesdb\/get-row.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md", "auth": { "Project": [] } @@ -62518,21 +63283,38 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", "required": false, "type": "array", "collectionFormat": "multi", @@ -62543,30 +63325,18 @@ "in": "query" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", "required": false, "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, + "x-example": "", "in": "query" } ] - } - }, - "\/users\/{userId}\/mfa": { - "patch": { - "summary": "Update MFA", - "operationId": "usersUpdateMfa", + }, + "put": { + "summary": "Upsert a row", + "operationId": "tablesDBUpsertRow", "consumes": [ "application\/json" ], @@ -62574,93 +63344,69 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Enable or disable MFA on a user account.", + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { - "200": { - "description": "User", + "201": { + "description": "Row", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/row" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateMfa", - "group": "users", - "weight": 96, + "method": "upsertRow", + "group": "rows", + "weight": 816, "cookies": false, "type": "", - "demo": "users\/update-mfa.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/upsert-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFA" - }, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md", "methods": [ { - "name": "updateMfa", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId", - "mfa" - ], - "required": [ - "userId", - "mfa" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/user" - } - ], - "description": "Enable or disable MFA on a user account.", - "demo": "users\/update-mfa.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFA" - } - }, - { - "name": "updateMFA", - "namespace": "users", + "name": "upsertRow", + "namespace": "tablesDB", "desc": "", "auth": { "Project": [] }, "parameters": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rowId", + "data", + "permissions", + "transactionId" ], "required": [ - "userId", - "mfa" + "databaseId", + "tableId", + "rowId" ], "responses": [ { - "code": 200, - "model": "#\/definitions\/user" + "code": 201, + "model": "#\/definitions\/row" } ], - "description": "Enable or disable MFA on a user account.", - "demo": "users\/update-mfa.md", + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/upsert-row.md", "public": true } ], @@ -62671,16 +63417,33 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -62689,115 +63452,78 @@ "schema": { "type": "object", "properties": { - "mfa": { - "type": "boolean", - "description": "Enable or disable MFA.", + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, - "x-example": false + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true } - }, - "required": [ - "mfa" - ] + } } } ] - } - }, - "\/users\/{userId}\/mfa\/authenticators\/{type}": { - "delete": { - "summary": "Delete authenticator", - "operationId": "usersDeleteMfaAuthenticator", + }, + "patch": { + "summary": "Update row", + "operationId": "tablesDBUpdateRow", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "users" + "tablesDB" ], - "description": "Delete an authenticator app.", + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "deleteMfaAuthenticator", - "group": "mfa", - "weight": 101, + "method": "updateRow", + "group": "rows", + "weight": 814, "cookies": false, "type": "", - "demo": "users\/delete-mfa-authenticator.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/update-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.deleteMFAAuthenticator" - }, - "methods": [ - { - "name": "deleteMfaAuthenticator", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId", - "type" - ], - "required": [ - "userId", - "type" - ], - "responses": [ - { - "code": 204 - } - ], - "description": "Delete an authenticator app.", - "demo": "users\/delete-mfa-authenticator.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.deleteMFAAuthenticator" - } - }, - { - "name": "deleteMFAAuthenticator", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId", - "type" - ], - "required": [ - "userId", - "type" - ], - "responses": [ - { - "code": 204 - } - ], - "description": "Delete an authenticator app.", - "demo": "users\/delete-mfa-authenticator.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md", "auth": { "Project": [] } @@ -62805,129 +63531,108 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "type", - "description": "Type of authenticator.", + "name": "tableId", + "description": "Table ID.", "required": true, "type": "string", - "x-example": "totp", - "enum": [ - "totp" - ], - "x-enum-name": "AuthenticatorType", - "x-enum-keys": [], + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] - } - }, - "\/users\/{userId}\/mfa\/factors": { - "get": { - "summary": "List factors", - "operationId": "usersListMfaFactors", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete row", + "operationId": "tablesDBDeleteRow", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "users" + "tablesDB" ], - "description": "List the factors available on the account to be used as a MFA challange.", + "description": "Delete a row by its unique ID.", "responses": { - "200": { - "description": "MFAFactors", - "schema": { - "$ref": "#\/definitions\/mfaFactors" - } + "204": { + "description": "No content" } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listMfaFactors", - "group": "mfa", - "weight": 97, + "method": "deleteRow", + "group": "rows", + "weight": 818, "cookies": false, "type": "", - "demo": "users\/list-mfa-factors.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/delete-row.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.listMFAFactors" - }, - "methods": [ - { - "name": "listMfaFactors", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaFactors" - } - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "demo": "users\/list-mfa-factors.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.listMFAFactors" - } - }, - { - "name": "listMFAFactors", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaFactors" - } - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "demo": "users\/list-mfa-factors.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md", "auth": { "Project": [] } @@ -62935,140 +63640,148 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] } }, - "\/users\/{userId}\/mfa\/recovery-codes": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { "get": { - "summary": "Get MFA recovery codes", - "operationId": "usersGetMfaRecoveryCodes", + "summary": "List row logs", + "operationId": "tablesDBListRowLogs", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "description": "Get the row activity logs list by its unique ID.", "responses": { "200": { - "description": "MFA Recovery Codes", + "description": "Logs List", "schema": { - "$ref": "#\/definitions\/mfaRecoveryCodes" + "$ref": "#\/definitions\/logList" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getMfaRecoveryCodes", - "group": "mfa", - "weight": 98, + "method": "listRowLogs", + "group": "logs", + "weight": 821, "cookies": false, "type": "", - "demo": "users\/get-mfa-recovery-codes.md", + "demo": "tablesdb\/list-row-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.getMFARecoveryCodes" - }, - "methods": [ - { - "name": "getMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/get-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.getMFARecoveryCodes" - } - }, - { - "name": "getMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/get-mfa-recovery-codes.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row-logs.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" } ] - }, - "put": { - "summary": "Update MFA recovery codes (regenerate)", - "operationId": "usersUpdateMfaRecoveryCodes", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { + "patch": { + "summary": "Decrement row column", + "operationId": "tablesDBDecrementRowColumn", "consumes": [ "application\/json" ], @@ -63076,92 +63789,40 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "description": "Decrement a specific column of a row by a given value.", "responses": { "200": { - "description": "MFA Recovery Codes", + "description": "Row", "schema": { - "$ref": "#\/definitions\/mfaRecoveryCodes" + "$ref": "#\/definitions\/row" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateMfaRecoveryCodes", - "group": "mfa", - "weight": 100, + "method": "decrementRowColumn", + "group": "rows", + "weight": 823, "cookies": false, "type": "", - "demo": "users\/update-mfa-recovery-codes.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/decrement-row-column.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ - "console", - "server" + "client", + "server", + "console" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFARecoveryCodes" - }, - "methods": [ - { - "name": "updateMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/update-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFARecoveryCodes" - } - }, - { - "name": "updateMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/update-mfa-recovery-codes.md", - "public": false - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md", "auth": { "Project": [] } @@ -63169,23 +63830,80 @@ "security": [ { "Project": [], + "JWT": [], "Key": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", "required": true, "type": "string", - "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] - }, + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { "patch": { - "summary": "Create MFA recovery codes", - "operationId": "usersCreateMfaRecoveryCodes", + "summary": "Increment row column", + "operationId": "tablesDBIncrementRowColumn", "consumes": [ "application\/json" ], @@ -63193,236 +63911,355 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "description": "Increment a specific column of a row by a given value.", "responses": { - "201": { - "description": "MFA Recovery Codes", + "200": { + "description": "Row", "schema": { - "$ref": "#\/definitions\/mfaRecoveryCodes" + "$ref": "#\/definitions\/row" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createMfaRecoveryCodes", - "group": "mfa", - "weight": 99, + "method": "incrementRowColumn", + "group": "rows", + "weight": 822, "cookies": false, "type": "", - "demo": "users\/create-mfa-recovery-codes.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/increment-row-column.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ - "console", - "server" + "client", + "server", + "console" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.createMFARecoveryCodes" + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "JWT": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, - "methods": [ - { - "name": "createMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/mfaRecoveryCodes" + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true } - ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", - "demo": "users\/create-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.createMFARecoveryCodes" } - }, - { - "name": "createMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", - "demo": "users\/create-mfa-recovery-codes.md", - "public": true } + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/usage": { + "get": { + "summary": "Get table usage stats", + "operationId": "tablesDBGetTableUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageTable", + "schema": { + "$ref": "#\/definitions\/usageTable" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTableUsage", + "group": null, + "weight": 770, + "cookies": false, + "type": "", + "demo": "tablesdb\/get-table-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.read", + "collections.read" + ], + "platforms": [ + "console" ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" } ] } }, - "\/users\/{userId}\/name": { - "patch": { - "summary": "Update name", - "operationId": "usersUpdateName", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/usage": { + "get": { + "summary": "Get TablesDB usage stats", + "operationId": "tablesDBGetUsage", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user name by its unique ID.", + "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", "responses": { "200": { - "description": "User", + "description": "UsageDatabase", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/usageDatabase" } } }, "deprecated": false, "x-appwrite": { - "method": "updateName", - "group": "users", - "weight": 89, + "method": "getUsage", + "group": null, + "weight": 762, "cookies": false, "type": "", - "demo": "users\/update-name.md", + "demo": "tablesdb\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read" + ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-database-usage.md", + "methods": [ + { + "name": "getUsage", + "namespace": "tablesDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "range" + ], + "required": [ + "databaseId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/usageDatabase" + } + ], + "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "tablesdb\/get-usage.md", + "public": true + } + ], "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": null, - "x-example": "" - } - }, - "required": [ - "name" - ] - } + "name": "range", + "description": "Date range.", + "required": false, + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" } ] } }, - "\/users\/{userId}\/password": { - "patch": { - "summary": "Update password", - "operationId": "usersUpdatePassword", - "consumes": [ - "application\/json" - ], + "\/teams": { + "get": { + "summary": "List teams", + "operationId": "teamsList", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Update the user password by its unique ID.", + "description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.", "responses": { "200": { - "description": "User", + "description": "Teams List", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/teamList" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePassword", - "group": "users", - "weight": 90, + "method": "list", + "group": "teams", + "weight": 520, "cookies": false, "type": "", - "demo": "users\/update-password.md", + "demo": "teams\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md", "auth": { "Project": [] } @@ -63430,43 +64267,46 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "password": { - "type": "string", - "description": "New user password. Must be at least 8 chars.", - "default": null, - "x-example": null - } - }, - "required": [ - "password" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/users\/{userId}\/phone": { - "patch": { - "summary": "Update phone", - "operationId": "usersUpdatePhone", + }, + "post": { + "summary": "Create team", + "operationId": "teamsCreate", "consumes": [ "application\/json" ], @@ -63474,36 +64314,37 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Update the user phone by its unique ID.", + "description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.", "responses": { - "200": { - "description": "User", + "201": { + "description": "Team", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/team" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePhone", - "group": "users", - "weight": 92, + "method": "create", + "group": "teams", + "weight": 518, "cookies": false, "type": "", - "demo": "users\/update-phone.md", + "demo": "teams\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md", "auth": { "Project": [] } @@ -63511,79 +64352,90 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ - { - "name": "userId", - "description": "User ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "number": { + "teamId": { "type": "string", - "description": "User phone number.", + "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "+12065550100", - "format": "phone" + "x-example": "" + }, + "name": { + "type": "string", + "description": "Team name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "roles": { + "type": "array", + "description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "default": [ + "owner" + ], + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "number" + "teamId", + "name" ] } } ] } }, - "\/users\/{userId}\/prefs": { + "\/teams\/{teamId}": { "get": { - "summary": "Get user preferences", - "operationId": "usersGetPrefs", + "summary": "Get team", + "operationId": "teamsGet", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Get the user preferences by its unique ID.", + "description": "Get a team by its ID. All team members have read access for this resource.", "responses": { "200": { - "description": "Preferences", + "description": "Team", "schema": { - "$ref": "#\/definitions\/preferences" + "$ref": "#\/definitions\/team" } } }, "deprecated": false, "x-appwrite": { - "method": "getPrefs", - "group": "users", - "weight": 78, + "method": "get", + "group": "teams", + "weight": 519, "cookies": false, "type": "", - "demo": "users\/get-prefs.md", + "demo": "teams\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": "teams.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md", "auth": { "Project": [] } @@ -63591,23 +64443,24 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "patch": { - "summary": "Update user preferences", - "operationId": "usersUpdatePrefs", + "put": { + "summary": "Update name", + "operationId": "teamsUpdateName", "consumes": [ "application\/json" ], @@ -63615,36 +64468,37 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.", + "description": "Update the team's name by its unique ID.", "responses": { "200": { - "description": "Preferences", + "description": "Team", "schema": { - "$ref": "#\/definitions\/preferences" + "$ref": "#\/definitions\/team" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePrefs", - "group": "users", - "weight": 94, + "method": "updateName", + "group": "teams", + "weight": 522, "cookies": false, "type": "", - "demo": "users\/update-prefs.md", + "demo": "teams\/update-name.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md", "auth": { "Project": [] } @@ -63652,16 +64506,17 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -63670,79 +64525,147 @@ "schema": { "type": "object", "properties": { - "prefs": { - "type": "object", - "description": "Prefs key-value JSON object.", - "default": {}, - "x-example": "{}" + "name": { + "type": "string", + "description": "New team name. Max length: 128 chars.", + "default": null, + "x-example": "" } }, "required": [ - "prefs" + "name" ] } } ] - } - }, - "\/users\/{userId}\/sessions": { - "get": { - "summary": "List user sessions", - "operationId": "usersListSessions", + }, + "delete": { + "summary": "Delete team", + "operationId": "teamsDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "teams" + ], + "description": "Delete a team using its ID. Only team members with the owner role can delete the team.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "teams", + "weight": 521, + "cookies": false, + "type": "", + "demo": "teams\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "teams.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "teamId", + "description": "Team ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/teams\/{teamId}\/logs": { + "get": { + "summary": "List team logs", + "operationId": "teamsListLogs", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Get the user sessions list by its unique ID.", + "description": "Get the team activity logs list by its unique ID.", "responses": { "200": { - "description": "Sessions List", + "description": "Logs List", "schema": { - "$ref": "#\/definitions\/sessionList" + "$ref": "#\/definitions\/logList" } } }, "deprecated": false, "x-appwrite": { - "method": "listSessions", - "group": "sessions", - "weight": 80, + "method": "listLogs", + "group": "logs", + "weight": 531, "cookies": false, "type": "", - "demo": "users\/list-sessions.md", + "demo": "teams\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": "teams.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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.", @@ -63753,47 +64676,48 @@ "in": "query" } ] - }, - "post": { - "summary": "Create session", - "operationId": "usersCreateSession", - "consumes": [ - "application\/json" - ], + } + }, + "\/teams\/{teamId}\/memberships": { + "get": { + "summary": "List team memberships", + "operationId": "teamsListMemberships", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.", + "description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.", "responses": { - "201": { - "description": "Session", + "200": { + "description": "Memberships List", "schema": { - "$ref": "#\/definitions\/session" + "$ref": "#\/definitions\/membershipList" } } }, "deprecated": false, "x-appwrite": { - "method": "createSession", - "group": "sessions", - "weight": 102, + "method": "listMemberships", + "group": "memberships", + "weight": 527, "cookies": false, "type": "", - "demo": "users\/create-session.md", + "demo": "teams\/list-memberships.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md", "auth": { "Project": [] } @@ -63801,55 +64725,92 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "delete": { - "summary": "Delete user sessions", - "operationId": "usersDeleteSessions", + "post": { + "summary": "Create team membership", + "operationId": "teamsCreateMembership", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "users" + "teams" ], - "description": "Delete all user's sessions by using the user's unique ID.", + "description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Membership", + "schema": { + "$ref": "#\/definitions\/membership" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteSessions", - "group": "sessions", - "weight": 105, + "method": "createMembership", + "group": "memberships", + "weight": 525, "cookies": false, "type": "", - "demo": "users\/delete-sessions.md", - "rate-limit": 0, + "demo": "teams\/create-membership.md", + "rate-limit": 10, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md", "auth": { "Project": [] } @@ -63857,57 +64818,116 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Email of the new team member.", + "default": "", + "x-example": "email@example.com", + "format": "email" + }, + "userId": { + "type": "string", + "description": "ID of the user to be added to a team.", + "default": "", + "x-example": "" + }, + "phone": { + "type": "string", + "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "default": "", + "x-example": "+12065550100", + "format": "phone" + }, + "roles": { + "type": "array", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "url": { + "type": "string", + "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "name": { + "type": "string", + "description": "Name of the new team member. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "roles" + ] + } } ] } }, - "\/users\/{userId}\/sessions\/{sessionId}": { - "delete": { - "summary": "Delete user session", - "operationId": "usersDeleteSession", - "consumes": [ + "\/teams\/{teamId}\/memberships\/{membershipId}": { + "get": { + "summary": "Get team membership", + "operationId": "teamsGetMembership", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "users" + "teams" ], - "description": "Delete a user sessions by its unique ID.", + "description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Membership", + "schema": { + "$ref": "#\/definitions\/membership" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteSession", - "group": "sessions", - "weight": 104, + "method": "getMembership", + "group": "memberships", + "weight": 526, "cookies": false, "type": "", - "demo": "users\/delete-session.md", + "demo": "teams\/get-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md", "auth": { "Project": [] } @@ -63915,33 +64935,32 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "sessionId", - "description": "Session ID.", + "name": "membershipId", + "description": "Membership ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] - } - }, - "\/users\/{userId}\/status": { + }, "patch": { - "summary": "Update user status", - "operationId": "usersUpdateStatus", + "summary": "Update team membership", + "operationId": "teamsUpdateMembership", "consumes": [ "application\/json" ], @@ -63949,36 +64968,37 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.", + "description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n", "responses": { "200": { - "description": "User", + "description": "Membership", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/membership" } } }, "deprecated": false, "x-appwrite": { - "method": "updateStatus", - "group": "users", - "weight": 85, + "method": "updateMembership", + "group": "memberships", + "weight": 528, "cookies": false, "type": "", - "demo": "users\/update-status.md", + "demo": "teams\/update-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md", "auth": { "Project": [] } @@ -63986,16 +65006,25 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -64004,60 +65033,59 @@ "schema": { "type": "object", "properties": { - "status": { - "type": "boolean", - "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", + "roles": { + "type": "array", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "default": null, - "x-example": false + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "status" + "roles" ] } } ] - } - }, - "\/users\/{userId}\/targets": { - "get": { - "summary": "List user targets", - "operationId": "usersListTargets", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete team membership", + "operationId": "teamsDeleteMembership", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "users" + "teams" ], - "description": "List the messaging targets that are associated with a user.", + "description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.", "responses": { - "200": { - "description": "Target list", - "schema": { - "$ref": "#\/definitions\/targetList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "listTargets", - "group": "targets", - "weight": 83, + "method": "deleteMembership", + "group": "memberships", + "weight": 1187, "cookies": false, "type": "", - "demo": "users\/list-targets.md", + "demo": "teams\/delete-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.read", + "scope": "teams.write", "platforms": [ - "server", - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md", "auth": { "Project": [] } @@ -64065,44 +65093,34 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType", - "required": false, - "type": "array", - "collectionFormat": "multi", - "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, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - }, - "post": { - "summary": "Create user target", - "operationId": "usersCreateTarget", + } + }, + "\/teams\/{teamId}\/memberships\/{membershipId}\/status": { + "patch": { + "summary": "Update team membership status", + "operationId": "teamsUpdateMembershipStatus", "consumes": [ "application\/json" ], @@ -64110,36 +65128,37 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Create a messaging target.", + "description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n", "responses": { - "201": { - "description": "Target", + "200": { + "description": "Membership", "schema": { - "$ref": "#\/definitions\/target" + "$ref": "#\/definitions\/membership" } } }, "deprecated": false, "x-appwrite": { - "method": "createTarget", - "group": "targets", - "weight": 75, + "method": "updateMembershipStatus", + "group": "memberships", + "weight": 530, "cookies": false, "type": "", - "demo": "users\/create-target.md", + "demo": "teams\/update-membership-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "public", "platforms": [ - "server", - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md", "auth": { "Project": [] } @@ -64147,111 +65166,94 @@ "security": [ { "Project": [], - "Key": [] + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", "properties": { - "targetId": { - "type": "string", - "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "providerType": { + "userId": { "type": "string", - "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", + "description": "User ID.", "default": null, - "x-example": "email", - "enum": [ - "email", - "sms", - "push" - ], - "x-enum-name": "MessagingProviderType", - "x-enum-keys": [] + "x-example": "" }, - "identifier": { + "secret": { "type": "string", - "description": "The target identifier (token, email, phone etc.)", + "description": "Secret key.", "default": null, - "x-example": "" - }, - "providerId": { - "type": "string", - "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", - "default": "", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", - "default": "", - "x-example": "" + "x-example": "" } }, "required": [ - "targetId", - "providerType", - "identifier" + "userId", + "secret" ] } } ] } }, - "\/users\/{userId}\/targets\/{targetId}": { + "\/teams\/{teamId}\/prefs": { "get": { - "summary": "Get user target", - "operationId": "usersGetTarget", + "summary": "Get team preferences", + "operationId": "teamsGetPrefs", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Get a user's push notification target by ID.", + "description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).", "responses": { "200": { - "description": "Target", + "description": "Preferences", "schema": { - "$ref": "#\/definitions\/target" + "$ref": "#\/definitions\/preferences" } } }, "deprecated": false, "x-appwrite": { - "method": "getTarget", - "group": "targets", - "weight": 79, + "method": "getPrefs", + "group": "teams", + "weight": 523, "cookies": false, "type": "", - "demo": "users\/get-target.md", + "demo": "teams\/get-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.read", + "scope": "teams.read", "platforms": [ - "server", - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md", "auth": { "Project": [] } @@ -64259,31 +65261,23 @@ "security": [ { "Project": [], - "Key": [] + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "targetId", - "description": "Target ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "patch": { - "summary": "Update user target", - "operationId": "usersUpdateTarget", + "put": { + "summary": "Update team preferences", + "operationId": "teamsUpdatePrefs", "consumes": [ "application\/json" ], @@ -64291,36 +65285,37 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Update a messaging target.", + "description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.", "responses": { "200": { - "description": "Target", + "description": "Preferences", "schema": { - "$ref": "#\/definitions\/target" + "$ref": "#\/definitions\/preferences" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTarget", - "group": "targets", - "weight": 95, + "method": "updatePrefs", + "group": "teams", + "weight": 524, "cookies": false, "type": "", - "demo": "users\/update-target.md", + "demo": "teams\/update-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.write", "platforms": [ - "server", - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md", "auth": { "Project": [] } @@ -64328,24 +65323,16 @@ "security": [ { "Project": [], - "Key": [] + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "targetId", - "description": "Target ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -64354,64 +65341,59 @@ "schema": { "type": "object", "properties": { - "identifier": { - "type": "string", - "description": "The target identifier (token, email, phone etc.)", - "default": "", - "x-example": "" - }, - "providerId": { - "type": "string", - "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", - "default": "", - "x-example": "" - }, - "name": { - "type": "string", - "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", - "default": "", - "x-example": "" + "prefs": { + "type": "object", + "description": "Prefs key-value JSON object.", + "default": {}, + "x-example": "{}" } - } + }, + "required": [ + "prefs" + ] } } ] - }, - "delete": { - "summary": "Delete user target", - "operationId": "usersDeleteTarget", - "consumes": [ + } + }, + "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { + "get": { + "summary": "List tokens", + "operationId": "tokensList", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "users" + "tokens" ], - "description": "Delete a messaging target.", + "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Resource Tokens List", + "schema": { + "$ref": "#\/definitions\/resourceTokenList" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTarget", - "group": "targets", - "weight": 107, + "method": "list", + "group": "files", + "weight": 534, "cookies": false, "type": "", - "demo": "users\/delete-target.md", + "demo": "tokens\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "tokens.read", "platforms": [ - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md", "auth": { "Project": [] } @@ -64424,28 +65406,47 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "targetId", - "description": "Target ID.", + "name": "fileId", + "description": "File unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/users\/{userId}\/tokens": { + }, "post": { - "summary": "Create token", - "operationId": "usersCreateToken", + "summary": "Create file token", + "operationId": "tokensCreateFileToken", "consumes": [ "application\/json" ], @@ -64453,36 +65454,35 @@ "application\/json" ], "tags": [ - "users" + "tokens" ], - "description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n", + "description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.", "responses": { "201": { - "description": "Token", + "description": "ResourceToken", "schema": { - "$ref": "#\/definitions\/token" + "$ref": "#\/definitions\/resourceToken" } } }, "deprecated": false, "x-appwrite": { - "method": "createToken", - "group": "sessions", - "weight": 103, + "method": "createFileToken", + "group": "files", + "weight": 532, "cookies": false, "type": "", - "demo": "users\/create-token.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tokens\/create-file-token.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md", "auth": { "Project": [] } @@ -64495,11 +65495,19 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File unique ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -64508,19 +65516,13 @@ "schema": { "type": "object", "properties": { - "length": { - "type": "integer", - "description": "Token length in characters. The default length is 6 characters", - "default": 6, - "x-example": 4, - "format": "int32" - }, "expire": { - "type": "integer", - "description": "Token expiration period in seconds. The default expiration is 15 minutes.", - "default": 900, - "x-example": 60, - "format": "int32" + "type": "string", + "description": "Token expiry date", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } } } @@ -64528,47 +65530,44 @@ ] } }, - "\/users\/{userId}\/verification": { - "patch": { - "summary": "Update email verification", - "operationId": "usersUpdateEmailVerification", - "consumes": [ - "application\/json" - ], + "\/tokens\/{tokenId}": { + "get": { + "summary": "Get token", + "operationId": "tokensGet", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tokens" ], - "description": "Update the user email verification status by its unique ID.", + "description": "Get a token by its unique ID.", "responses": { "200": { - "description": "User", + "description": "ResourceToken", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/resourceToken" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmailVerification", - "group": "users", - "weight": 93, + "method": "get", + "group": "tokens", + "weight": 533, "cookies": false, "type": "", - "demo": "users\/update-email-verification.md", + "demo": "tokens\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "tokens.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md", "auth": { "Project": [] } @@ -64581,38 +65580,18 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "tokenId", + "description": "Token ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "emailVerification": { - "type": "boolean", - "description": "User email verification status.", - "default": null, - "x-example": false - } - }, - "required": [ - "emailVerification" - ] - } } ] - } - }, - "\/users\/{userId}\/verification\/phone": { + }, "patch": { - "summary": "Update phone verification", - "operationId": "usersUpdatePhoneVerification", + "summary": "Update token", + "operationId": "tokensUpdate", "consumes": [ "application\/json" ], @@ -64620,36 +65599,35 @@ "application\/json" ], "tags": [ - "users" + "tokens" ], - "description": "Update the user phone verification status by its unique ID.", + "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", "responses": { "200": { - "description": "User", + "description": "ResourceToken", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/resourceToken" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePhoneVerification", - "group": "users", - "weight": 88, + "method": "update", + "group": "tokens", + "weight": 535, "cookies": false, "type": "", - "demo": "users\/update-phone-verification.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tokens\/update.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md", "auth": { "Project": [] } @@ -64662,11 +65640,11 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "tokenId", + "description": "Token unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -64675,215 +65653,135 @@ "schema": { "type": "object", "properties": { - "phoneVerification": { - "type": "boolean", - "description": "User phone verification status.", + "expire": { + "type": "string", + "description": "File token expiry date", "default": null, - "x-example": false + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } - }, - "required": [ - "phoneVerification" - ] + } } } ] - } - }, - "\/vcs\/github\/installations\/{installationId}\/detections": { - "post": { - "summary": "Create repository detection", - "operationId": "vcsCreateRepositoryDetection", + }, + "delete": { + "summary": "Delete token", + "operationId": "tokensDelete", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "vcs" + "tokens" ], - "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", + "description": "Delete a token by its unique ID.", "responses": { - "200": { - "description": "DetectionRuntime, or DetectionFramework", - "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/detectionRuntime" - }, - { - "$ref": "#\/definitions\/detectionFramework" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "runtime": "#\/definitions\/detectionRuntime", - "framework": "#\/definitions\/detectionFramework" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createRepositoryDetection", - "group": "repositories", - "weight": 583, + "method": "delete", + "group": "tokens", + "weight": 536, "cookies": false, "type": "", - "demo": "vcs\/create-repository-detection.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", + "demo": "tokens\/delete.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", + "name": "tokenId", + "description": "Token ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", + } + ] + } + }, + "\/users": { + "get": { + "summary": "List users", + "operationId": "usersList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Get a list of all the project's users. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Users List", "schema": { - "type": "object", - "properties": { - "providerRepositoryId": { - "type": "string", - "description": "Repository Id", - "default": null, - "x-example": "" - }, - "type": { - "type": "string", - "description": "Detector type. Must be one of the following: runtime, framework", - "default": null, - "x-example": "runtime", - "enum": [ - "runtime", - "framework" - ], - "x-enum-name": "VCSDetectionType", - "x-enum-keys": [] - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to Root Directory", - "default": "", - "x-example": "" - } - }, - "required": [ - "providerRepositoryId", - "type" - ] - } - } - ] - } - }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories": { - "get": { - "summary": "List repositories", - "operationId": "vcsListRepositories", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "vcs" - ], - "description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.", - "responses": { - "200": { - "description": "Runtime Provider Repositories List, or Framework Provider Repositories List", - "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/providerRepositoryRuntimeList" - }, - { - "$ref": "#\/definitions\/providerRepositoryFrameworkList" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "runtime": "#\/definitions\/providerRepositoryRuntimeList", - "framework": "#\/definitions\/providerRepositoryFrameworkList" - } - } + "$ref": "#\/definitions\/userList" } } }, "deprecated": false, "x-appwrite": { - "method": "listRepositories", - "group": "repositories", - "weight": 580, + "method": "list", + "group": "users", + "weight": 71, "cookies": false, "type": "", - "demo": "vcs\/list-repositories.md", + "demo": "users\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "users.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repositories.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "type", - "description": "Detector type. Must be one of the following: runtime, framework", - "required": true, - "type": "string", - "x-example": "runtime", - "enum": [ - "runtime", - "framework" - ], - "x-enum-name": "VCSDetectionType", - "x-enum-keys": [], + "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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], "in": "query" }, { @@ -64896,22 +65794,19 @@ "in": "query" }, { - "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). Only supported methods are limit and offset", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] }, "post": { - "summary": "Create repository", - "operationId": "vcsCreateRepository", + "summary": "Create user", + "operationId": "usersCreate", "consumes": [ "application\/json" ], @@ -64919,314 +65814,381 @@ "application\/json" ], "tags": [ - "vcs" + "users" ], - "description": "Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.", + "description": "Create a new user.", "responses": { - "200": { - "description": "ProviderRepository", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/providerRepository" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "createRepository", - "group": "repositories", - "weight": 578, + "method": "create", + "group": "users", + "weight": 62, "cookies": false, "type": "", - "demo": "vcs\/create-repository.md", + "demo": "users\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ - { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "userId": { "type": "string", - "description": "Repository name (slug)", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "private": { - "type": "boolean", - "description": "Mark repository public or private", + "email": { + "type": "string", + "description": "User email.", "default": null, - "x-example": false + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "phone": { + "type": "string", + "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "default": null, + "x-example": "+12065550100", + "format": "phone", + "x-nullable": true + }, + "password": { + "type": "string", + "description": "Plain text user password. Must be at least 8 chars.", + "default": "", + "x-example": null + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" } }, "required": [ - "name", - "private" + "userId" ] } } ] } }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}": { - "get": { - "summary": "Get repository", - "operationId": "vcsGetRepository", - "consumes": [], + "\/users\/argon2": { + "post": { + "summary": "Create user with Argon2 password", + "operationId": "usersCreateArgon2User", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vcs" + "users" ], - "description": "Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.", + "description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "ProviderRepository", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/providerRepository" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "getRepository", - "group": "repositories", - "weight": 579, + "method": "createArgon2User", + "group": "users", + "weight": 65, "cookies": false, "type": "", - "demo": "vcs\/get-repository.md", + "demo": "users\/create-argon-2-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "providerRepositoryId", - "description": "Repository Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Argon2.", + "default": null, + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } } ] } }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches": { - "get": { - "summary": "List repository branches", - "operationId": "vcsListRepositoryBranches", - "consumes": [], + "\/users\/bcrypt": { + "post": { + "summary": "Create user with bcrypt password", + "operationId": "usersCreateBcryptUser", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vcs" + "users" ], - "description": "Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n", + "description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Branches List", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/branchList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "listRepositoryBranches", - "group": "repositories", - "weight": 581, + "method": "createBcryptUser", + "group": "users", + "weight": 63, "cookies": false, "type": "", - "demo": "vcs\/list-repository-branches.md", + "demo": "users\/create-bcrypt-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repository-branches.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "providerRepositoryId", - "description": "Repository Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Bcrypt.", + "default": null, + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } } ] } }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents": { + "\/users\/identities": { "get": { - "summary": "Get files and directories of a VCS repository", - "operationId": "vcsGetRepositoryContents", + "summary": "List identities", + "operationId": "usersListIdentities", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vcs" + "users" ], - "description": "Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", + "description": "Get identities for all users.", "responses": { "200": { - "description": "VCS Content List", + "description": "Identities List", "schema": { - "$ref": "#\/definitions\/vcsContentList" + "$ref": "#\/definitions\/identityList" } } }, "deprecated": false, "x-appwrite": { - "method": "getRepositoryContents", - "group": "repositories", - "weight": 582, + "method": "listIdentities", + "group": "identities", + "weight": 79, "cookies": false, "type": "", - "demo": "vcs\/get-repository-contents.md", + "demo": "users\/list-identities.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "users.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository-contents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "providerRepositoryId", - "description": "Repository Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "providerRootDirectory", - "description": "Path to get contents of nested directory", + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", "required": false, "type": "string", - "x-example": "", + "x-example": "", "default": "", "in": "query" }, { - "name": "providerReference", - "description": "Git reference (branch, tag, commit) to get contents from", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, - "type": "string", - "x-example": "", - "default": "", + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] } }, - "\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": { - "patch": { - "summary": "Update external deployment (authorize)", - "operationId": "vcsUpdateExternalDeployments", + "\/users\/identities\/{identityId}": { + "delete": { + "summary": "Delete identity", + "operationId": "usersDeleteIdentity", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "vcs" + "users" ], - "description": "Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.", + "description": "Delete an identity by its unique ID.", "responses": { "204": { "description": "No content" @@ -65234,302 +66196,276 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateExternalDeployments", - "group": "repositories", - "weight": 1084, + "method": "deleteIdentity", + "group": "identities", + "weight": 103, "cookies": false, "type": "", - "demo": "vcs\/update-external-deployments.md", + "demo": "users\/delete-identity.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/update-external-deployments.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "repositoryId", - "description": "VCS Repository Id", + "name": "identityId", + "description": "Identity ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "providerPullRequestId": { - "type": "string", - "description": "GitHub Pull Request Id", - "default": null, - "x-example": "" - } - }, - "required": [ - "providerPullRequestId" - ] - } } ] } }, - "\/vcs\/installations": { - "get": { - "summary": "List installations", - "operationId": "vcsListInstallations", - "consumes": [], + "\/users\/md5": { + "post": { + "summary": "Create user with MD5 password", + "operationId": "usersCreateMD5User", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vcs" + "users" ], - "description": "List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.\n", + "description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Installations List", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/installationList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "listInstallations", - "group": "installations", - "weight": 576, + "method": "createMD5User", + "group": "users", + "weight": 64, "cookies": false, "type": "", - "demo": "vcs\/list-installations.md", + "demo": "users\/create-md-5-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "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: provider, organization", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using MD5.", + "default": null, + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } } ] } }, - "\/vcs\/installations\/{installationId}": { - "get": { - "summary": "Get installation", - "operationId": "vcsGetInstallation", - "consumes": [], + "\/users\/phpass": { + "post": { + "summary": "Create user with PHPass password", + "operationId": "usersCreatePHPassUser", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vcs" + "users" ], - "description": "Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. ", + "description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Installation", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/installation" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "getInstallation", - "group": "installations", - "weight": 575, + "method": "createPHPassUser", + "group": "users", + "weight": 67, "cookies": false, "type": "", - "demo": "vcs\/get-installation.md", + "demo": "users\/create-ph-pass-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.read", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using PHPass.", + "default": null, + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } } ] - }, - "delete": { - "summary": "Delete installation", - "operationId": "vcsDeleteInstallation", + } + }, + "\/users\/scrypt": { + "post": { + "summary": "Create user with Scrypt password", + "operationId": "usersCreateScryptUser", "consumes": [ "application\/json" ], - "produces": [], - "tags": [ - "vcs" - ], - "description": "Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteInstallation", - "group": "installations", - "weight": 577, - "cookies": false, - "type": "", - "demo": "vcs\/delete-installation.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/vectorsdb": { - "get": { - "summary": "List databases", - "operationId": "vectorsDBList", - "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Databases List", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/databaseList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "vectorsdb", - "weight": 816, + "method": "createScryptUser", + "group": "users", + "weight": 68, "cookies": false, "type": "", - "demo": "vectorsdb\/list.md", + "demo": "users\/create-scrypt-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md", "auth": { "Project": [] } @@ -65542,40 +66478,91 @@ ], "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 columns: name", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Scrypt.", + "default": null, + "x-example": "password", + "format": "password" + }, + "passwordSalt": { + "type": "string", + "description": "Optional salt used to hash password.", + "default": null, + "x-example": "" + }, + "passwordCpu": { + "type": "integer", + "description": "Optional CPU cost used to hash password.", + "default": null, + "x-example": null, + "format": "int32" + }, + "passwordMemory": { + "type": "integer", + "description": "Optional memory cost used to hash password.", + "default": null, + "x-example": null, + "format": "int32" + }, + "passwordParallel": { + "type": "integer", + "description": "Optional parallelization cost used to hash password.", + "default": null, + "x-example": null, + "format": "int32" + }, + "passwordLength": { + "type": "integer", + "description": "Optional hash length used to hash password.", + "default": null, + "x-example": null, + "format": "int32" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password", + "passwordSalt", + "passwordCpu", + "passwordMemory", + "passwordParallel", + "passwordLength" + ] + } } ] - }, + } + }, + "\/users\/scrypt-modified": { "post": { - "summary": "Create database", - "operationId": "vectorsDBCreate", + "summary": "Create user with Scrypt modified password", + "operationId": "usersCreateScryptModifiedUser", "consumes": [ "application\/json" ], @@ -65583,36 +66570,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Database.\n", + "description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { "201": { - "description": "Database", + "description": "User", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "vectorsdb", - "weight": 812, + "method": "createScryptModifiedUser", + "group": "users", + "weight": 69, "cookies": false, "type": "", - "demo": "vectorsdb\/create.md", + "demo": "users\/create-scrypt-modified-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md", "auth": { "Project": [] } @@ -65630,38 +66617,68 @@ "schema": { "type": "object", "properties": { - "databaseId": { + "userId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "name": { + "email": { "type": "string", - "description": "Database name. Max length: 128 chars.", + "description": "User email.", "default": null, - "x-example": "" + "x-example": "email@example.com", + "format": "email" }, - "enabled": { - "type": "boolean", - "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "default": true, - "x-example": false + "password": { + "type": "string", + "description": "User password hashed using Scrypt Modified.", + "default": null, + "x-example": "password", + "format": "password" + }, + "passwordSalt": { + "type": "string", + "description": "Salt used to hash password.", + "default": null, + "x-example": "" + }, + "passwordSaltSeparator": { + "type": "string", + "description": "Salt separator used to hash password.", + "default": null, + "x-example": "" + }, + "passwordSignerKey": { + "type": "string", + "description": "Signer key used to hash password.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" } }, "required": [ - "databaseId", - "name" + "userId", + "email", + "password", + "passwordSalt", + "passwordSaltSeparator", + "passwordSignerKey" ] } } ] } }, - "\/vectorsdb\/embeddings\/text": { + "\/users\/sha": { "post": { - "summary": "Create Text Embeddings", - "operationId": "vectorsDBCreateTextEmbeddings", + "summary": "Create user with SHA password", + "operationId": "usersCreateSHAUser", "consumes": [ "application\/json" ], @@ -65669,62 +66686,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Embedding list", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/embeddingList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "createTextEmbeddings", - "group": "documents", - "weight": 838, + "method": "createSHAUser", + "group": "users", + "weight": 66, "cookies": false, "type": "", - "demo": "vectorsdb\/create-text-embeddings.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/create-sha-user.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", - "methods": [ - { - "name": "createTextEmbeddings", - "namespace": "vectorsDB", - "desc": "Create Text Embedding", - "auth": { - "Project": [] - }, - "parameters": [ - "texts", - "model" - ], - "required": [ - "texts" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/embeddingList" - } - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-text-embeddings.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md", "auth": { "Project": [] } @@ -65732,8 +66723,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -65743,142 +66733,174 @@ "schema": { "type": "object", "properties": { - "texts": { - "type": "array", - "description": "Array of text to generate embeddings.", + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": null, - "items": { - "type": "string" - } + "x-example": "" }, - "model": { + "email": { "type": "string", - "description": "The embedding model to use for generating vector embeddings.", - "default": "embeddinggemma", - "x-example": "embeddinggemma", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using SHA.", + "default": null, + "x-example": "password", + "format": "password" + }, + "passwordVersion": { + "type": "string", + "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", + "default": "", + "x-example": "sha1", "enum": [ - "embeddinggemma" + "sha1", + "sha224", + "sha256", + "sha384", + "sha512\/224", + "sha512\/256", + "sha512", + "sha3-224", + "sha3-256", + "sha3-384", + "sha3-512" ], - "x-enum-name": null, + "x-enum-name": "PasswordHash", "x-enum-keys": [] + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" } }, "required": [ - "texts" + "userId", + "email", + "password" ] } } ] } }, - "\/vectorsdb\/transactions": { + "\/users\/usage": { "get": { - "summary": "List transactions", - "operationId": "vectorsDBListTransactions", + "summary": "Get users usage stats", + "operationId": "usersGetUsage", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "List transactions across all databases.", + "description": "Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n", "responses": { "200": { - "description": "Transaction List", + "description": "UsageUsers", "schema": { - "$ref": "#\/definitions\/transactionList" + "$ref": "#\/definitions\/usageUsers" } } }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 843, + "method": "getUsage", + "group": null, + "weight": 105, "cookies": false, "type": "", - "demo": "vectorsdb\/list-transactions.md", + "demo": "users\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.read", "platforms": [ - "console", - "server", - "client" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-transactions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "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).", + "name": "range", + "description": "Date range.", "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", "in": "query" } ] - }, - "post": { - "summary": "Create transaction", - "operationId": "vectorsDBCreateTransaction", - "consumes": [ - "application\/json" - ], + } + }, + "\/users\/{userId}": { + "get": { + "summary": "Get user", + "operationId": "usersGet", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new transaction.", + "description": "Get a user by its unique ID.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "User", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 839, + "method": "get", + "group": "users", + "weight": 72, "cookies": false, "type": "", - "demo": "vectorsdb\/create-transaction.md", + "demo": "users\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.read", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md", "auth": { "Project": [] } @@ -65886,70 +66908,55 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "default": 300, - "x-example": 60, - "format": "int32" - } - } - } + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - } - }, - "\/vectorsdb\/transactions\/{transactionId}": { - "get": { - "summary": "Get transaction", - "operationId": "vectorsDBGetTransaction", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete user", + "operationId": "usersDelete", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a transaction by its unique ID.", + "description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.", "responses": { - "200": { - "description": "Transaction", - "schema": { - "$ref": "#\/definitions\/transaction" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 840, + "method": "delete", + "group": "users", + "weight": 101, "cookies": false, "type": "", - "demo": "vectorsdb\/get-transaction.md", + "demo": "users\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md", "auth": { "Project": [] } @@ -65957,24 +66964,25 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] - }, + } + }, + "\/users\/{userId}\/email": { "patch": { - "summary": "Update transaction", - "operationId": "vectorsDBUpdateTransaction", + "summary": "Update email", + "operationId": "usersUpdateEmail", "consumes": [ "application\/json" ], @@ -65982,37 +66990,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Update the user email by its unique ID.", "responses": { "200": { - "description": "Transaction", + "description": "User", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 841, + "method": "updateEmail", + "group": "users", + "weight": 86, "cookies": false, "type": "", - "demo": "vectorsdb\/update-transaction.md", + "demo": "users\/update-email.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md", "auth": { "Project": [] } @@ -66020,17 +67027,16 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -66039,59 +67045,63 @@ "schema": { "type": "object", "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" } - } + }, + "required": [ + "email" + ] } } ] - }, - "delete": { - "summary": "Delete transaction", - "operationId": "vectorsDBDeleteTransaction", + } + }, + "\/users\/{userId}\/impersonator": { + "patch": { + "summary": "Update user impersonator capability", + "operationId": "usersUpdateImpersonator", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a transaction by its unique ID.", + "description": "Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 842, + "method": "updateImpersonator", + "group": "users", + "weight": 82, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-transaction.md", + "demo": "users\/update-impersonator.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-impersonator.md", "auth": { "Project": [] } @@ -66099,26 +67109,43 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "impersonator": { + "type": "boolean", + "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", + "default": null, + "x-example": false + } + }, + "required": [ + "impersonator" + ] + } } ] } }, - "\/vectorsdb\/transactions\/{transactionId}\/operations": { + "\/users\/{userId}\/jwts": { "post": { - "summary": "Create operations", - "operationId": "vectorsDBCreateOperations", + "summary": "Create user JWT", + "operationId": "usersCreateJWT", "consumes": [ "application\/json" ], @@ -66126,37 +67153,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create multiple operations in a single transaction.", + "description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.", "responses": { "201": { - "description": "Transaction", + "description": "JWT", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/jwt" } } }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 844, + "method": "createJWT", + "group": "sessions", + "weight": 104, "cookies": false, "type": "", - "demo": "vectorsdb\/create-operations.md", + "demo": "users\/create-jwt.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md", "auth": { "Project": [] } @@ -66164,17 +67190,16 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -66183,14 +67208,18 @@ "schema": { "type": "object", "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } + "sessionId": { + "type": "string", + "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", + "default": "", + "x-example": "" + }, + "duration": { + "type": "integer", + "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", + "default": 900, + "x-example": 0, + "format": "int32" } } } @@ -66198,217 +67227,64 @@ ] } }, - "\/vectorsdb\/usage": { - "get": { - "summary": "Get VectorsDB usage stats", - "operationId": "vectorsDBListUsage", - "consumes": [], + "\/users\/{userId}\/labels": { + "put": { + "summary": "Update user labels", + "operationId": "usersUpdateLabels", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.", "responses": { "200": { - "description": "UsageVectorsDBs", + "description": "User", "schema": { - "$ref": "#\/definitions\/usageVectorsDBs" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "listUsage", - "group": null, - "weight": 818, + "method": "updateLabels", + "group": "users", + "weight": 81, "cookies": false, "type": "", - "demo": "vectorsdb\/list-usage.md", + "demo": "users\/update-labels.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-usage.md", - "methods": [ - { - "name": "listUsage", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "range" - ], - "required": [], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/usageVectorsDBs" - } - ], - "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", - "demo": "vectorsdb\/list-usage.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "range", - "description": "Date range.", - "required": false, + "name": "userId", + "description": "User ID.", + "required": true, "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" - } - ] - } - }, - "\/vectorsdb\/{databaseId}": { - "get": { - "summary": "Get database", - "operationId": "vectorsDBGet", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "vectorsDB" - ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", - "responses": { - "200": { - "description": "Database", - "schema": { - "$ref": "#\/definitions\/database" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "get", - "group": "vectorsdb", - "weight": 813, - "cookies": false, - "type": "", - "demo": "vectorsdb\/get.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "put": { - "summary": "Update database", - "operationId": "vectorsDBUpdate", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "vectorsDB" - ], - "description": "Update a database by its unique ID.", - "responses": { - "200": { - "description": "Database", - "schema": { - "$ref": "#\/definitions\/database" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "update", - "group": "vectorsdb", - "weight": 814, - "cookies": false, - "type": "", - "demo": "vectorsdb\/update.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -66417,61 +67293,63 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", + "labels": { + "type": "array", + "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", "default": null, - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "default": true, - "x-example": false + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "name" + "labels" ] } } ] - }, - "delete": { - "summary": "Delete database", - "operationId": "vectorsDBDelete", - "consumes": [ + } + }, + "\/users\/{userId}\/logs": { + "get": { + "summary": "List user logs", + "operationId": "usersListLogs", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "description": "Get the user activity logs list by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Logs List", + "schema": { + "$ref": "#\/definitions\/logList" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "vectorsdb", - "weight": 815, + "method": "listLogs", + "group": "logs", + "weight": 77, "cookies": false, "type": "", - "demo": "vectorsdb\/delete.md", + "demo": "users\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md", "auth": { "Project": [] } @@ -66484,55 +67362,76 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/vectorsdb\/{databaseId}\/collections": { + "\/users\/{userId}\/memberships": { "get": { - "summary": "List collections", - "operationId": "vectorsDBListCollections", + "summary": "List user memberships", + "operationId": "usersListMemberships", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "description": "Get the user membership list by its unique ID.", "responses": { "200": { - "description": "VectorsDB Collections List", + "description": "Memberships List", "schema": { - "$ref": "#\/definitions\/vectorsdbCollectionList" + "$ref": "#\/definitions\/membershipList" } } }, "deprecated": false, "x-appwrite": { - "method": "listCollections", - "group": "collections", - "weight": 823, + "method": "listMemberships", + "group": "memberships", + "weight": 76, "cookies": false, "type": "", - "demo": "vectorsdb\/list-collections.md", + "demo": "users\/list-memberships.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-collections.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md", "auth": { "Project": [] } @@ -66545,16 +67444,16 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", + "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: userId, teamId, invited, joined, confirm, roles", "required": false, "type": "array", "collectionFormat": "multi", @@ -66583,10 +67482,12 @@ "in": "query" } ] - }, - "post": { - "summary": "Create collection", - "operationId": "vectorsDBCreateCollection", + } + }, + "\/users\/{userId}\/mfa": { + "patch": { + "summary": "Update MFA", + "operationId": "usersUpdateMfa", "consumes": [ "application\/json" ], @@ -66594,36 +67495,96 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Enable or disable MFA on a user account.", "responses": { - "201": { - "description": "VectorsDB Collection", + "200": { + "description": "User", "schema": { - "$ref": "#\/definitions\/vectorsdbCollection" + "$ref": "#\/definitions\/user" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createCollection", - "group": "collections", - "weight": 819, + "method": "updateMfa", + "group": "users", + "weight": 91, "cookies": false, "type": "", - "demo": "vectorsdb\/create-collection.md", + "demo": "users\/update-mfa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-collection.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFA" + }, + "methods": [ + { + "name": "updateMfa", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId", + "mfa" + ], + "required": [ + "userId", + "mfa" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/user" + } + ], + "description": "Enable or disable MFA on a user account.", + "demo": "users\/update-mfa.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFA" + } + }, + { + "name": "updateMFA", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId", + "mfa" + ], + "required": [ + "userId", + "mfa" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/user" + } + ], + "description": "Enable or disable MFA on a user account.", + "demo": "users\/update-mfa.md", + "public": true + } + ], "auth": { "Project": [] } @@ -66636,11 +67597,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -66649,96 +67610,115 @@ "schema": { "type": "object", "properties": { - "collectionId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Collection name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "dimension": { - "type": "integer", - "description": "Embedding dimension.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documentSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { + "mfa": { "type": "boolean", - "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", - "default": true, + "description": "Enable or disable MFA.", + "default": null, "x-example": false } }, "required": [ - "collectionId", - "name", - "dimension" + "mfa" ] } } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}": { - "get": { - "summary": "Get collection", - "operationId": "vectorsDBGetCollection", - "consumes": [], - "produces": [ + "\/users\/{userId}\/mfa\/authenticators\/{type}": { + "delete": { + "summary": "Delete authenticator", + "operationId": "usersDeleteMfaAuthenticator", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "description": "Delete an authenticator app.", "responses": { - "200": { - "description": "VectorsDB Collection", - "schema": { - "$ref": "#\/definitions\/vectorsdbCollection" - } + "204": { + "description": "No content" } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "getCollection", - "group": "collections", - "weight": 820, + "method": "deleteMfaAuthenticator", + "group": "mfa", + "weight": 96, "cookies": false, "type": "", - "demo": "vectorsdb\/get-collection.md", + "demo": "users\/delete-mfa-authenticator.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.deleteMFAAuthenticator" + }, + "methods": [ + { + "name": "deleteMfaAuthenticator", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId", + "type" + ], + "required": [ + "userId", + "type" + ], + "responses": [ + { + "code": 204 + } + ], + "description": "Delete an authenticator app.", + "demo": "users\/delete-mfa-authenticator.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.deleteMFAAuthenticator" + } + }, + { + "name": "deleteMFAAuthenticator", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId", + "type" + ], + "required": [ + "userId", + "type" + ], + "responses": [ + { + "code": 204 + } + ], + "description": "Delete an authenticator app.", + "demo": "users\/delete-mfa-authenticator.md", + "public": true + } + ], "auth": { "Project": [] } @@ -66751,63 +67731,124 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "type", + "description": "Type of authenticator.", "required": true, "type": "string", - "x-example": "", + "x-example": "totp", + "enum": [ + "totp" + ], + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [], "in": "path" } ] - }, - "put": { - "summary": "Update collection", - "operationId": "vectorsDBUpdateCollection", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" + } + }, + "\/users\/{userId}\/mfa\/factors": { + "get": { + "summary": "List factors", + "operationId": "usersListMfaFactors", + "consumes": [], + "produces": [ + "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Update a collection by its unique ID.", + "description": "List the factors available on the account to be used as a MFA challange.", "responses": { "200": { - "description": "VectorsDB Collection", + "description": "MFAFactors", "schema": { - "$ref": "#\/definitions\/vectorsdbCollection" + "$ref": "#\/definitions\/mfaFactors" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateCollection", - "group": "collections", - "weight": 821, + "method": "listMfaFactors", + "group": "mfa", + "weight": 92, "cookies": false, "type": "", - "demo": "vectorsdb\/update-collection.md", + "demo": "users\/list-mfa-factors.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-collection.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.listMFAFactors" + }, + "methods": [ + { + "name": "listMfaFactors", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaFactors" + } + ], + "description": "List the factors available on the account to be used as a MFA challange.", + "demo": "users\/list-mfa-factors.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.listMFAFactors" + } + }, + { + "name": "listMFAFactors", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaFactors" + } + ], + "description": "List the factors available on the account to be used as a MFA challange.", + "demo": "users\/list-mfa-factors.md", + "public": true + } + ], "auth": { "Project": [] } @@ -66820,104 +67861,111 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Collection name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "dimension": { - "type": "integer", - "description": "Embedding dimensions.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documentSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", - "default": true, - "x-example": false - } - }, - "required": [ - "name" - ] - } } ] - }, - "delete": { - "summary": "Delete collection", - "operationId": "vectorsDBDeleteCollection", - "consumes": [ + } + }, + "\/users\/{userId}\/mfa\/recovery-codes": { + "get": { + "summary": "Get MFA recovery codes", + "operationId": "usersGetMfaRecoveryCodes", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "MFA Recovery Codes", + "schema": { + "$ref": "#\/definitions\/mfaRecoveryCodes" + } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteCollection", - "group": "collections", - "weight": 822, + "method": "getMfaRecoveryCodes", + "group": "mfa", + "weight": 93, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-collection.md", + "demo": "users\/get-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-collection.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.getMFARecoveryCodes" + }, + "methods": [ + { + "name": "getMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/get-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.getMFARecoveryCodes" + } + }, + { + "name": "getMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/get-mfa-recovery-codes.md", + "public": true + } + ], "auth": { "Project": [] } @@ -66930,64 +67978,111 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] - } - }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents": { - "get": { - "summary": "List documents", - "operationId": "vectorsDBListDocuments", - "consumes": [], + }, + "put": { + "summary": "Update MFA recovery codes (regenerate)", + "operationId": "usersUpdateMfaRecoveryCodes", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", "responses": { "200": { - "description": "Documents List", + "description": "MFA Recovery Codes", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/mfaRecoveryCodes" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "listDocuments", - "group": "documents", - "weight": 833, + "method": "updateMfaRecoveryCodes", + "group": "mfa", + "weight": 95, "cookies": false, "type": "", - "demo": "vectorsdb\/list-documents.md", + "demo": "users\/update-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.write", "platforms": [ "console", - "client", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-documents.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFARecoveryCodes" + }, + "methods": [ + { + "name": "updateMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/update-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFARecoveryCodes" + } + }, + { + "name": "updateMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/update-mfa-recovery-codes.md", + "public": false + } + ], "auth": { "Project": [] } @@ -66995,71 +68090,23 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "type": "string", - "x-example": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" } ] }, - "post": { - "summary": "Create document", - "operationId": "vectorsDBCreateDocument", + "patch": { + "summary": "Create MFA recovery codes", + "operationId": "usersCreateMfaRecoveryCodes", "consumes": [ "application\/json" ], @@ -67067,93 +68114,89 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", "responses": { "201": { - "description": "Document", + "description": "MFA Recovery Codes", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/mfaRecoveryCodes" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createDocument", - "group": "documents", - "weight": 829, + "method": "createMfaRecoveryCodes", + "group": "mfa", + "weight": 94, "cookies": false, "type": "", - "demo": "vectorsdb\/create-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/create-mfa-recovery-codes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.createMFARecoveryCodes" + }, "methods": [ { - "name": "createDocument", - "namespace": "vectorsDB", - "desc": "Create document", + "name": "createMfaRecoveryCodes", + "namespace": "users", + "desc": "", "auth": { "Project": [] }, "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions" + "userId" ], "required": [ - "databaseId", - "collectionId", - "documentId", - "data" + "userId" ], "responses": [ { "code": 201, - "model": "#\/definitions\/document" + "model": "#\/definitions\/mfaRecoveryCodes" } ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-document.md", - "public": true + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "demo": "users\/create-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.createMFARecoveryCodes" + } }, { - "name": "createDocuments", - "namespace": "vectorsDB", - "desc": "Create documents", + "name": "createMFARecoveryCodes", + "namespace": "users", + "desc": "", "auth": { "Project": [] }, "parameters": [ - "databaseId", - "collectionId", - "documents" + "userId" ], "required": [ - "databaseId", - "collectionId", - "documents" + "userId" ], "responses": [ { "code": 201, - "model": "#\/definitions\/documentList" + "model": "#\/definitions\/mfaRecoveryCodes" } ], - "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-documents.md", + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "demo": "users\/create-mfa-recovery-codes.md", "public": true } ], @@ -67164,77 +68207,25 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "documentId": { - "type": "string", - "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": "", - "x-example": "" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "default": [], - "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "" - } - } - } } ] - }, - "put": { - "summary": "Upsert documents", - "operationId": "vectorsDBUpsertDocuments", + } + }, + "\/users\/{userId}\/name": { + "patch": { + "summary": "Update name", + "operationId": "usersUpdateName", "consumes": [ "application\/json" ], @@ -67242,66 +68233,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "description": "Update the user name by its unique ID.", "responses": { - "201": { - "description": "Documents List", + "200": { + "description": "User", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "upsertDocuments", - "group": "documents", - "weight": 836, + "method": "updateName", + "group": "users", + "weight": 84, "cookies": false, "type": "", - "demo": "vectorsdb\/upsert-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-name.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-documents.md", - "methods": [ - { - "name": "upsertDocuments", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/documentList" - } - ], - "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", - "demo": "vectorsdb\/upsert-documents.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md", "auth": { "Project": [] } @@ -67314,19 +68275,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -67335,32 +68288,25 @@ "schema": { "type": "object", "properties": { - "documents": { - "type": "array", - "description": "Array of document data as JSON objects. May contain partial documents.", - "default": null, - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { + "name": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "User name. Max length: 128 chars.", "default": null, - "x-example": "" + "x-example": "" } }, "required": [ - "documents" + "name" ] } } ] - }, + } + }, + "\/users\/{userId}\/password": { "patch": { - "summary": "Update documents", - "operationId": "vectorsDBUpdateDocuments", + "summary": "Update password", + "operationId": "usersUpdatePassword", "consumes": [ "application\/json" ], @@ -67368,36 +68314,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "description": "Update the user password by its unique ID.", "responses": { "200": { - "description": "Documents List", + "description": "User", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDocuments", - "group": "documents", - "weight": 835, + "method": "updatePassword", + "group": "users", + "weight": 85, "cookies": false, "type": "", - "demo": "vectorsdb\/update-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-password.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md", "auth": { "Project": [] } @@ -67410,19 +68356,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -67431,35 +68369,25 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": [], - "x-example": "{}" - }, - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { + "password": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "New user password. Must be at least 8 chars.", "default": null, - "x-example": "" + "x-example": null } - } + }, + "required": [ + "password" + ] } } ] - }, - "delete": { - "summary": "Delete documents", - "operationId": "vectorsDBDeleteDocuments", + } + }, + "\/users\/{userId}\/phone": { + "patch": { + "summary": "Update phone", + "operationId": "usersUpdatePhone", "consumes": [ "application\/json" ], @@ -67467,36 +68395,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "description": "Update the user phone by its unique ID.", "responses": { "200": { - "description": "Documents List", + "description": "User", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDocuments", - "group": "documents", - "weight": 837, + "method": "updatePhone", + "group": "users", + "weight": 87, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-documents.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-phone.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md", "auth": { "Project": [] } @@ -67509,19 +68437,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -67530,67 +68450,61 @@ "schema": { "type": "object", "properties": { - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { + "number": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "User phone number.", "default": null, - "x-example": "" + "x-example": "+12065550100", + "format": "phone" } - } + }, + "required": [ + "number" + ] } } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "\/users\/{userId}\/prefs": { "get": { - "summary": "Get document", - "operationId": "vectorsDBGetDocument", + "summary": "Get user preferences", + "operationId": "usersGetPrefs", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Get the user preferences by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Preferences", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/preferences" } } }, "deprecated": false, "x-appwrite": { - "method": "getDocument", - "group": "documents", - "weight": 832, + "method": "getPrefs", + "group": "users", + "weight": 73, "cookies": false, "type": "", - "demo": "vectorsdb\/get-document.md", + "demo": "users\/get-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md", "auth": { "Project": [] } @@ -67598,60 +68512,23 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "type": "string", - "x-example": "", - "in": "query" } ] }, - "put": { - "summary": "Upsert a document", - "operationId": "vectorsDBUpsertDocument", + "patch": { + "summary": "Update user preferences", + "operationId": "usersUpdatePrefs", "consumes": [ "application\/json" ], @@ -67659,69 +68536,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.", "responses": { - "201": { - "description": "Document", + "200": { + "description": "Preferences", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/preferences" } } }, "deprecated": false, "x-appwrite": { - "method": "upsertDocument", - "group": "documents", - "weight": 831, + "method": "updatePrefs", + "group": "users", + "weight": 89, "cookies": false, "type": "", - "demo": "vectorsdb\/upsert-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-prefs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-document.md", - "methods": [ - { - "name": "upsertDocument", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/document" - } - ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/upsert-document.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md", "auth": { "Project": [] } @@ -67729,33 +68573,16 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -67764,73 +68591,63 @@ "schema": { "type": "object", "properties": { - "data": { + "prefs": { "type": "object", - "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": [], + "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "" } - } + }, + "required": [ + "prefs" + ] } } ] - }, - "patch": { - "summary": "Update document", - "operationId": "vectorsDBUpdateDocument", - "consumes": [ - "application\/json" - ], + } + }, + "\/users\/{userId}\/sessions": { + "get": { + "summary": "List user sessions", + "operationId": "usersListSessions", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Get the user sessions list by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Sessions List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/sessionList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDocument", - "group": "documents", - "weight": 830, - "cookies": false, - "type": "", - "demo": "vectorsdb\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "method": "listSessions", + "group": "sessions", + "weight": 75, + "cookies": false, + "type": "", + "demo": "users\/list-sessions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.read", + "sessions.read" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md", "auth": { "Project": [] } @@ -67838,78 +68655,165 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create session", + "operationId": "usersCreateSession", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.", + "responses": { + "201": { + "description": "Session", + "schema": { + "$ref": "#\/definitions\/session" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSession", + "group": "sessions", + "weight": 97, + "cookies": false, + "type": "", + "demo": "users\/create-session.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, + } + ] + }, + "delete": { + "summary": "Delete user sessions", + "operationId": "usersDeleteSessions", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "users" + ], + "description": "Delete all user's sessions by using the user's unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSessions", + "group": "sessions", + "weight": 100, + "cookies": false, + "type": "", + "demo": "users\/delete-sessions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "documentId", - "description": "Document ID.", + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "default": [], - "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "" - } - } - } } ] - }, + } + }, + "\/users\/{userId}\/sessions\/{sessionId}": { "delete": { - "summary": "Delete document", - "operationId": "vectorsDBDeleteDocument", + "summary": "Delete user session", + "operationId": "usersDeleteSession", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a document by its unique ID.", + "description": "Delete a user sessions by its unique ID.", "responses": { "204": { "description": "No content" @@ -67917,24 +68821,26 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", - "weight": 834, + "method": "deleteSession", + "group": "sessions", + "weight": 99, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/delete-session.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md", "auth": { "Project": [] } @@ -67942,33 +68848,87 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "sessionId", + "description": "Session ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, + } + ] + } + }, + "\/users\/{userId}\/status": { + "patch": { + "summary": "Update user status", + "operationId": "usersUpdateStatus", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.", + "responses": { + "200": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateStatus", + "group": "users", + "weight": 80, + "cookies": false, + "type": "", + "demo": "users\/update-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "documentId", - "description": "Document ID.", + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -67977,57 +68937,60 @@ "schema": { "type": "object", "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", + "status": { + "type": "boolean", + "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", "default": null, - "x-example": "" + "x-example": false } - } + }, + "required": [ + "status" + ] } } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "\/users\/{userId}\/targets": { "get": { - "summary": "List indexes", - "operationId": "vectorsDBListIndexes", + "summary": "List user targets", + "operationId": "usersListTargets", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "List indexes in the collection.", + "description": "List the messaging targets that are associated with a user.", "responses": { "200": { - "description": "Indexes List", + "description": "Target list", "schema": { - "$ref": "#\/definitions\/indexList" + "$ref": "#\/definitions\/targetList" } } }, "deprecated": false, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 828, + "method": "listTargets", + "group": "targets", + "weight": 78, "cookies": false, "type": "", - "demo": "vectorsdb\/list-indexes.md", + "demo": "users\/list-targets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "targets.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md", "auth": { "Project": [] } @@ -68040,24 +69003,16 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", + "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: userId, providerId, identifier, providerType", "required": false, "type": "array", "collectionFormat": "multi", @@ -68079,8 +69034,8 @@ ] }, "post": { - "summary": "Create index", - "operationId": "vectorsDBCreateIndex", + "summary": "Create user target", + "operationId": "usersCreateTarget", "consumes": [ "application\/json" ], @@ -68088,36 +69043,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "description": "Create a messaging target.", "responses": { - "202": { - "description": "Index", + "201": { + "description": "Target", "schema": { - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/target" } } }, "deprecated": false, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 825, + "method": "createTarget", + "group": "targets", + "weight": 70, "cookies": false, "type": "", - "demo": "vectorsdb\/create-index.md", + "demo": "users\/create-target.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "targets.write", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md", "auth": { "Project": [] } @@ -68130,19 +69085,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -68151,111 +69098,93 @@ "schema": { "type": "object", "properties": { - "key": { + "targetId": { "type": "string", - "description": "Index Key.", + "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": null + "x-example": "" }, - "type": { + "providerType": { "type": "string", - "description": "Index type.", + "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", "default": null, - "x-example": "hnsw_euclidean", + "x-example": "email", "enum": [ - "hnsw_euclidean", - "hnsw_dot", - "hnsw_cosine", - "object", - "key", - "unique" + "email", + "sms", + "push" ], - "x-enum-name": "VectorsDBIndexType", + "x-enum-name": "MessagingProviderType", "x-enum-keys": [] }, - "attributes": { - "type": "array", - "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "identifier": { + "type": "string", + "description": "The target identifier (token, email, phone etc.)", "default": null, - "x-example": null, - "items": { - "type": "string" - } + "x-example": "" }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "default": [], - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } + "providerId": { + "type": "string", + "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", + "default": "", + "x-example": "" }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "default": [], - "x-example": null, - "items": { - "type": "integer" - } + "name": { + "type": "string", + "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "default": "", + "x-example": "" } }, "required": [ - "key", - "type", - "attributes" + "targetId", + "providerType", + "identifier" ] } } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "\/users\/{userId}\/targets\/{targetId}": { "get": { - "summary": "Get index", - "operationId": "vectorsDBGetIndex", + "summary": "Get user target", + "operationId": "usersGetTarget", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get index by ID.", + "description": "Get a user's push notification target by ID.", "responses": { "200": { - "description": "Index", + "description": "Target", "schema": { - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/target" } } }, "deprecated": false, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 826, + "method": "getTarget", + "group": "targets", + "weight": 74, "cookies": false, "type": "", - "demo": "vectorsdb\/get-index.md", + "demo": "users\/get-target.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "targets.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md", "auth": { "Project": [] } @@ -68268,65 +69197,63 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", + "name": "targetId", + "description": "Target ID.", "required": true, "type": "string", + "x-example": "", "in": "path" } ] }, - "delete": { - "summary": "Delete index", - "operationId": "vectorsDBDeleteIndex", + "patch": { + "summary": "Update user target", + "operationId": "usersUpdateTarget", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete an index.", + "description": "Update a messaging target.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Target", + "schema": { + "$ref": "#\/definitions\/target" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 827, + "method": "updateTarget", + "group": "targets", + "weight": 90, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-index.md", + "demo": "users\/update-target.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "targets.write", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md", "auth": { "Project": [] } @@ -68339,261 +69266,242 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "targetId", + "description": "Target ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Index Key.", - "required": true, - "type": "string", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "description": "The target identifier (token, email, phone etc.)", + "default": "", + "x-example": "" + }, + "providerId": { + "type": "string", + "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", + "default": "", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "default": "", + "x-example": "" + } + } + } } ] - } - }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/usage": { - "get": { - "summary": "Get collection usage stats", - "operationId": "vectorsDBGetCollectionUsage", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete user target", + "operationId": "usersDeleteTarget", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "vectorsDB" + "users" ], - "description": "Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Delete a messaging target.", "responses": { - "200": { - "description": "UsageCollection", - "schema": { - "$ref": "#\/definitions\/usageCollection" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getCollectionUsage", - "group": null, - "weight": 824, + "method": "deleteTarget", + "group": "targets", + "weight": 102, "cookies": false, "type": "", - "demo": "vectorsdb\/get-collection-usage.md", + "demo": "users\/delete-target.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "targets.write", "platforms": [ + "server", "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "range", - "description": "Date range.", - "required": false, - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "targetId", + "description": "Target ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/vectorsdb\/{databaseId}\/usage": { - "get": { - "summary": "Get VectorsDB usage stats", - "operationId": "vectorsDBGetUsage", - "consumes": [], + "\/users\/{userId}\/tokens": { + "post": { + "summary": "Create token", + "operationId": "usersCreateToken", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n", "responses": { - "200": { - "description": "UsageVectorsDB", + "201": { + "description": "Token", "schema": { - "$ref": "#\/definitions\/usageVectorsDB" + "$ref": "#\/definitions\/token" } } }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 817, + "method": "createToken", + "group": "sessions", + "weight": 98, "cookies": false, "type": "", - "demo": "vectorsdb\/get-usage.md", + "demo": "users\/create-token.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-database-usage.md", - "methods": [ - { - "name": "getUsage", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "range" - ], - "required": [ - "databaseId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/usageVectorsDB" - } - ], - "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", - "demo": "vectorsdb\/get-usage.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "range", - "description": "Date range.", - "required": false, - "type": "string", - "x-example": "24h", - "enum": [ - "24h", - "30d", - "90d" - ], - "x-enum-name": "UsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], - "default": "30d", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "length": { + "type": "integer", + "description": "Token length in characters. The default length is 6 characters", + "default": 6, + "x-example": 4, + "format": "int32" + }, + "expire": { + "type": "integer", + "description": "Token expiration period in seconds. The default expiration is 15 minutes.", + "default": 900, + "x-example": 60, + "format": "int32" + } + } + } } ] } }, - "\/webhooks": { - "get": { - "summary": "List webhooks", - "operationId": "webhooksList", - "consumes": [], + "\/users\/{userId}\/verification": { + "patch": { + "summary": "Update email verification", + "operationId": "usersUpdateEmailVerification", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "webhooks" + "users" ], - "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "description": "Update the user email verification status by its unique ID.", "responses": { "200": { - "description": "Webhooks List", + "description": "User", "schema": { - "$ref": "#\/definitions\/webhookList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": null, - "weight": 586, + "method": "updateEmailVerification", + "group": "users", + "weight": 88, "cookies": false, "type": "", - "demo": "webhooks\/list.md", + "demo": "users\/update-email-verification.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md", "auth": { "Project": [] } @@ -68606,31 +69514,38 @@ ], "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: name, url, authUsername, tls, events, enabled, logs, attempts", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "emailVerification": { + "type": "boolean", + "description": "User email verification status.", + "default": null, + "x-example": false + } + }, + "required": [ + "emailVerification" + ] + } } ] - }, - "post": { - "summary": "Create webhook", - "operationId": "webhooksCreate", + } + }, + "\/users\/{userId}\/verification\/phone": { + "patch": { + "summary": "Update phone verification", + "operationId": "usersUpdatePhoneVerification", "consumes": [ "application\/json" ], @@ -68638,35 +69553,36 @@ "application\/json" ], "tags": [ - "webhooks" + "users" ], - "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "description": "Update the user phone verification status by its unique ID.", "responses": { - "201": { - "description": "Webhook", + "200": { + "description": "User", "schema": { - "$ref": "#\/definitions\/webhook" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": null, - "weight": 585, + "method": "updatePhoneVerification", + "group": "users", + "weight": 83, "cookies": false, "type": "", - "demo": "webhooks\/create.md", + "demo": "users\/update-phone-verification.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md", "auth": { "Project": [] } @@ -68678,197 +69594,309 @@ } ], "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "webhookId": { - "type": "string", - "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "url": { - "type": "string", - "description": "Webhook URL.", - "default": null, - "x-example": null - }, - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "default": true, - "x-example": false - }, - "tls": { + "phoneVerification": { "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "default": false, - "x-example": false - }, - "authUsername": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "authPassword": { - "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "secret": { - "type": "string", - "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "description": "User phone verification status.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": false } }, "required": [ - "webhookId", - "url", - "name", - "events" + "phoneVerification" ] } } ] } }, - "\/webhooks\/{webhookId}": { - "get": { - "summary": "Get webhook", - "operationId": "webhooksGet", - "consumes": [], + "\/vcs\/github\/installations\/{installationId}\/detections": { + "post": { + "summary": "Create repository detection", + "operationId": "vcsCreateRepositoryDetection", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "webhooks" + "vcs" ], - "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", "responses": { "200": { - "description": "Webhook", + "description": "DetectionRuntime, or DetectionFramework", "schema": { - "$ref": "#\/definitions\/webhook" + "x-oneOf": [ + { + "$ref": "#\/definitions\/detectionRuntime" + }, + { + "$ref": "#\/definitions\/detectionFramework" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "runtime": "#\/definitions\/detectionRuntime", + "framework": "#\/definitions\/detectionFramework" + } + } } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": null, - "weight": 587, + "method": "createRepositoryDetection", + "group": "repositories", + "weight": 564, "cookies": false, "type": "", - "demo": "webhooks\/get.md", + "demo": "vcs\/create-repository-detection.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.read", + "scope": "vcs.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "installationId", + "description": "Installation Id", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - } - ] - }, - "put": { - "summary": "Update webhook", - "operationId": "webhooksUpdate", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "webhooks" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "providerRepositoryId": { + "type": "string", + "description": "Repository Id", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Detector type. Must be one of the following: runtime, framework", + "default": null, + "x-example": "runtime", + "enum": [ + "runtime", + "framework" + ], + "x-enum-name": "VCSDetectionType", + "x-enum-keys": [] + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to Root Directory", + "default": "", + "x-example": "" + } + }, + "required": [ + "providerRepositoryId", + "type" + ] + } + } + ] + } + }, + "\/vcs\/github\/installations\/{installationId}\/providerRepositories": { + "get": { + "summary": "List repositories", + "operationId": "vcsListRepositories", + "consumes": [], + "produces": [ + "application\/json" ], - "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "tags": [ + "vcs" + ], + "description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.", "responses": { "200": { - "description": "Webhook", + "description": "Runtime Provider Repositories List, or Framework Provider Repositories List", "schema": { - "$ref": "#\/definitions\/webhook" + "x-oneOf": [ + { + "$ref": "#\/definitions\/providerRepositoryRuntimeList" + }, + { + "$ref": "#\/definitions\/providerRepositoryFrameworkList" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "runtime": "#\/definitions\/providerRepositoryRuntimeList", + "framework": "#\/definitions\/providerRepositoryFrameworkList" + } + } } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": null, - "weight": 589, + "method": "listRepositories", + "group": "repositories", + "weight": 561, "cookies": false, "type": "", - "demo": "webhooks\/update.md", + "demo": "vcs\/list-repositories.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "vcs.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repositories.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "installationId", + "description": "Installation Id", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "type", + "description": "Detector type. Must be one of the following: runtime, framework", + "required": true, + "type": "string", + "x-example": "runtime", + "enum": [ + "runtime", + "framework" + ], + "x-enum-name": "VCSDetectionType", + "x-enum-keys": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "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). Only supported methods are limit and offset", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + }, + "post": { + "summary": "Create repository", + "operationId": "vcsCreateRepository", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vcs" + ], + "description": "Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.", + "responses": { + "200": { + "description": "ProviderRepository", + "schema": { + "$ref": "#\/definitions\/providerRepository" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createRepository", + "group": "repositories", + "weight": 559, + "cookies": false, + "type": "", + "demo": "vcs\/create-repository.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -68879,172 +69907,306 @@ "properties": { "name": { "type": "string", - "description": "Webhook name. Max length: 128 chars.", + "description": "Repository name (slug)", "default": null, "x-example": "" }, - "url": { - "type": "string", - "description": "Webhook URL.", - "default": null, - "x-example": null - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "default": true, - "x-example": false - }, - "tls": { + "private": { "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "default": false, + "description": "Mark repository public or private", + "default": null, "x-example": false - }, - "authUsername": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "authPassword": { - "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "default": "", - "x-example": "" } }, "required": [ "name", - "url", - "events" + "private" ] } } ] - }, - "delete": { - "summary": "Delete webhook", - "operationId": "webhooksDelete", - "consumes": [ + } + }, + "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}": { + "get": { + "summary": "Get repository", + "operationId": "vcsGetRepository", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "webhooks" + "vcs" ], - "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "description": "Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ProviderRepository", + "schema": { + "$ref": "#\/definitions\/providerRepository" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": null, - "weight": 588, + "method": "getRepository", + "group": "repositories", + "weight": 560, "cookies": false, "type": "", - "demo": "webhooks\/delete.md", + "demo": "vcs\/get-repository.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "vcs.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "installationId", + "description": "Installation Id", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "providerRepositoryId", + "description": "Repository Id", + "required": true, + "type": "string", + "x-example": "", "in": "path" } ] } }, - "\/webhooks\/{webhookId}\/secret": { - "patch": { - "summary": "Update webhook secret key", - "operationId": "webhooksUpdateSecret", - "consumes": [ + "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches": { + "get": { + "summary": "List repository branches", + "operationId": "vcsListRepositoryBranches", + "consumes": [], + "produces": [ "application\/json" ], + "tags": [ + "vcs" + ], + "description": "Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n", + "responses": { + "200": { + "description": "Branches List", + "schema": { + "$ref": "#\/definitions\/branchList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listRepositoryBranches", + "group": "repositories", + "weight": 562, + "cookies": false, + "type": "", + "demo": "vcs\/list-repository-branches.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repository-branches.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "providerRepositoryId", + "description": "Repository Id", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents": { + "get": { + "summary": "Get files and directories of a VCS repository", + "operationId": "vcsGetRepositoryContents", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "webhooks" + "vcs" ], - "description": "Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.", + "description": "Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", "responses": { "200": { - "description": "Webhook", + "description": "VCS Content List", "schema": { - "$ref": "#\/definitions\/webhook" + "$ref": "#\/definitions\/vcsContentList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSecret", - "group": null, - "weight": 590, + "method": "getRepositoryContents", + "group": "repositories", + "weight": 563, "cookies": false, "type": "", - "demo": "webhooks\/update-secret.md", + "demo": "vcs\/get-repository-contents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "vcs.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository-contents.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "installationId", + "description": "Installation Id", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "providerRepositoryId", + "description": "Repository Id", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "providerRootDirectory", + "description": "Path to get contents of nested directory", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "providerReference", + "description": "Git reference (branch, tag, commit) to get contents from", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + } + ] + } + }, + "\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": { + "patch": { + "summary": "Update external deployment (authorize)", + "operationId": "vcsUpdateExternalDeployments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vcs" + ], + "description": "Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateExternalDeployments", + "group": "repositories", + "weight": 1197, + "cookies": false, + "type": "", + "demo": "vcs\/update-external-deployments.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/update-external-deployments.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "repositoryId", + "description": "VCS Repository Id", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -69053,1805 +70215,8355 @@ "schema": { "type": "object", "properties": { - "secret": { + "providerPullRequestId": { "type": "string", - "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "description": "GitHub Pull Request Id", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" } - } + }, + "required": [ + "providerPullRequestId" + ] } } ] } - } - }, - "tags": [ - { - "name": "account", - "description": "The Account service allows you to authenticate and manage a user account." - }, - { - "name": "avatars", - "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." - }, - { - "name": "databases", - "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" - }, - { - "name": "tablesdb", - "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" }, - { + "\/vcs\/installations": { + "get": { + "summary": "List installations", + "operationId": "vcsListInstallations", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vcs" + ], + "description": "List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.\n", + "responses": { + "200": { + "description": "Installations List", + "schema": { + "$ref": "#\/definitions\/installationList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listInstallations", + "group": "installations", + "weight": 557, + "cookies": false, + "type": "", + "demo": "vcs\/list-installations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md", + "auth": { + "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: provider, organization", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + } + }, + "\/vcs\/installations\/{installationId}": { + "get": { + "summary": "Get installation", + "operationId": "vcsGetInstallation", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vcs" + ], + "description": "Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. ", + "responses": { + "200": { + "description": "Installation", + "schema": { + "$ref": "#\/definitions\/installation" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getInstallation", + "group": "installations", + "weight": 556, + "cookies": false, + "type": "", + "demo": "vcs\/get-installation.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete installation", + "operationId": "vcsDeleteInstallation", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vcs" + ], + "description": "Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteInstallation", + "group": "installations", + "weight": 558, + "cookies": false, + "type": "", + "demo": "vcs\/delete-installation.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vectorsdb": { + "get": { + "summary": "List databases", + "operationId": "vectorsDBList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Databases List", + "schema": { + "$ref": "#\/definitions\/databaseList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": "vectorsdb", + "weight": 868, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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 columns: name", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create database", + "operationId": "vectorsDBCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new Database.\n", + "responses": { + "201": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": "vectorsdb", + "weight": 864, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "databaseId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "databaseId", + "name" + ] + } + } + ] + } + }, + "\/vectorsdb\/embeddings\/text": { + "post": { + "summary": "Create Text Embeddings", + "operationId": "vectorsDBCreateTextEmbeddings", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "200": { + "description": "Embedding list", + "schema": { + "$ref": "#\/definitions\/embeddingList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTextEmbeddings", + "group": "documents", + "weight": 890, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-text-embeddings.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "methods": [ + { + "name": "createTextEmbeddings", + "namespace": "vectorsDB", + "desc": "Create Text Embedding", + "auth": { + "Project": [] + }, + "parameters": [ + "texts", + "model" + ], + "required": [ + "texts" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/embeddingList" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-text-embeddings.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "texts": { + "type": "array", + "description": "Array of text to generate embeddings.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "model": { + "type": "string", + "description": "The embedding model to use for generating vector embeddings.", + "default": "embeddinggemma", + "x-example": "embeddinggemma", + "enum": [ + "embeddinggemma" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "texts" + ] + } + } + ] + } + }, + "\/vectorsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "vectorsDBListTransactions", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "List transactions across all databases.", + "responses": { + "200": { + "description": "Transaction List", + "schema": { + "$ref": "#\/definitions\/transactionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "weight": 895, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-transactions.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "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).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + }, + "post": { + "summary": "Create transaction", + "operationId": "vectorsDBCreateTransaction", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new transaction.", + "responses": { + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 891, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60, + "format": "int32" + } + } + } + } + ] + } + }, + "\/vectorsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "vectorsDBGetTransaction", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a transaction by its unique ID.", + "responses": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransaction", + "group": "transactions", + "weight": 892, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "patch": { + "summary": "Update transaction", + "operationId": "vectorsDBUpdateTransaction", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update a transaction, to either commit or roll back its operations.", + "responses": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "weight": 893, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "default": false, + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete transaction", + "operationId": "vectorsDBDeleteTransaction", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 894, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vectorsdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "vectorsDBCreateOperations", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create multiple operations in a single transaction.", + "responses": { + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 896, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-operations.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "operations": { + "type": "array", + "description": "Array of staged operations.", + "default": [], + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + ] + } + }, + "\/vectorsdb\/usage": { + "get": { + "summary": "Get VectorsDB usage stats", + "operationId": "vectorsDBListUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageVectorsDBs", + "schema": { + "$ref": "#\/definitions\/usageVectorsDBs" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listUsage", + "group": null, + "weight": 870, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-usage.md", + "methods": [ + { + "name": "listUsage", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "range" + ], + "required": [], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/usageVectorsDBs" + } + ], + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "vectorsdb\/list-usage.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "range", + "description": "Date range.", + "required": false, + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" + } + ] + } + }, + "\/vectorsdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "vectorsDBGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "vectorsdb", + "weight": 865, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update database", + "operationId": "vectorsDBUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update a database by its unique ID.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": "vectorsdb", + "weight": 866, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete database", + "operationId": "vectorsDBDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "vectorsdb", + "weight": 867, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections": { + "get": { + "summary": "List collections", + "operationId": "vectorsDBListCollections", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "VectorsDB Collections List", + "schema": { + "$ref": "#\/definitions\/vectorsdbCollectionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollections", + "group": "collections", + "weight": 875, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-collections.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-collections.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create collection", + "operationId": "vectorsDBCreateCollection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "VectorsDB Collection", + "schema": { + "$ref": "#\/definitions\/vectorsdbCollection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createCollection", + "group": "collections", + "weight": 871, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "collectionId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Collection name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimension.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "collectionId", + "name", + "dimension" + ] + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}": { + "get": { + "summary": "Get collection", + "operationId": "vectorsDBGetCollection", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "responses": { + "200": { + "description": "VectorsDB Collection", + "schema": { + "$ref": "#\/definitions\/vectorsdbCollection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollection", + "group": "collections", + "weight": 872, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update collection", + "operationId": "vectorsDBUpdateCollection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update a collection by its unique ID.", + "responses": { + "200": { + "description": "VectorsDB Collection", + "schema": { + "$ref": "#\/definitions\/vectorsdbCollection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateCollection", + "group": "collections", + "weight": 873, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Collection name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimensions.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete collection", + "operationId": "vectorsDBDeleteCollection", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteCollection", + "group": "collections", + "weight": 874, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "vectorsDBListDocuments", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDocuments", + "group": "documents", + "weight": 885, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-documents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "vectorsDBCreateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 881, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "vectorsDB", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-document.md", + "public": true + }, + { + "name": "createDocuments", + "namespace": "vectorsDB", + "desc": "Create documents", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-documents.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "documentId": { + "type": "string", + "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": [], + "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "put": { + "summary": "Upsert documents", + "operationId": "vectorsDBUpsertDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 888, + "cookies": false, + "type": "", + "demo": "vectorsdb\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-documents.md", + "methods": [ + { + "name": "upsertDocuments", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "demo": "vectorsdb\/upsert-documents.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + }, + "required": [ + "documents" + ] + } + } + ] + }, + "patch": { + "summary": "Update documents", + "operationId": "vectorsDBUpdateDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 887, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete documents", + "operationId": "vectorsDBDeleteDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 889, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "vectorsDBGetDocument", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 884, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + } + ] + }, + "put": { + "summary": "Upsert a document", + "operationId": "vectorsDBUpsertDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 883, + "cookies": false, + "type": "", + "demo": "vectorsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/upsert-document.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "patch": { + "summary": "Update document", + "operationId": "vectorsDBUpdateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 882, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete document", + "operationId": "vectorsDBDeleteDocument", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 886, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "vectorsDBListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "schema": { + "$ref": "#\/definitions\/indexList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 880, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-indexes.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "vectorsDBCreateIndex", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "responses": { + "202": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/index" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 877, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-index.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "default": null, + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "default": null, + "x-example": "hnsw_euclidean", + "enum": [ + "hnsw_euclidean", + "hnsw_dot", + "hnsw_cosine", + "object", + "key", + "unique" + ], + "x-enum-name": "VectorsDBIndexType", + "x-enum-keys": [] + }, + "attributes": { + "type": "array", + "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "attributes" + ] + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "vectorsDBGetIndex", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/index" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 878, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-index.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "vectorsDBDeleteIndex", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 879, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-index.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/usage": { + "get": { + "summary": "Get collection usage stats", + "operationId": "vectorsDBGetCollectionUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageCollection", + "schema": { + "$ref": "#\/definitions\/usageCollection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollectionUsage", + "group": null, + "weight": 876, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-collection-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection-usage.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/usage": { + "get": { + "summary": "Get VectorsDB usage stats", + "operationId": "vectorsDBGetUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageVectorsDB", + "schema": { + "$ref": "#\/definitions\/usageVectorsDB" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getUsage", + "group": null, + "weight": 869, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-database-usage.md", + "methods": [ + { + "name": "getUsage", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "range" + ], + "required": [ + "databaseId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/usageVectorsDB" + } + ], + "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "vectorsdb\/get-usage.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d", + "in": "query" + } + ] + } + }, + "\/webhooks": { + "get": { + "summary": "List webhooks", + "operationId": "webhooksList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Webhooks List", + "schema": { + "$ref": "#\/definitions\/webhookList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 567, + "cookies": false, + "type": "", + "demo": "webhooks\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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: name, url, authUsername, tls, events, enabled, logs, attempts", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create webhook", + "operationId": "webhooksCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "responses": { + "201": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 566, + "cookies": false, + "type": "", + "demo": "webhooks\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "webhookId": { + "type": "string", + "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "default": null, + "x-example": null + }, + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "default": true, + "x-example": false + }, + "tls": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "default": false, + "x-example": false + }, + "authUsername": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "authPassword": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "secret": { + "type": "string", + "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "default": null, + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "webhookId", + "url", + "name", + "events" + ] + } + } + ] + } + }, + "\/webhooks\/{webhookId}": { + "get": { + "summary": "Get webhook", + "operationId": "webhooksGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 568, + "cookies": false, + "type": "", + "demo": "webhooks\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update webhook", + "operationId": "webhooksUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 570, + "cookies": false, + "type": "", + "demo": "webhooks\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "default": null, + "x-example": null + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "default": true, + "x-example": false + }, + "tls": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "default": false, + "x-example": false + }, + "authUsername": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "authPassword": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "url", + "events" + ] + } + } + ] + }, + "delete": { + "summary": "Delete webhook", + "operationId": "webhooksDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "webhooks" + ], + "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 569, + "cookies": false, + "type": "", + "demo": "webhooks\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/webhooks\/{webhookId}\/secret": { + "patch": { + "summary": "Update webhook secret key", + "operationId": "webhooksUpdateSecret", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSecret", + "group": null, + "weight": 571, + "cookies": false, + "type": "", + "demo": "webhooks\/update-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "secret": { + "type": "string", + "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } + } + ] + } + } + }, + "tags": [ + { + "name": "account", + "description": "The Account service allows you to authenticate and manage a user account." + }, + { + "name": "avatars", + "description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars." + }, + { + "name": "databases", + "description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents" + }, + { + "name": "tablesdb", + "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows" + }, + { "name": "locale", "description": "The Locale service allows you to customize your app based on your users' location." }, - { - "name": "health", - "description": "The Health service allows you to both validate and monitor your Appwrite server's health." + { + "name": "health", + "description": "The Health service allows you to both validate and monitor your Appwrite server's health." + }, + { + "name": "projects", + "description": "The Project service allows you to manage all the projects in your Appwrite server." + }, + { + "name": "project", + "description": "The Project service allows you to manage all the projects in your Appwrite server." + }, + { + "name": "storage", + "description": "The Storage service allows you to manage your project files." + }, + { + "name": "teams", + "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" + }, + { + "name": "users", + "description": "The Users service allows you to manage your project users." + }, + { + "name": "sites", + "description": "The Sites Service allows you view, create and manage your web applications." + }, + { + "name": "functions", + "description": "The Functions Service allows you view, create and manage your Cloud Functions." + }, + { + "name": "proxy", + "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." + }, + { + "name": "graphql", + "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." + }, + { + "name": "console", + "description": "The Console service allows you to interact with console relevant information." + }, + { + "name": "migrations", + "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." + }, + { + "name": "messaging", + "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." + } + ], + "definitions": { + "any": { + "description": "Any", + "type": "object", + "additionalProperties": true, + "example": [] + }, + "rowList": { + "description": "Rows List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rows that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rows": { + "type": "array", + "description": "List of rows.", + "items": { + "type": "object", + "$ref": "#\/definitions\/row" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rows" + ], + "example": { + "total": 5, + "rows": "" + } + }, + "documentList": { + "description": "Documents List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of documents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "documents": { + "type": "array", + "description": "List of documents.", + "items": { + "type": "object", + "$ref": "#\/definitions\/document" + }, + "x-example": "" + } + }, + "required": [ + "total", + "documents" + ], + "example": { + "total": 5, + "documents": "" + } + }, + "tableList": { + "description": "Tables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tables that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tables": { + "type": "array", + "description": "List of tables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/table" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tables" + ], + "example": { + "total": 5, + "tables": "" + } + }, + "collectionList": { + "description": "Collections List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of collections that matched your query.", + "x-example": 5, + "format": "int32" + }, + "collections": { + "type": "array", + "description": "List of collections.", + "items": { + "type": "object", + "$ref": "#\/definitions\/collection" + }, + "x-example": "" + } + }, + "required": [ + "total", + "collections" + ], + "example": { + "total": 5, + "collections": "" + } + }, + "databaseList": { + "description": "Databases List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of databases that matched your query.", + "x-example": 5, + "format": "int32" + }, + "databases": { + "type": "array", + "description": "List of databases.", + "items": { + "type": "object", + "$ref": "#\/definitions\/database" + }, + "x-example": "" + } + }, + "required": [ + "total", + "databases" + ], + "example": { + "total": 5, + "databases": "" + } + }, + "indexList": { + "description": "Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/index" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ], + "example": { + "total": 5, + "indexes": "" + } + }, + "columnIndexList": { + "description": "Column Indexes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of indexes that matched your query.", + "x-example": 5, + "format": "int32" + }, + "indexes": { + "type": "array", + "description": "List of indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": "" + } + }, + "required": [ + "total", + "indexes" + ], + "example": { + "total": 5, + "indexes": "" + } + }, + "userList": { + "description": "Users List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of users that matched your query.", + "x-example": 5, + "format": "int32" + }, + "users": { + "type": "array", + "description": "List of users.", + "items": { + "type": "object", + "$ref": "#\/definitions\/user" + }, + "x-example": "" + } + }, + "required": [ + "total", + "users" + ], + "example": { + "total": 5, + "users": "" + } + }, + "sessionList": { + "description": "Sessions List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of sessions that matched your query.", + "x-example": 5, + "format": "int32" + }, + "sessions": { + "type": "array", + "description": "List of sessions.", + "items": { + "type": "object", + "$ref": "#\/definitions\/session" + }, + "x-example": "" + } + }, + "required": [ + "total", + "sessions" + ], + "example": { + "total": 5, + "sessions": "" + } + }, + "identityList": { + "description": "Identities List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of identities that matched your query.", + "x-example": 5, + "format": "int32" + }, + "identities": { + "type": "array", + "description": "List of identities.", + "items": { + "type": "object", + "$ref": "#\/definitions\/identity" + }, + "x-example": "" + } + }, + "required": [ + "total", + "identities" + ], + "example": { + "total": 5, + "identities": "" + } + }, + "logList": { + "description": "Logs List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of logs that matched your query.", + "x-example": 5, + "format": "int32" + }, + "logs": { + "type": "array", + "description": "List of logs.", + "items": { + "type": "object", + "$ref": "#\/definitions\/log" + }, + "x-example": "" + } + }, + "required": [ + "total", + "logs" + ], + "example": { + "total": 5, + "logs": "" + } + }, + "fileList": { + "description": "Files List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of files that matched your query.", + "x-example": 5, + "format": "int32" + }, + "files": { + "type": "array", + "description": "List of files.", + "items": { + "type": "object", + "$ref": "#\/definitions\/file" + }, + "x-example": "" + } + }, + "required": [ + "total", + "files" + ], + "example": { + "total": 5, + "files": "" + } + }, + "bucketList": { + "description": "Buckets List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of buckets that matched your query.", + "x-example": 5, + "format": "int32" + }, + "buckets": { + "type": "array", + "description": "List of buckets.", + "items": { + "type": "object", + "$ref": "#\/definitions\/bucket" + }, + "x-example": "" + } + }, + "required": [ + "total", + "buckets" + ], + "example": { + "total": 5, + "buckets": "" + } + }, + "resourceTokenList": { + "description": "Resource Tokens List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of tokens that matched your query.", + "x-example": 5, + "format": "int32" + }, + "tokens": { + "type": "array", + "description": "List of tokens.", + "items": { + "type": "object", + "$ref": "#\/definitions\/resourceToken" + }, + "x-example": "" + } + }, + "required": [ + "total", + "tokens" + ], + "example": { + "total": 5, + "tokens": "" + } + }, + "teamList": { + "description": "Teams List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of teams that matched your query.", + "x-example": 5, + "format": "int32" + }, + "teams": { + "type": "array", + "description": "List of teams.", + "items": { + "type": "object", + "$ref": "#\/definitions\/team" + }, + "x-example": "" + } + }, + "required": [ + "total", + "teams" + ], + "example": { + "total": 5, + "teams": "" + } + }, + "membershipList": { + "description": "Memberships List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of memberships that matched your query.", + "x-example": 5, + "format": "int32" + }, + "memberships": { + "type": "array", + "description": "List of memberships.", + "items": { + "type": "object", + "$ref": "#\/definitions\/membership" + }, + "x-example": "" + } + }, + "required": [ + "total", + "memberships" + ], + "example": { + "total": 5, + "memberships": "" + } + }, + "siteList": { + "description": "Sites List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of sites that matched your query.", + "x-example": 5, + "format": "int32" + }, + "sites": { + "type": "array", + "description": "List of sites.", + "items": { + "type": "object", + "$ref": "#\/definitions\/site" + }, + "x-example": "" + } + }, + "required": [ + "total", + "sites" + ], + "example": { + "total": 5, + "sites": "" + } + }, + "templateSiteList": { + "description": "Site Templates List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of templates that matched your query.", + "x-example": 5, + "format": "int32" + }, + "templates": { + "type": "array", + "description": "List of templates.", + "items": { + "type": "object", + "$ref": "#\/definitions\/templateSite" + }, + "x-example": "" + } + }, + "required": [ + "total", + "templates" + ], + "example": { + "total": 5, + "templates": "" + } + }, + "functionList": { + "description": "Functions List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of functions that matched your query.", + "x-example": 5, + "format": "int32" + }, + "functions": { + "type": "array", + "description": "List of functions.", + "items": { + "type": "object", + "$ref": "#\/definitions\/function" + }, + "x-example": "" + } + }, + "required": [ + "total", + "functions" + ], + "example": { + "total": 5, + "functions": "" + } + }, + "templateFunctionList": { + "description": "Function Templates List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of templates that matched your query.", + "x-example": 5, + "format": "int32" + }, + "templates": { + "type": "array", + "description": "List of templates.", + "items": { + "type": "object", + "$ref": "#\/definitions\/templateFunction" + }, + "x-example": "" + } + }, + "required": [ + "total", + "templates" + ], + "example": { + "total": 5, + "templates": "" + } }, - { - "name": "projects", - "description": "The Project service allows you to manage all the projects in your Appwrite server." + "installationList": { + "description": "Installations List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of installations that matched your query.", + "x-example": 5, + "format": "int32" + }, + "installations": { + "type": "array", + "description": "List of installations.", + "items": { + "type": "object", + "$ref": "#\/definitions\/installation" + }, + "x-example": "" + } + }, + "required": [ + "total", + "installations" + ], + "example": { + "total": 5, + "installations": "" + } }, - { - "name": "project", - "description": "The Project service allows you to manage all the projects in your Appwrite server." + "providerRepositoryFrameworkList": { + "description": "Framework Provider Repositories List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of frameworkProviderRepositories that matched your query.", + "x-example": 5, + "format": "int32" + }, + "frameworkProviderRepositories": { + "type": "array", + "description": "List of frameworkProviderRepositories.", + "items": { + "type": "object", + "$ref": "#\/definitions\/providerRepositoryFramework" + }, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Provider repository list type.", + "x-example": "framework" + } + }, + "required": [ + "total", + "frameworkProviderRepositories", + "type" + ], + "example": { + "total": 5, + "frameworkProviderRepositories": "", + "type": "framework" + } }, - { - "name": "storage", - "description": "The Storage service allows you to manage your project files." + "providerRepositoryRuntimeList": { + "description": "Runtime Provider Repositories List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of runtimeProviderRepositories that matched your query.", + "x-example": 5, + "format": "int32" + }, + "runtimeProviderRepositories": { + "type": "array", + "description": "List of runtimeProviderRepositories.", + "items": { + "type": "object", + "$ref": "#\/definitions\/providerRepositoryRuntime" + }, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Provider repository list type.", + "x-example": "runtime" + } + }, + "required": [ + "total", + "runtimeProviderRepositories", + "type" + ], + "example": { + "total": 5, + "runtimeProviderRepositories": "", + "type": "runtime" + } }, - { - "name": "teams", - "description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources" + "branchList": { + "description": "Branches List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of branches that matched your query.", + "x-example": 5, + "format": "int32" + }, + "branches": { + "type": "array", + "description": "List of branches.", + "items": { + "type": "object", + "$ref": "#\/definitions\/branch" + }, + "x-example": "" + } + }, + "required": [ + "total", + "branches" + ], + "example": { + "total": 5, + "branches": "" + } + }, + "frameworkList": { + "description": "Frameworks List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of frameworks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "frameworks": { + "type": "array", + "description": "List of frameworks.", + "items": { + "type": "object", + "$ref": "#\/definitions\/framework" + }, + "x-example": "" + } + }, + "required": [ + "total", + "frameworks" + ], + "example": { + "total": 5, + "frameworks": "" + } + }, + "runtimeList": { + "description": "Runtimes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of runtimes that matched your query.", + "x-example": 5, + "format": "int32" + }, + "runtimes": { + "type": "array", + "description": "List of runtimes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/runtime" + }, + "x-example": "" + } + }, + "required": [ + "total", + "runtimes" + ], + "example": { + "total": 5, + "runtimes": "" + } + }, + "deploymentList": { + "description": "Deployments List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of deployments that matched your query.", + "x-example": 5, + "format": "int32" + }, + "deployments": { + "type": "array", + "description": "List of deployments.", + "items": { + "type": "object", + "$ref": "#\/definitions\/deployment" + }, + "x-example": "" + } + }, + "required": [ + "total", + "deployments" + ], + "example": { + "total": 5, + "deployments": "" + } + }, + "executionList": { + "description": "Executions List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of executions that matched your query.", + "x-example": 5, + "format": "int32" + }, + "executions": { + "type": "array", + "description": "List of executions.", + "items": { + "type": "object", + "$ref": "#\/definitions\/execution" + }, + "x-example": "" + } + }, + "required": [ + "total", + "executions" + ], + "example": { + "total": 5, + "executions": "" + } + }, + "projectList": { + "description": "Projects List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of projects that matched your query.", + "x-example": 5, + "format": "int32" + }, + "projects": { + "type": "array", + "description": "List of projects.", + "items": { + "type": "object", + "$ref": "#\/definitions\/project" + }, + "x-example": "" + } + }, + "required": [ + "total", + "projects" + ], + "example": { + "total": 5, + "projects": "" + } + }, + "webhookList": { + "description": "Webhooks List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of webhooks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "webhooks": { + "type": "array", + "description": "List of webhooks.", + "items": { + "type": "object", + "$ref": "#\/definitions\/webhook" + }, + "x-example": "" + } + }, + "required": [ + "total", + "webhooks" + ], + "example": { + "total": 5, + "webhooks": "" + } + }, + "keyList": { + "description": "API Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of keys that matched your query.", + "x-example": 5, + "format": "int32" + }, + "keys": { + "type": "array", + "description": "List of keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/key" + }, + "x-example": "" + } + }, + "required": [ + "total", + "keys" + ], + "example": { + "total": 5, + "keys": "" + } + }, + "devKeyList": { + "description": "Dev Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of devKeys that matched your query.", + "x-example": 5, + "format": "int32" + }, + "devKeys": { + "type": "array", + "description": "List of devKeys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/devKey" + }, + "x-example": "" + } + }, + "required": [ + "total", + "devKeys" + ], + "example": { + "total": 5, + "devKeys": "" + } + }, + "countryList": { + "description": "Countries List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of countries that matched your query.", + "x-example": 5, + "format": "int32" + }, + "countries": { + "type": "array", + "description": "List of countries.", + "items": { + "type": "object", + "$ref": "#\/definitions\/country" + }, + "x-example": "" + } + }, + "required": [ + "total", + "countries" + ], + "example": { + "total": 5, + "countries": "" + } + }, + "continentList": { + "description": "Continents List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of continents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "continents": { + "type": "array", + "description": "List of continents.", + "items": { + "type": "object", + "$ref": "#\/definitions\/continent" + }, + "x-example": "" + } + }, + "required": [ + "total", + "continents" + ], + "example": { + "total": 5, + "continents": "" + } + }, + "languageList": { + "description": "Languages List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of languages that matched your query.", + "x-example": 5, + "format": "int32" + }, + "languages": { + "type": "array", + "description": "List of languages.", + "items": { + "type": "object", + "$ref": "#\/definitions\/language" + }, + "x-example": "" + } + }, + "required": [ + "total", + "languages" + ], + "example": { + "total": 5, + "languages": "" + } + }, + "currencyList": { + "description": "Currencies List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of currencies that matched your query.", + "x-example": 5, + "format": "int32" + }, + "currencies": { + "type": "array", + "description": "List of currencies.", + "items": { + "type": "object", + "$ref": "#\/definitions\/currency" + }, + "x-example": "" + } + }, + "required": [ + "total", + "currencies" + ], + "example": { + "total": 5, + "currencies": "" + } }, - { - "name": "users", - "description": "The Users service allows you to manage your project users." + "phoneList": { + "description": "Phones List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of phones that matched your query.", + "x-example": 5, + "format": "int32" + }, + "phones": { + "type": "array", + "description": "List of phones.", + "items": { + "type": "object", + "$ref": "#\/definitions\/phone" + }, + "x-example": "" + } + }, + "required": [ + "total", + "phones" + ], + "example": { + "total": 5, + "phones": "" + } }, - { - "name": "sites", - "description": "The Sites Service allows you view, create and manage your web applications." + "variableList": { + "description": "Variables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of variables that matched your query.", + "x-example": 5, + "format": "int32" + }, + "variables": { + "type": "array", + "description": "List of variables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/variable" + }, + "x-example": "" + } + }, + "required": [ + "total", + "variables" + ], + "example": { + "total": 5, + "variables": "" + } }, - { - "name": "functions", - "description": "The Functions Service allows you view, create and manage your Cloud Functions." + "mockNumberList": { + "description": "Mock Numbers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of mockNumbers that matched your query.", + "x-example": 5, + "format": "int32" + }, + "mockNumbers": { + "type": "array", + "description": "List of mockNumbers.", + "items": { + "type": "object", + "$ref": "#\/definitions\/mockNumber" + }, + "x-example": "" + } + }, + "required": [ + "total", + "mockNumbers" + ], + "example": { + "total": 5, + "mockNumbers": "" + } }, - { - "name": "proxy", - "description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration." + "policyList": { + "description": "Policies List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of policies in the given project.", + "x-example": 9, + "format": "int32" + }, + "policies": { + "type": "array", + "description": "List of policies.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/policyPasswordDictionary" + }, + { + "$ref": "#\/definitions\/policyPasswordHistory" + }, + { + "$ref": "#\/definitions\/policyPasswordPersonalData" + }, + { + "$ref": "#\/definitions\/policySessionAlert" + }, + { + "$ref": "#\/definitions\/policySessionDuration" + }, + { + "$ref": "#\/definitions\/policySessionInvalidation" + }, + { + "$ref": "#\/definitions\/policySessionLimit" + }, + { + "$ref": "#\/definitions\/policyUserLimit" + }, + { + "$ref": "#\/definitions\/policyMembershipPrivacy" + } + ], + "x-discriminator": { + "propertyName": "$id", + "mapping": { + "password-dictionary": "#\/definitions\/policyPasswordDictionary", + "password-history": "#\/definitions\/policyPasswordHistory", + "password-personal-data": "#\/definitions\/policyPasswordPersonalData", + "session-alert": "#\/definitions\/policySessionAlert", + "session-duration": "#\/definitions\/policySessionDuration", + "session-invalidation": "#\/definitions\/policySessionInvalidation", + "session-limit": "#\/definitions\/policySessionLimit", + "user-limit": "#\/definitions\/policyUserLimit", + "membership-privacy": "#\/definitions\/policyMembershipPrivacy" + } + } + }, + "x-example": "" + } + }, + "required": [ + "total", + "policies" + ], + "example": { + "total": 9, + "policies": "" + } }, - { - "name": "graphql", - "description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL." + "emailTemplateList": { + "description": "Email Templates List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of templates that matched your query.", + "x-example": 5, + "format": "int32" + }, + "templates": { + "type": "array", + "description": "List of templates.", + "items": { + "type": "object", + "$ref": "#\/definitions\/emailTemplate" + }, + "x-example": "" + } + }, + "required": [ + "total", + "templates" + ], + "example": { + "total": 5, + "templates": "" + } }, - { - "name": "console", - "description": "The Console service allows you to interact with console relevant information." + "healthStatusList": { + "description": "Status List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of statuses that matched your query.", + "x-example": 5, + "format": "int32" + }, + "statuses": { + "type": "array", + "description": "List of statuses.", + "items": { + "type": "object", + "$ref": "#\/definitions\/healthStatus" + }, + "x-example": "" + } + }, + "required": [ + "total", + "statuses" + ], + "example": { + "total": 5, + "statuses": "" + } }, - { - "name": "migrations", - "description": "The Migrations service allows you to migrate third-party data to your Appwrite project." + "proxyRuleList": { + "description": "Rule List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of rules that matched your query.", + "x-example": 5, + "format": "int32" + }, + "rules": { + "type": "array", + "description": "List of rules.", + "items": { + "type": "object", + "$ref": "#\/definitions\/proxyRule" + }, + "x-example": "" + } + }, + "required": [ + "total", + "rules" + ], + "example": { + "total": 5, + "rules": "" + } }, - { - "name": "messaging", - "description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)." - } - ], - "definitions": { - "any": { - "description": "Any", + "scheduleList": { + "description": "Schedules List", "type": "object", - "additionalProperties": true, - "example": [] + "properties": { + "total": { + "type": "integer", + "description": "Total number of schedules that matched your query.", + "x-example": 5, + "format": "int32" + }, + "schedules": { + "type": "array", + "description": "List of schedules.", + "items": { + "type": "object", + "$ref": "#\/definitions\/schedule" + }, + "x-example": "" + } + }, + "required": [ + "total", + "schedules" + ], + "example": { + "total": 5, + "schedules": "" + } }, - "rowList": { - "description": "Rows List", + "localeCodeList": { + "description": "Locale codes list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of rows that matched your query.", + "description": "Total number of localeCodes that matched your query.", "x-example": 5, "format": "int32" }, - "rows": { + "localeCodes": { "type": "array", - "description": "List of rows.", + "description": "List of localeCodes.", "items": { "type": "object", - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/localeCode" }, "x-example": "" } }, "required": [ "total", - "rows" + "localeCodes" ], "example": { "total": 5, - "rows": "" + "localeCodes": "" } }, - "documentList": { - "description": "Documents List", + "providerList": { + "description": "Provider list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of documents that matched your query.", + "description": "Total number of providers that matched your query.", "x-example": 5, "format": "int32" }, - "documents": { + "providers": { "type": "array", - "description": "List of documents.", + "description": "List of providers.", "items": { "type": "object", - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/provider" }, "x-example": "" } }, "required": [ "total", - "documents" + "providers" ], "example": { "total": 5, - "documents": "" + "providers": "" } }, - "tableList": { - "description": "Tables List", + "messageList": { + "description": "Message list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of tables that matched your query.", + "description": "Total number of messages that matched your query.", "x-example": 5, "format": "int32" }, - "tables": { + "messages": { "type": "array", - "description": "List of tables.", + "description": "List of messages.", "items": { "type": "object", - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/message" }, "x-example": "" } }, "required": [ "total", - "tables" + "messages" ], "example": { "total": 5, - "tables": "" + "messages": "" } }, - "collectionList": { - "description": "Collections List", + "topicList": { + "description": "Topic list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of collections that matched your query.", + "description": "Total number of topics that matched your query.", "x-example": 5, "format": "int32" }, - "collections": { + "topics": { "type": "array", - "description": "List of collections.", + "description": "List of topics.", "items": { "type": "object", - "$ref": "#\/definitions\/collection" + "$ref": "#\/definitions\/topic" }, "x-example": "" } }, "required": [ "total", - "collections" + "topics" ], "example": { "total": 5, - "collections": "" + "topics": "" } }, - "databaseList": { - "description": "Databases List", + "subscriberList": { + "description": "Subscriber list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of databases that matched your query.", + "description": "Total number of subscribers that matched your query.", "x-example": 5, "format": "int32" }, - "databases": { + "subscribers": { "type": "array", - "description": "List of databases.", + "description": "List of subscribers.", "items": { "type": "object", - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/subscriber" }, "x-example": "" } }, "required": [ "total", - "databases" + "subscribers" ], "example": { "total": 5, - "databases": "" + "subscribers": "" } }, - "indexList": { - "description": "Indexes List", + "targetList": { + "description": "Target list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of indexes that matched your query.", + "description": "Total number of targets that matched your query.", "x-example": 5, "format": "int32" }, - "indexes": { + "targets": { "type": "array", - "description": "List of indexes.", + "description": "List of targets.", "items": { "type": "object", - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/target" }, "x-example": "" } }, "required": [ "total", - "indexes" + "targets" ], "example": { "total": 5, - "indexes": "" + "targets": "" } }, - "columnIndexList": { - "description": "Column Indexes List", + "transactionList": { + "description": "Transaction List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of indexes that matched your query.", + "description": "Total number of transactions that matched your query.", "x-example": 5, "format": "int32" }, - "indexes": { + "transactions": { "type": "array", - "description": "List of indexes.", + "description": "List of transactions.", "items": { "type": "object", - "$ref": "#\/definitions\/columnIndex" + "$ref": "#\/definitions\/transaction" }, "x-example": "" } }, "required": [ "total", - "indexes" + "transactions" ], "example": { "total": 5, - "indexes": "" + "transactions": "" } }, - "userList": { - "description": "Users List", + "migrationList": { + "description": "Migrations List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of users that matched your query.", + "description": "Total number of migrations that matched your query.", "x-example": 5, "format": "int32" }, - "users": { + "migrations": { "type": "array", - "description": "List of users.", + "description": "List of migrations.", "items": { "type": "object", - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/migration" }, "x-example": "" } }, "required": [ "total", - "users" + "migrations" ], "example": { "total": 5, - "users": "" + "migrations": "" } }, - "sessionList": { - "description": "Sessions List", + "specificationList": { + "description": "Specifications List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of sessions that matched your query.", + "description": "Total number of specifications that matched your query.", "x-example": 5, "format": "int32" }, - "sessions": { + "specifications": { "type": "array", - "description": "List of sessions.", + "description": "List of specifications.", "items": { "type": "object", - "$ref": "#\/definitions\/session" + "$ref": "#\/definitions\/specification" }, "x-example": "" } }, "required": [ "total", - "sessions" + "specifications" ], "example": { "total": 5, - "sessions": "" + "specifications": "" } }, - "identityList": { - "description": "Identities List", + "vcsContentList": { + "description": "VCS Content List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of identities that matched your query.", + "description": "Total number of contents that matched your query.", "x-example": 5, "format": "int32" }, - "identities": { + "contents": { "type": "array", - "description": "List of identities.", + "description": "List of contents.", "items": { "type": "object", - "$ref": "#\/definitions\/identity" + "$ref": "#\/definitions\/vcsContent" }, "x-example": "" } }, "required": [ "total", - "identities" + "contents" ], "example": { "total": 5, - "identities": "" + "contents": "" } }, - "logList": { - "description": "Logs List", + "vectorsdbCollectionList": { + "description": "VectorsDB Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of logs that matched your query.", + "description": "Total number of collections that matched your query.", "x-example": 5, "format": "int32" }, - "logs": { + "collections": { "type": "array", - "description": "List of logs.", + "description": "List of collections.", "items": { "type": "object", - "$ref": "#\/definitions\/log" + "$ref": "#\/definitions\/vectorsdbCollection" }, "x-example": "" } }, "required": [ "total", - "logs" + "collections" ], "example": { "total": 5, - "logs": "" + "collections": "" } }, - "fileList": { - "description": "Files List", + "embeddingList": { + "description": "Embedding list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of files that matched your query.", + "description": "Total number of embeddings that matched your query.", "x-example": 5, "format": "int32" }, - "files": { + "embeddings": { + "type": "array", + "description": "List of embeddings.", + "items": { + "type": "object", + "$ref": "#\/definitions\/embedding" + }, + "x-example": "" + } + }, + "required": [ + "total", + "embeddings" + ], + "example": { + "total": 5, + "embeddings": "" + } + }, + "database": { + "description": "Database", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Database name.", + "x-example": "My Database" + }, + "$createdAt": { + "type": "string", + "description": "Database creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Database update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "enabled": { + "type": "boolean", + "description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "type": { + "type": "string", + "description": "Database type.", + "x-example": "legacy", + "enum": [ + "legacy", + "tablesdb", + "documentsdb", + "vectorsdb" + ] + }, + "policies": { "type": "array", - "description": "List of files.", + "description": "Database backup policies.", "items": { "type": "object", - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/index" }, - "x-example": "" - } - }, - "required": [ - "total", - "files" - ], - "example": { - "total": 5, - "files": "" - } - }, - "bucketList": { - "description": "Buckets List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of buckets that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": {} }, - "buckets": { + "archives": { "type": "array", - "description": "List of buckets.", + "description": "Database backup archives.", "items": { "type": "object", - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/collection" }, - "x-example": "" + "x-example": {} } }, "required": [ - "total", - "buckets" + "$id", + "name", + "$createdAt", + "$updatedAt", + "enabled", + "type", + "policies", + "archives" ], "example": { - "total": 5, - "buckets": "" + "$id": "5e5ea5c16897e", + "name": "My Database", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "enabled": false, + "type": "legacy", + "policies": {}, + "archives": {} } }, - "resourceTokenList": { - "description": "Resource Tokens List", + "embedding": { + "description": "Embedding", "type": "object", "properties": { - "total": { + "model": { + "type": "string", + "description": "Embedding model used to generate embeddings.", + "x-example": "embeddinggemma" + }, + "dimension": { "type": "integer", - "description": "Total number of tokens that matched your query.", - "x-example": 5, + "description": "Number of dimensions for each embedding vector.", + "x-example": 768, "format": "int32" }, - "tokens": { + "embedding": { "type": "array", - "description": "List of tokens.", + "description": "Embedding vector values. If an error occurs, this will be an empty array.", "items": { - "type": "object", - "$ref": "#\/definitions\/resourceToken" + "type": "number", + "format": "double" }, - "x-example": "" + "x-example": [ + 0.01, + 0.02, + 0.03 + ] + }, + "error": { + "type": "string", + "description": "Error message if embedding generation fails. Empty string if no error.", + "x-example": "Error message" } }, "required": [ - "total", - "tokens" + "model", + "dimension", + "embedding", + "error" ], "example": { - "total": 5, - "tokens": "" + "model": "embeddinggemma", + "dimension": 768, + "embedding": [ + 0.01, + 0.02, + 0.03 + ], + "error": "Error message" } }, - "teamList": { - "description": "Teams List", + "collection": { + "description": "Collection", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of teams that matched your query.", - "x-example": 5, - "format": "int32" + "$id": { + "type": "string", + "description": "Collection ID.", + "x-example": "5e5ea5c16897e" }, - "teams": { + "$createdAt": { + "type": "string", + "description": "Collection creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Collection update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { "type": "array", - "description": "List of teams.", + "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "items": { - "type": "object", - "$ref": "#\/definitions\/team" + "type": "string" }, - "x-example": "" - } - }, - "required": [ - "total", - "teams" - ], - "example": { - "total": 5, - "teams": "" - } - }, - "membershipList": { - "description": "Memberships List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of memberships that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [ + "read(\"any\")" + ] }, - "memberships": { + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Collection name.", + "x-example": "My Collection" + }, + "enabled": { + "type": "boolean", + "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "documentSecurity": { + "type": "boolean", + "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "attributes": { "type": "array", - "description": "List of memberships.", + "description": "Collection attributes.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/attributeBoolean" + }, + { + "$ref": "#\/definitions\/attributeInteger" + }, + { + "$ref": "#\/definitions\/attributeFloat" + }, + { + "$ref": "#\/definitions\/attributeEmail" + }, + { + "$ref": "#\/definitions\/attributeEnum" + }, + { + "$ref": "#\/definitions\/attributeUrl" + }, + { + "$ref": "#\/definitions\/attributeIp" + }, + { + "$ref": "#\/definitions\/attributeDatetime" + }, + { + "$ref": "#\/definitions\/attributeRelationship" + }, + { + "$ref": "#\/definitions\/attributePoint" + }, + { + "$ref": "#\/definitions\/attributeLine" + }, + { + "$ref": "#\/definitions\/attributePolygon" + }, + { + "$ref": "#\/definitions\/attributeVarchar" + }, + { + "$ref": "#\/definitions\/attributeText" + }, + { + "$ref": "#\/definitions\/attributeMediumtext" + }, + { + "$ref": "#\/definitions\/attributeLongtext" + }, + { + "$ref": "#\/definitions\/attributeString" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/definitions\/attributeBoolean", + "integer": "#\/definitions\/attributeInteger", + "double": "#\/definitions\/attributeFloat", + "string": "#\/definitions\/attributeString", + "datetime": "#\/definitions\/attributeDatetime", + "relationship": "#\/definitions\/attributeRelationship", + "point": "#\/definitions\/attributePoint", + "linestring": "#\/definitions\/attributeLine", + "polygon": "#\/definitions\/attributePolygon", + "varchar": "#\/definitions\/attributeVarchar", + "text": "#\/definitions\/attributeText", + "mediumtext": "#\/definitions\/attributeMediumtext", + "longtext": "#\/definitions\/attributeLongtext" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/definitions\/attributeBoolean": { + "type": "boolean" + }, + "#\/definitions\/attributeInteger": { + "type": "integer" + }, + "#\/definitions\/attributeFloat": { + "type": "double" + }, + "#\/definitions\/attributeEmail": { + "type": "string", + "format": "email" + }, + "#\/definitions\/attributeEnum": { + "type": "string", + "format": "enum" + }, + "#\/definitions\/attributeUrl": { + "type": "string", + "format": "url" + }, + "#\/definitions\/attributeIp": { + "type": "string", + "format": "ip" + }, + "#\/definitions\/attributeDatetime": { + "type": "datetime" + }, + "#\/definitions\/attributeRelationship": { + "type": "relationship" + }, + "#\/definitions\/attributePoint": { + "type": "point" + }, + "#\/definitions\/attributeLine": { + "type": "linestring" + }, + "#\/definitions\/attributePolygon": { + "type": "polygon" + }, + "#\/definitions\/attributeVarchar": { + "type": "varchar" + }, + "#\/definitions\/attributeText": { + "type": "text" + }, + "#\/definitions\/attributeMediumtext": { + "type": "mediumtext" + }, + "#\/definitions\/attributeLongtext": { + "type": "longtext" + }, + "#\/definitions\/attributeString": { + "type": "string" + } + } + } + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Collection indexes.", "items": { "type": "object", - "$ref": "#\/definitions\/membership" + "$ref": "#\/definitions\/index" }, - "x-example": "" + "x-example": {} + }, + "bytesMax": { + "type": "integer", + "description": "Maximum document size in bytes. Returns 0 when no limit applies.", + "x-example": 65535, + "format": "int32" + }, + "bytesUsed": { + "type": "integer", + "description": "Currently used document size in bytes based on defined attributes.", + "x-example": 1500, + "format": "int32" } }, "required": [ - "total", - "memberships" + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "documentSecurity", + "attributes", + "indexes", + "bytesMax", + "bytesUsed" ], "example": { - "total": 5, - "memberships": "" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "databaseId": "5e5ea5c16897e", + "name": "My Collection", + "enabled": false, + "documentSecurity": true, + "attributes": {}, + "indexes": {}, + "bytesMax": 65535, + "bytesUsed": 1500 } }, - "siteList": { - "description": "Sites List", + "attributeList": { + "description": "Attributes List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of sites that matched your query.", + "description": "Total number of attributes in the given collection.", "x-example": 5, "format": "int32" }, - "sites": { + "attributes": { "type": "array", - "description": "List of sites.", + "description": "List of attributes.", "items": { - "type": "object", - "$ref": "#\/definitions\/site" + "x-anyOf": [ + { + "$ref": "#\/definitions\/attributeBoolean" + }, + { + "$ref": "#\/definitions\/attributeInteger" + }, + { + "$ref": "#\/definitions\/attributeFloat" + }, + { + "$ref": "#\/definitions\/attributeEmail" + }, + { + "$ref": "#\/definitions\/attributeEnum" + }, + { + "$ref": "#\/definitions\/attributeUrl" + }, + { + "$ref": "#\/definitions\/attributeIp" + }, + { + "$ref": "#\/definitions\/attributeDatetime" + }, + { + "$ref": "#\/definitions\/attributeRelationship" + }, + { + "$ref": "#\/definitions\/attributePoint" + }, + { + "$ref": "#\/definitions\/attributeLine" + }, + { + "$ref": "#\/definitions\/attributePolygon" + }, + { + "$ref": "#\/definitions\/attributeVarchar" + }, + { + "$ref": "#\/definitions\/attributeText" + }, + { + "$ref": "#\/definitions\/attributeMediumtext" + }, + { + "$ref": "#\/definitions\/attributeLongtext" + }, + { + "$ref": "#\/definitions\/attributeString" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/definitions\/attributeBoolean", + "integer": "#\/definitions\/attributeInteger", + "double": "#\/definitions\/attributeFloat", + "string": "#\/definitions\/attributeString", + "datetime": "#\/definitions\/attributeDatetime", + "relationship": "#\/definitions\/attributeRelationship", + "point": "#\/definitions\/attributePoint", + "linestring": "#\/definitions\/attributeLine", + "polygon": "#\/definitions\/attributePolygon", + "varchar": "#\/definitions\/attributeVarchar", + "text": "#\/definitions\/attributeText", + "mediumtext": "#\/definitions\/attributeMediumtext", + "longtext": "#\/definitions\/attributeLongtext" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/definitions\/attributeBoolean": { + "type": "boolean" + }, + "#\/definitions\/attributeInteger": { + "type": "integer" + }, + "#\/definitions\/attributeFloat": { + "type": "double" + }, + "#\/definitions\/attributeEmail": { + "type": "string", + "format": "email" + }, + "#\/definitions\/attributeEnum": { + "type": "string", + "format": "enum" + }, + "#\/definitions\/attributeUrl": { + "type": "string", + "format": "url" + }, + "#\/definitions\/attributeIp": { + "type": "string", + "format": "ip" + }, + "#\/definitions\/attributeDatetime": { + "type": "datetime" + }, + "#\/definitions\/attributeRelationship": { + "type": "relationship" + }, + "#\/definitions\/attributePoint": { + "type": "point" + }, + "#\/definitions\/attributeLine": { + "type": "linestring" + }, + "#\/definitions\/attributePolygon": { + "type": "polygon" + }, + "#\/definitions\/attributeVarchar": { + "type": "varchar" + }, + "#\/definitions\/attributeText": { + "type": "text" + }, + "#\/definitions\/attributeMediumtext": { + "type": "mediumtext" + }, + "#\/definitions\/attributeLongtext": { + "type": "longtext" + }, + "#\/definitions\/attributeString": { + "type": "string" + } + } + } }, "x-example": "" } }, "required": [ "total", - "sites" + "attributes" ], "example": { "total": 5, - "sites": "" + "attributes": "" } }, - "templateSiteList": { - "description": "Site Templates List", + "attributeString": { + "description": "AttributeString", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of templates that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "templates": { - "type": "array", - "description": "List of templates.", - "items": { - "type": "object", - "$ref": "#\/definitions\/templateSite" - }, - "x-example": "" - } - }, - "required": [ - "total", - "templates" - ], - "example": { - "total": 5, - "templates": "" - } - }, - "functionList": { - "description": "Functions List", - "type": "object", - "properties": { - "total": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { "type": "integer", - "description": "Total number of functions that matched your query.", - "x-example": 5, + "description": "Attribute size.", + "x-example": 128, "format": "int32" }, - "functions": { - "type": "array", - "description": "List of functions.", - "items": { - "type": "object", - "$ref": "#\/definitions\/function" - }, - "x-example": "" + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ - "total", - "functions" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" ], "example": { - "total": 5, - "functions": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "size": 128, + "default": "default", + "encrypt": false } }, - "templateFunctionList": { - "description": "Function Templates List", + "attributeInteger": { + "description": "AttributeInteger", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { "type": "integer", - "description": "Total number of templates that matched your query.", - "x-example": 5, - "format": "int32" + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true }, - "templates": { - "type": "array", - "description": "List of templates.", - "items": { - "type": "object", - "$ref": "#\/definitions\/templateFunction" - }, - "x-example": "" - } - }, - "required": [ - "total", - "templates" - ], - "example": { - "total": 5, - "templates": "" - } - }, - "installationList": { - "description": "Installations List", - "type": "object", - "properties": { - "total": { + "max": { "type": "integer", - "description": "Total number of installations that matched your query.", - "x-example": 5, - "format": "int32" + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true }, - "installations": { - "type": "array", - "description": "List of installations.", - "items": { - "type": "object", - "$ref": "#\/definitions\/installation" - }, - "x-example": "" + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "x-nullable": true } }, "required": [ - "total", - "installations" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "installations": "" + "key": "count", + "type": "integer", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 } }, - "providerRepositoryFrameworkList": { - "description": "Framework Provider Repositories List", + "attributeFloat": { + "description": "AttributeFloat", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of frameworkProviderRepositories that matched your query.", - "x-example": 5, - "format": "int32" - }, - "frameworkProviderRepositories": { - "type": "array", - "description": "List of frameworkProviderRepositories.", - "items": { - "type": "object", - "$ref": "#\/definitions\/providerRepositoryFramework" - }, - "x-example": "" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "percentageCompleted" }, "type": { "type": "string", - "description": "Provider repository list type.", - "x-example": "framework" - } - }, - "required": [ - "total", - "frameworkProviderRepositories", - "type" - ], - "example": { - "total": 5, - "frameworkProviderRepositories": "", - "type": "framework" - } - }, - "providerRepositoryRuntimeList": { - "description": "Runtime Provider Repositories List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of runtimeProviderRepositories that matched your query.", - "x-example": 5, - "format": "int32" + "description": "Attribute type.", + "x-example": "double" }, - "runtimeProviderRepositories": { - "type": "array", - "description": "List of runtimeProviderRepositories.", - "items": { - "type": "object", - "$ref": "#\/definitions\/providerRepositoryRuntime" - }, - "x-example": "" + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" }, - "type": { + "error": { "type": "string", - "description": "Provider repository list type.", - "x-example": "runtime" - } - }, - "required": [ - "total", - "runtimeProviderRepositories", - "type" - ], - "example": { - "total": 5, - "runtimeProviderRepositories": "", - "type": "runtime" - } - }, - "branchList": { - "description": "Branches List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of branches that matched your query.", - "x-example": 5, - "format": "int32" + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" }, - "branches": { - "type": "array", - "description": "List of branches.", - "items": { - "type": "object", - "$ref": "#\/definitions\/branch" - }, - "x-example": "" - } - }, - "required": [ - "total", - "branches" - ], - "example": { - "total": 5, - "branches": "" - } - }, - "frameworkList": { - "description": "Frameworks List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of frameworks that matched your query.", - "x-example": 5, - "format": "int32" + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true }, - "frameworks": { - "type": "array", - "description": "List of frameworks.", - "items": { - "type": "object", - "$ref": "#\/definitions\/framework" - }, - "x-example": "" + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "x-nullable": true } }, "required": [ - "total", - "frameworks" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "frameworks": "" + "key": "percentageCompleted", + "type": "double", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1.5, + "max": 10.5, + "default": 2.5 } }, - "runtimeList": { - "description": "Runtimes List", + "attributeBoolean": { + "description": "AttributeBoolean", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of runtimes that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "runtimes": { - "type": "array", - "description": "List of runtimes.", - "items": { - "type": "object", - "$ref": "#\/definitions\/runtime" - }, - "x-example": "" + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "x-nullable": true } }, "required": [ - "total", - "runtimes" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "runtimes": "" + "key": "isEnabled", + "type": "boolean", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": false } }, - "deploymentList": { - "description": "Deployments List", + "attributeEmail": { + "description": "AttributeEmail", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of deployments that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "userEmail" }, - "deployments": { - "type": "array", - "description": "List of deployments.", - "items": { - "type": "object", - "$ref": "#\/definitions\/deployment" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "x-nullable": true } }, "required": [ - "total", - "deployments" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "deployments": "" + "key": "userEmail", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "email", + "default": "default@example.com" } }, - "executionList": { - "description": "Executions List", + "attributeEnum": { + "description": "AttributeEnum", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of executions that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "status" }, - "executions": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { "type": "array", - "description": "List of executions.", + "description": "Array of elements in enumerated type.", "items": { - "type": "object", - "$ref": "#\/definitions\/execution" + "type": "string" }, - "x-example": "" + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "x-nullable": true } }, "required": [ - "total", - "executions" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" ], "example": { - "total": 5, - "executions": "" + "key": "status", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "elements": "element", + "format": "enum", + "default": "element" } }, - "projectList": { - "description": "Projects List", + "attributeIp": { + "description": "AttributeIP", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of projects that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "ipAddress" }, - "projects": { - "type": "array", - "description": "List of projects.", - "items": { - "type": "object", - "$ref": "#\/definitions\/project" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "x-nullable": true } }, "required": [ - "total", - "projects" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "projects": "" + "key": "ipAddress", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "ip", + "default": "192.0.2.0" } }, - "webhookList": { - "description": "Webhooks List", + "attributeUrl": { + "description": "AttributeURL", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of webhooks that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "githubUrl" }, - "webhooks": { - "type": "array", - "description": "List of webhooks.", - "items": { - "type": "object", - "$ref": "#\/definitions\/webhook" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "http:\/\/example.com", + "x-nullable": true } }, "required": [ - "total", - "webhooks" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "webhooks": "" + "key": "githubUrl", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "url", + "default": "http:\/\/example.com" } }, - "keyList": { - "description": "API Keys List", + "attributeDatetime": { + "description": "AttributeDatetime", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of keys that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "birthDay" }, - "keys": { - "type": "array", - "description": "List of keys.", - "items": { - "type": "object", - "$ref": "#\/definitions\/key" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "datetime" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true } }, "required": [ - "total", - "keys" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "keys": "" + "key": "birthDay", + "type": "datetime", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "devKeyList": { - "description": "Dev Keys List", + "attributeRelationship": { + "description": "AttributeRelationship", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of devKeys that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "devKeys": { - "type": "array", - "description": "List of devKeys.", - "items": { - "type": "object", - "$ref": "#\/definitions\/devKey" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedCollection": { + "type": "string", + "description": "The ID of the related collection.", + "x-example": "collection" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ - "total", - "devKeys" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "relatedCollection", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { - "total": 5, - "devKeys": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "relatedCollection": "collection", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "countryList": { - "description": "Countries List", + "attributePoint": { + "description": "AttributePoint", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of countries that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "countries": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { "type": "array", - "description": "List of countries.", - "items": { - "type": "object", - "$ref": "#\/definitions\/country" - }, - "x-example": "" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": [ + 0, + 0 + ], + "x-nullable": true } }, "required": [ - "total", - "countries" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "countries": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + 0, + 0 + ] } }, - "continentList": { - "description": "Continents List", + "attributeLine": { + "description": "AttributeLine", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of continents that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "continents": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { "type": "array", - "description": "List of continents.", - "items": { - "type": "object", - "$ref": "#\/definitions\/continent" - }, - "x-example": "" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], + "x-nullable": true } }, "required": [ - "total", - "continents" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "continents": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "languageList": { - "description": "Languages List", + "attributePolygon": { + "description": "AttributePolygon", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of languages that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "languages": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { "type": "array", - "description": "List of languages.", - "items": { - "type": "object", - "$ref": "#\/definitions\/language" - }, - "x-example": "" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], + "x-nullable": true } }, "required": [ - "total", - "languages" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "languages": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, - "currencyList": { - "description": "Currencies List", + "attributeVarchar": { + "description": "AttributeVarchar", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { "type": "integer", - "description": "Total number of currencies that matched your query.", - "x-example": 5, + "description": "Attribute size.", + "x-example": 128, "format": "int32" }, - "currencies": { - "type": "array", - "description": "List of currencies.", - "items": { - "type": "object", - "$ref": "#\/definitions\/currency" - }, - "x-example": "" + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ - "total", - "currencies" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" ], "example": { - "total": 5, - "currencies": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "size": 128, + "default": "default", + "encrypt": false } }, - "phoneList": { - "description": "Phones List", + "attributeText": { + "description": "AttributeText", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of phones that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "phones": { - "type": "array", - "description": "List of phones.", - "items": { - "type": "object", - "$ref": "#\/definitions\/phone" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ - "total", - "phones" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "phones": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "variableList": { - "description": "Variables List", + "attributeMediumtext": { + "description": "AttributeMediumtext", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of variables that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "variables": { - "type": "array", - "description": "List of variables.", - "items": { - "type": "object", - "$ref": "#\/definitions\/variable" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ - "total", - "variables" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "variables": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "healthStatusList": { - "description": "Status List", + "attributeLongtext": { + "description": "AttributeLongtext", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of statuses that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "statuses": { - "type": "array", - "description": "List of statuses.", - "items": { - "type": "object", - "$ref": "#\/definitions\/healthStatus" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ - "total", - "statuses" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "statuses": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "proxyRuleList": { - "description": "Rule List", + "usageDocumentsDB": { + "description": "UsageDocumentsDB", "type": "object", "properties": { - "total": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "collectionsTotal": { "type": "integer", - "description": "Total number of rules that matched your query.", - "x-example": 5, + "description": "Total aggregated number of collections.", + "x-example": 0, "format": "int32" }, - "rules": { - "type": "array", - "description": "List of rules.", - "items": { - "type": "object", - "$ref": "#\/definitions\/proxyRule" - }, - "x-example": "" - } - }, - "required": [ - "total", - "rules" - ], - "example": { - "total": 5, - "rules": "" - } - }, - "scheduleList": { - "description": "Schedules List", - "type": "object", - "properties": { - "total": { + "documentsTotal": { "type": "integer", - "description": "Total number of schedules that matched your query.", - "x-example": 5, + "description": "Total aggregated number of documents.", + "x-example": 0, "format": "int32" }, - "schedules": { - "type": "array", - "description": "List of schedules.", - "items": { - "type": "object", - "$ref": "#\/definitions\/schedule" - }, - "x-example": "" - } - }, - "required": [ - "total", - "schedules" - ], - "example": { - "total": 5, - "schedules": "" - } - }, - "localeCodeList": { - "description": "Locale codes list", - "type": "object", - "properties": { - "total": { + "storageTotal": { "type": "integer", - "description": "Total number of localeCodes that matched your query.", - "x-example": 5, + "description": "Total aggregated storage used in bytes.", + "x-example": 0, "format": "int32" }, - "localeCodes": { - "type": "array", - "description": "List of localeCodes.", - "items": { - "type": "object", - "$ref": "#\/definitions\/localeCode" - }, - "x-example": "" - } - }, - "required": [ - "total", - "localeCodes" - ], - "example": { - "total": 5, - "localeCodes": "" - } - }, - "providerList": { - "description": "Provider list", - "type": "object", - "properties": { - "total": { + "databaseReadsTotal": { "type": "integer", - "description": "Total number of providers that matched your query.", - "x-example": 5, + "description": "Total number of database reads.", + "x-example": 0, "format": "int32" }, - "providers": { + "databaseWritesTotal": { + "type": "integer", + "description": "Total number of database writes.", + "x-example": 0, + "format": "int32" + }, + "collections": { "type": "array", - "description": "List of providers.", + "description": "Aggregated number of collections per period.", "items": { "type": "object", - "$ref": "#\/definitions\/provider" + "$ref": "#\/definitions\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "providers" - ], - "example": { - "total": 5, - "providers": "" - } - }, - "messageList": { - "description": "Message list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of messages that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, - "messages": { + "documents": { "type": "array", - "description": "List of messages.", + "description": "Aggregated number of documents per period.", "items": { "type": "object", - "$ref": "#\/definitions\/message" + "$ref": "#\/definitions\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "messages" - ], - "example": { - "total": 5, - "messages": "" - } - }, - "topicList": { - "description": "Topic list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of topics that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, - "topics": { + "storage": { "type": "array", - "description": "List of topics.", + "description": "Aggregated storage used in bytes per period.", "items": { "type": "object", - "$ref": "#\/definitions\/topic" + "$ref": "#\/definitions\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "topics" - ], - "example": { - "total": 5, - "topics": "" - } - }, - "subscriberList": { - "description": "Subscriber list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of subscribers that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, - "subscribers": { + "databaseReads": { "type": "array", - "description": "List of subscribers.", + "description": "An array of aggregated number of database reads.", "items": { "type": "object", - "$ref": "#\/definitions\/subscriber" + "$ref": "#\/definitions\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "subscribers" - ], - "example": { - "total": 5, - "subscribers": "" - } - }, - "targetList": { - "description": "Target list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of targets that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, - "targets": { + "databaseWrites": { "type": "array", - "description": "List of targets.", + "description": "An array of aggregated number of database writes.", "items": { "type": "object", - "$ref": "#\/definitions\/target" + "$ref": "#\/definitions\/metric" }, - "x-example": "" + "x-example": [] } }, "required": [ - "total", - "targets" + "range", + "collectionsTotal", + "documentsTotal", + "storageTotal", + "databaseReadsTotal", + "databaseWritesTotal", + "collections", + "documents", + "storage", + "databaseReads", + "databaseWrites" ], "example": { - "total": 5, - "targets": "" + "range": "30d", + "collectionsTotal": 0, + "documentsTotal": 0, + "storageTotal": 0, + "databaseReadsTotal": 0, + "databaseWritesTotal": 0, + "collections": [], + "documents": [], + "storage": [], + "databaseReads": [], + "databaseWrites": [] } }, - "transactionList": { - "description": "Transaction List", + "vectorsdbCollection": { + "description": "VectorsDB Collection", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of transactions that matched your query.", - "x-example": 5, - "format": "int32" + "$id": { + "type": "string", + "description": "Collection ID.", + "x-example": "5e5ea5c16897e" }, - "transactions": { + "$createdAt": { + "type": "string", + "description": "Collection creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Collection update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { "type": "array", - "description": "List of transactions.", + "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Collection name.", + "x-example": "My Collection" + }, + "enabled": { + "type": "boolean", + "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "documentSecurity": { + "type": "boolean", + "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "attributes": { + "type": "array", + "description": "Collection attributes.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/attributeObject" + }, + { + "$ref": "#\/definitions\/attributeVector" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "object": "#\/definitions\/attributeObject", + "vector": "#\/definitions\/attributeVector" + } + } + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Collection indexes.", "items": { "type": "object", - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/index" }, - "x-example": "" + "x-example": {} + }, + "bytesMax": { + "type": "integer", + "description": "Maximum document size in bytes. Returns 0 when no limit applies.", + "x-example": 65535, + "format": "int32" + }, + "bytesUsed": { + "type": "integer", + "description": "Currently used document size in bytes based on defined attributes.", + "x-example": 1500, + "format": "int32" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimension.", + "x-example": 1536, + "format": "int32" } }, "required": [ - "total", - "transactions" + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "documentSecurity", + "attributes", + "indexes", + "bytesMax", + "bytesUsed", + "dimension" ], "example": { - "total": 5, - "transactions": "" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "databaseId": "5e5ea5c16897e", + "name": "My Collection", + "enabled": false, + "documentSecurity": true, + "attributes": {}, + "indexes": {}, + "bytesMax": 65535, + "bytesUsed": 1500, + "dimension": 1536 } }, - "migrationList": { - "description": "Migrations List", + "attributeObject": { + "description": "AttributeObject", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of migrations that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "migrations": { - "type": "array", - "description": "List of migrations.", - "items": { - "type": "object", - "$ref": "#\/definitions\/migration" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "total", - "migrations" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "migrations": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "specificationList": { - "description": "Specifications List", + "attributeVector": { + "description": "AttributeVector", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { "type": "integer", - "description": "Total number of specifications that matched your query.", - "x-example": 5, + "description": "Vector dimensions.", + "x-example": 1536, "format": "int32" - }, - "specifications": { - "type": "array", - "description": "List of specifications.", - "items": { - "type": "object", - "$ref": "#\/definitions\/specification" - }, - "x-example": "" } }, "required": [ - "total", - "specifications" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" ], "example": { - "total": 5, - "specifications": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "size": 1536 } }, - "vcsContentList": { - "description": "VCS Content List", + "usageVectorsDBs": { + "description": "UsageVectorsDBs", "type": "object", "properties": { - "total": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "databasesTotal": { "type": "integer", - "description": "Total number of contents that matched your query.", - "x-example": 5, + "description": "Total aggregated number of VectorsDB databases.", + "x-example": 0, "format": "int32" }, - "contents": { + "collectionsTotal": { + "type": "integer", + "description": "Total aggregated number of collections.", + "x-example": 0, + "format": "int32" + }, + "documentsTotal": { + "type": "integer", + "description": "Total aggregated number of documents.", + "x-example": 0, + "format": "int32" + }, + "storageTotal": { + "type": "integer", + "description": "Total aggregated storage in bytes.", + "x-example": 0, + "format": "int32" + }, + "databasesReadsTotal": { + "type": "integer", + "description": "Total number of database reads.", + "x-example": 0, + "format": "int32" + }, + "databasesWritesTotal": { + "type": "integer", + "description": "Total number of database writes.", + "x-example": 0, + "format": "int32" + }, + "databases": { "type": "array", - "description": "List of contents.", + "description": "Aggregated number of databases per period.", "items": { "type": "object", - "$ref": "#\/definitions\/vcsContent" + "$ref": "#\/definitions\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "contents" - ], - "example": { - "total": 5, - "contents": "" - } - }, - "vectorsdbCollectionList": { - "description": "VectorsDB Collections List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of collections that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] }, "collections": { "type": "array", - "description": "List of collections.", + "description": "Aggregated number of collections per period.", "items": { "type": "object", - "$ref": "#\/definitions\/vectorsdbCollection" + "$ref": "#\/definitions\/metric" }, - "x-example": "" - } - }, - "required": [ - "total", - "collections" - ], - "example": { - "total": 5, - "collections": "" - } - }, - "embeddingList": { - "description": "Embedding list", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of embeddings that matched your query.", - "x-example": 5, - "format": "int32" + "x-example": [] + }, + "documents": { + "type": "array", + "description": "Aggregated number of documents per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "storage": { + "type": "array", + "description": "Aggregated storage in bytes per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] }, - "embeddings": { + "databasesReads": { "type": "array", - "description": "List of embeddings.", + "description": "An array of aggregated number of database reads.", "items": { "type": "object", - "$ref": "#\/definitions\/embedding" + "$ref": "#\/definitions\/metric" }, - "x-example": "" + "x-example": [] + }, + "databasesWrites": { + "type": "array", + "description": "An array of aggregated number of database writes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] } }, "required": [ - "total", - "embeddings" + "range", + "databasesTotal", + "collectionsTotal", + "documentsTotal", + "storageTotal", + "databasesReadsTotal", + "databasesWritesTotal", + "databases", + "collections", + "documents", + "storage", + "databasesReads", + "databasesWrites" ], "example": { - "total": 5, - "embeddings": "" + "range": "30d", + "databasesTotal": 0, + "collectionsTotal": 0, + "documentsTotal": 0, + "storageTotal": 0, + "databasesReadsTotal": 0, + "databasesWritesTotal": 0, + "databases": [], + "collections": [], + "documents": [], + "storage": [], + "databasesReads": [], + "databasesWrites": [] } }, - "database": { - "description": "Database", + "usageVectorsDB": { + "description": "UsageVectorsDB", "type": "object", "properties": { - "$id": { + "range": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "Time range of the usage stats.", + "x-example": "30d" }, - "name": { - "type": "string", - "description": "Database name.", - "x-example": "My Database" + "collectionsTotal": { + "type": "integer", + "description": "Total aggregated number of collections.", + "x-example": 0, + "format": "int32" }, - "$createdAt": { - "type": "string", - "description": "Database creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "documentsTotal": { + "type": "integer", + "description": "Total aggregated number of documents.", + "x-example": 0, + "format": "int32" }, - "$updatedAt": { - "type": "string", - "description": "Database update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "storageTotal": { + "type": "integer", + "description": "Total aggregated storage used in bytes.", + "x-example": 0, + "format": "int32" }, - "enabled": { - "type": "boolean", - "description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "databaseReadsTotal": { + "type": "integer", + "description": "Total number of database reads.", + "x-example": 0, + "format": "int32" }, - "type": { - "type": "string", - "description": "Database type.", - "x-example": "legacy", - "enum": [ - "legacy", - "tablesdb", - "documentsdb", - "vectorsdb" - ] + "databaseWritesTotal": { + "type": "integer", + "description": "Total number of database writes.", + "x-example": 0, + "format": "int32" }, - "policies": { + "collections": { "type": "array", - "description": "Database backup policies.", + "description": "Aggregated number of collections per period.", "items": { "type": "object", - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/metric" }, - "x-example": {} + "x-example": [] }, - "archives": { + "documents": { "type": "array", - "description": "Database backup archives.", + "description": "Aggregated number of documents per period.", "items": { "type": "object", - "$ref": "#\/definitions\/collection" + "$ref": "#\/definitions\/metric" }, - "x-example": {} - } - }, - "required": [ - "$id", - "name", - "$createdAt", - "$updatedAt", - "enabled", - "type", - "policies", - "archives" - ], - "example": { - "$id": "5e5ea5c16897e", - "name": "My Database", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "enabled": false, - "type": "legacy", - "policies": {}, - "archives": {} - } - }, - "embedding": { - "description": "Embedding", - "type": "object", - "properties": { - "model": { - "type": "string", - "description": "Embedding model used to generate embeddings.", - "x-example": "embeddinggemma" + "x-example": [] }, - "dimension": { - "type": "integer", - "description": "Number of dimensions for each embedding vector.", - "x-example": 768, - "format": "int32" + "storage": { + "type": "array", + "description": "Aggregated storage used in bytes per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] }, - "embedding": { + "databaseReads": { "type": "array", - "description": "Embedding vector values. If an error occurs, this will be an empty array.", + "description": "An array of aggregated number of database reads.", "items": { - "type": "number", - "format": "double" + "type": "object", + "$ref": "#\/definitions\/metric" }, - "x-example": [ - 0.01, - 0.02, - 0.03 - ] + "x-example": [] }, - "error": { - "type": "string", - "description": "Error message if embedding generation fails. Empty string if no error.", - "x-example": "Error message" + "databaseWrites": { + "type": "array", + "description": "An array of aggregated number of database writes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] } }, "required": [ - "model", - "dimension", - "embedding", - "error" + "range", + "collectionsTotal", + "documentsTotal", + "storageTotal", + "databaseReadsTotal", + "databaseWritesTotal", + "collections", + "documents", + "storage", + "databaseReads", + "databaseWrites" ], "example": { - "model": "embeddinggemma", - "dimension": 768, - "embedding": [ - 0.01, - 0.02, - 0.03 - ], - "error": "Error message" + "range": "30d", + "collectionsTotal": 0, + "documentsTotal": 0, + "storageTotal": 0, + "databaseReadsTotal": 0, + "databaseWritesTotal": 0, + "collections": [], + "documents": [], + "storage": [], + "databaseReads": [], + "databaseWrites": [] } }, - "collection": { - "description": "Collection", + "table": { + "description": "Table", "type": "object", "properties": { "$id": { "type": "string", - "description": "Collection ID.", + "description": "Table ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Collection creation date in ISO 8601 format.", + "description": "Table creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Collection update date in ISO 8601 format.", + "description": "Table update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", - "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "items": { "type": "string" }, @@ -70866,151 +78578,151 @@ }, "name": { "type": "string", - "description": "Collection name.", - "x-example": "My Collection" + "description": "Table name.", + "x-example": "My Table" }, "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.", + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", "x-example": false }, - "documentSecurity": { + "rowSecurity": { "type": "boolean", - "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": true }, - "attributes": { + "columns": { "type": "array", - "description": "Collection attributes.", + "description": "Table columns.", "items": { "x-anyOf": [ { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/columnBoolean" }, { - "$ref": "#\/definitions\/attributeInteger" + "$ref": "#\/definitions\/columnInteger" }, { - "$ref": "#\/definitions\/attributeFloat" + "$ref": "#\/definitions\/columnFloat" }, { - "$ref": "#\/definitions\/attributeEmail" + "$ref": "#\/definitions\/columnEmail" }, { - "$ref": "#\/definitions\/attributeEnum" + "$ref": "#\/definitions\/columnEnum" }, { - "$ref": "#\/definitions\/attributeUrl" + "$ref": "#\/definitions\/columnUrl" }, { - "$ref": "#\/definitions\/attributeIp" + "$ref": "#\/definitions\/columnIp" }, { - "$ref": "#\/definitions\/attributeDatetime" + "$ref": "#\/definitions\/columnDatetime" }, { - "$ref": "#\/definitions\/attributeRelationship" + "$ref": "#\/definitions\/columnRelationship" }, { - "$ref": "#\/definitions\/attributePoint" + "$ref": "#\/definitions\/columnPoint" }, { - "$ref": "#\/definitions\/attributeLine" + "$ref": "#\/definitions\/columnLine" }, { - "$ref": "#\/definitions\/attributePolygon" + "$ref": "#\/definitions\/columnPolygon" }, { - "$ref": "#\/definitions\/attributeVarchar" + "$ref": "#\/definitions\/columnVarchar" }, { - "$ref": "#\/definitions\/attributeText" + "$ref": "#\/definitions\/columnText" }, { - "$ref": "#\/definitions\/attributeMediumtext" + "$ref": "#\/definitions\/columnMediumtext" }, { - "$ref": "#\/definitions\/attributeLongtext" + "$ref": "#\/definitions\/columnLongtext" }, { - "$ref": "#\/definitions\/attributeString" + "$ref": "#\/definitions\/columnString" } ], "x-discriminator": { "propertyName": "type", "mapping": { - "boolean": "#\/definitions\/attributeBoolean", - "integer": "#\/definitions\/attributeInteger", - "double": "#\/definitions\/attributeFloat", - "string": "#\/definitions\/attributeString", - "datetime": "#\/definitions\/attributeDatetime", - "relationship": "#\/definitions\/attributeRelationship", - "point": "#\/definitions\/attributePoint", - "linestring": "#\/definitions\/attributeLine", - "polygon": "#\/definitions\/attributePolygon", - "varchar": "#\/definitions\/attributeVarchar", - "text": "#\/definitions\/attributeText", - "mediumtext": "#\/definitions\/attributeMediumtext", - "longtext": "#\/definitions\/attributeLongtext" + "boolean": "#\/definitions\/columnBoolean", + "integer": "#\/definitions\/columnInteger", + "double": "#\/definitions\/columnFloat", + "string": "#\/definitions\/columnString", + "datetime": "#\/definitions\/columnDatetime", + "relationship": "#\/definitions\/columnRelationship", + "point": "#\/definitions\/columnPoint", + "linestring": "#\/definitions\/columnLine", + "polygon": "#\/definitions\/columnPolygon", + "varchar": "#\/definitions\/columnVarchar", + "text": "#\/definitions\/columnText", + "mediumtext": "#\/definitions\/columnMediumtext", + "longtext": "#\/definitions\/columnLongtext" }, "x-propertyNames": [ "type", "format" ], "x-mapping": { - "#\/definitions\/attributeBoolean": { + "#\/definitions\/columnBoolean": { "type": "boolean" }, - "#\/definitions\/attributeInteger": { + "#\/definitions\/columnInteger": { "type": "integer" }, - "#\/definitions\/attributeFloat": { + "#\/definitions\/columnFloat": { "type": "double" }, - "#\/definitions\/attributeEmail": { + "#\/definitions\/columnEmail": { "type": "string", "format": "email" }, - "#\/definitions\/attributeEnum": { + "#\/definitions\/columnEnum": { "type": "string", "format": "enum" }, - "#\/definitions\/attributeUrl": { + "#\/definitions\/columnUrl": { "type": "string", "format": "url" }, - "#\/definitions\/attributeIp": { + "#\/definitions\/columnIp": { "type": "string", "format": "ip" }, - "#\/definitions\/attributeDatetime": { + "#\/definitions\/columnDatetime": { "type": "datetime" }, - "#\/definitions\/attributeRelationship": { + "#\/definitions\/columnRelationship": { "type": "relationship" }, - "#\/definitions\/attributePoint": { + "#\/definitions\/columnPoint": { "type": "point" }, - "#\/definitions\/attributeLine": { + "#\/definitions\/columnLine": { "type": "linestring" }, - "#\/definitions\/attributePolygon": { + "#\/definitions\/columnPolygon": { "type": "polygon" }, - "#\/definitions\/attributeVarchar": { + "#\/definitions\/columnVarchar": { "type": "varchar" }, - "#\/definitions\/attributeText": { + "#\/definitions\/columnText": { "type": "text" }, - "#\/definitions\/attributeMediumtext": { + "#\/definitions\/columnMediumtext": { "type": "mediumtext" }, - "#\/definitions\/attributeLongtext": { + "#\/definitions\/columnLongtext": { "type": "longtext" }, - "#\/definitions\/attributeString": { + "#\/definitions\/columnString": { "type": "string" } } @@ -71020,22 +78732,22 @@ }, "indexes": { "type": "array", - "description": "Collection indexes.", + "description": "Table indexes.", "items": { "type": "object", - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/columnIndex" }, "x-example": {} }, "bytesMax": { "type": "integer", - "description": "Maximum document size in bytes. Returns 0 when no limit applies.", + "description": "Maximum row size in bytes. Returns 0 when no limit applies.", "x-example": 65535, "format": "int32" }, "bytesUsed": { "type": "integer", - "description": "Currently used document size in bytes based on defined attributes.", + "description": "Currently used row size in bytes based on defined columns.", "x-example": 1500, "format": "int32" } @@ -71048,8 +78760,8 @@ "databaseId", "name", "enabled", - "documentSecurity", - "attributes", + "rowSecurity", + "columns", "indexes", "bytesMax", "bytesUsed" @@ -71062,157 +78774,157 @@ "read(\"any\")" ], "databaseId": "5e5ea5c16897e", - "name": "My Collection", + "name": "My Table", "enabled": false, - "documentSecurity": true, - "attributes": {}, + "rowSecurity": true, + "columns": {}, "indexes": {}, "bytesMax": 65535, "bytesUsed": 1500 } }, - "attributeList": { - "description": "Attributes List", + "columnList": { + "description": "Columns List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of attributes in the given collection.", + "description": "Total number of columns in the given table.", "x-example": 5, "format": "int32" }, - "attributes": { + "columns": { "type": "array", - "description": "List of attributes.", + "description": "List of columns.", "items": { "x-anyOf": [ { - "$ref": "#\/definitions\/attributeBoolean" + "$ref": "#\/definitions\/columnBoolean" }, { - "$ref": "#\/definitions\/attributeInteger" + "$ref": "#\/definitions\/columnInteger" }, { - "$ref": "#\/definitions\/attributeFloat" + "$ref": "#\/definitions\/columnFloat" }, { - "$ref": "#\/definitions\/attributeEmail" + "$ref": "#\/definitions\/columnEmail" }, { - "$ref": "#\/definitions\/attributeEnum" + "$ref": "#\/definitions\/columnEnum" }, { - "$ref": "#\/definitions\/attributeUrl" + "$ref": "#\/definitions\/columnUrl" }, { - "$ref": "#\/definitions\/attributeIp" + "$ref": "#\/definitions\/columnIp" }, { - "$ref": "#\/definitions\/attributeDatetime" + "$ref": "#\/definitions\/columnDatetime" }, { - "$ref": "#\/definitions\/attributeRelationship" + "$ref": "#\/definitions\/columnRelationship" }, { - "$ref": "#\/definitions\/attributePoint" + "$ref": "#\/definitions\/columnPoint" }, { - "$ref": "#\/definitions\/attributeLine" + "$ref": "#\/definitions\/columnLine" }, { - "$ref": "#\/definitions\/attributePolygon" + "$ref": "#\/definitions\/columnPolygon" }, { - "$ref": "#\/definitions\/attributeVarchar" + "$ref": "#\/definitions\/columnVarchar" }, { - "$ref": "#\/definitions\/attributeText" + "$ref": "#\/definitions\/columnText" }, { - "$ref": "#\/definitions\/attributeMediumtext" + "$ref": "#\/definitions\/columnMediumtext" }, { - "$ref": "#\/definitions\/attributeLongtext" + "$ref": "#\/definitions\/columnLongtext" }, { - "$ref": "#\/definitions\/attributeString" + "$ref": "#\/definitions\/columnString" } ], "x-discriminator": { "propertyName": "type", "mapping": { - "boolean": "#\/definitions\/attributeBoolean", - "integer": "#\/definitions\/attributeInteger", - "double": "#\/definitions\/attributeFloat", - "string": "#\/definitions\/attributeString", - "datetime": "#\/definitions\/attributeDatetime", - "relationship": "#\/definitions\/attributeRelationship", - "point": "#\/definitions\/attributePoint", - "linestring": "#\/definitions\/attributeLine", - "polygon": "#\/definitions\/attributePolygon", - "varchar": "#\/definitions\/attributeVarchar", - "text": "#\/definitions\/attributeText", - "mediumtext": "#\/definitions\/attributeMediumtext", - "longtext": "#\/definitions\/attributeLongtext" + "boolean": "#\/definitions\/columnBoolean", + "integer": "#\/definitions\/columnInteger", + "double": "#\/definitions\/columnFloat", + "string": "#\/definitions\/columnString", + "datetime": "#\/definitions\/columnDatetime", + "relationship": "#\/definitions\/columnRelationship", + "point": "#\/definitions\/columnPoint", + "linestring": "#\/definitions\/columnLine", + "polygon": "#\/definitions\/columnPolygon", + "varchar": "#\/definitions\/columnVarchar", + "text": "#\/definitions\/columnText", + "mediumtext": "#\/definitions\/columnMediumtext", + "longtext": "#\/definitions\/columnLongtext" }, "x-propertyNames": [ "type", "format" ], "x-mapping": { - "#\/definitions\/attributeBoolean": { + "#\/definitions\/columnBoolean": { "type": "boolean" }, - "#\/definitions\/attributeInteger": { + "#\/definitions\/columnInteger": { "type": "integer" }, - "#\/definitions\/attributeFloat": { + "#\/definitions\/columnFloat": { "type": "double" }, - "#\/definitions\/attributeEmail": { + "#\/definitions\/columnEmail": { "type": "string", "format": "email" }, - "#\/definitions\/attributeEnum": { + "#\/definitions\/columnEnum": { "type": "string", "format": "enum" }, - "#\/definitions\/attributeUrl": { + "#\/definitions\/columnUrl": { "type": "string", "format": "url" }, - "#\/definitions\/attributeIp": { + "#\/definitions\/columnIp": { "type": "string", "format": "ip" }, - "#\/definitions\/attributeDatetime": { + "#\/definitions\/columnDatetime": { "type": "datetime" }, - "#\/definitions\/attributeRelationship": { + "#\/definitions\/columnRelationship": { "type": "relationship" }, - "#\/definitions\/attributePoint": { + "#\/definitions\/columnPoint": { "type": "point" }, - "#\/definitions\/attributeLine": { + "#\/definitions\/columnLine": { "type": "linestring" }, - "#\/definitions\/attributePolygon": { + "#\/definitions\/columnPolygon": { "type": "polygon" }, - "#\/definitions\/attributeVarchar": { + "#\/definitions\/columnVarchar": { "type": "varchar" }, - "#\/definitions\/attributeText": { + "#\/definitions\/columnText": { "type": "text" }, - "#\/definitions\/attributeMediumtext": { + "#\/definitions\/columnMediumtext": { "type": "mediumtext" }, - "#\/definitions\/attributeLongtext": { + "#\/definitions\/columnLongtext": { "type": "longtext" }, - "#\/definitions\/attributeString": { + "#\/definitions\/columnString": { "type": "string" } } @@ -71223,30 +78935,30 @@ }, "required": [ "total", - "attributes" + "columns" ], "example": { "total": 5, - "attributes": "" + "columns": "" } }, - "attributeString": { - "description": "AttributeString", + "columnString": { + "description": "ColumnString", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71255,49 +78967,49 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", - "description": "Attribute size.", + "description": "Column size.", "x-example": 128, "format": "int32" }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": "default", "x-nullable": true }, "encrypt": { "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", + "description": "Defines whether this column is encrypted or not.", "x-example": false, "x-nullable": true } @@ -71326,23 +79038,23 @@ "encrypt": false } }, - "attributeInteger": { - "description": "AttributeInteger", + "columnInteger": { + "description": "ColumnInteger", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "count" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "integer" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71351,32 +79063,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "min": { @@ -71395,7 +79107,7 @@ }, "default": { "type": "integer", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": 10, "format": "int32", "x-nullable": true @@ -71424,23 +79136,23 @@ "default": 10 } }, - "attributeFloat": { - "description": "AttributeFloat", + "columnFloat": { + "description": "ColumnFloat", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "percentageCompleted" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "double" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71449,32 +79161,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "min": { @@ -71493,7 +79205,7 @@ }, "default": { "type": "number", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": 2.5, "format": "double", "x-nullable": true @@ -71522,23 +79234,23 @@ "default": 2.5 } }, - "attributeBoolean": { - "description": "AttributeBoolean", + "columnBoolean": { + "description": "ColumnBoolean", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "isEnabled" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "boolean" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71547,37 +79259,37 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": false, "x-nullable": true } @@ -71603,23 +79315,23 @@ "default": false } }, - "attributeEmail": { - "description": "AttributeEmail", + "columnEmail": { + "description": "ColumnEmail", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "userEmail" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71628,32 +79340,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "format": { @@ -71663,7 +79375,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": "default@example.com", "x-nullable": true } @@ -71691,23 +79403,23 @@ "default": "default@example.com" } }, - "attributeEnum": { - "description": "AttributeEnum", + "columnEnum": { + "description": "ColumnEnum", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "status" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71716,32 +79428,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "elements": { @@ -71759,7 +79471,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": "element", "x-nullable": true } @@ -71789,23 +79501,23 @@ "default": "element" } }, - "attributeIp": { - "description": "AttributeIP", + "columnIp": { + "description": "ColumnIP", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "ipAddress" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -71814,32 +79526,32 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "format": { @@ -71849,7 +79561,7 @@ }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": "192.0.2.0", "x-nullable": true } @@ -71862,387 +79574,10 @@ "required", "$createdAt", "$updatedAt", - "format" - ], - "example": { - "key": "ipAddress", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "ip", - "default": "192.0.2.0" - } - }, - "attributeUrl": { - "description": "AttributeURL", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "githubUrl" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "url" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", - "x-nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" - ], - "example": { - "key": "githubUrl", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "url", - "default": "http:\/\/example.com" - } - }, - "attributeDatetime": { - "description": "AttributeDatetime", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "birthDay" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "datetime" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "format": { - "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", - "x-nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" - ], - "example": { - "key": "birthDay", - "type": "datetime", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" - } - }, - "attributeRelationship": { - "description": "AttributeRelationship", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "relatedCollection": { - "type": "string", - "description": "The ID of the related collection.", - "x-example": "collection" - }, - "relationType": { - "type": "string", - "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" - }, - "twoWay": { - "type": "boolean", - "description": "Is the relationship two-way?", - "x-example": false - }, - "twoWayKey": { - "type": "string", - "description": "The key of the two-way relationship.", - "x-example": "string" - }, - "onDelete": { - "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" - }, - "side": { - "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "relatedCollection", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" - ], - "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "relatedCollection": "collection", - "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", - "twoWay": false, - "twoWayKey": "string", - "onDelete": "restrict|cascade|setNull", - "side": "parent|child" - } - }, - "attributePoint": { - "description": "AttributePoint", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - 0, - 0 - ], - "x-nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -72250,29 +79585,27 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "attributeLine": { - "description": "AttributeLine", + "columnUrl": { + "description": "ColumnURL", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "githubUrl" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72281,47 +79614,43 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", "x-nullable": true } }, @@ -72332,10 +79661,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -72343,35 +79673,27 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ] + "format": "url", + "default": "https:\/\/example.com" } }, - "attributePolygon": { - "description": "AttributePolygon", + "columnDatetime": { + "description": "ColumnDatetime", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "birthDay" }, "type": { "type": "string", - "description": "Attribute type.", - "x-example": "string" + "description": "Column type.", + "x-example": "datetime" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72380,59 +79702,43 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ], + "type": "string", + "description": "Default value for column when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", "x-nullable": true } }, @@ -72443,58 +79749,39 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "key": "birthDay", + "type": "datetime", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "attributeVarchar": { - "description": "AttributeVarchar", + "columnRelationship": { + "description": "ColumnRelationship", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72503,51 +79790,63 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" }, - "encrypt": { + "twoWay": { "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, - "x-nullable": true + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ @@ -72558,7 +79857,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -72569,28 +79873,31 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "relatedTable": "table", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "attributeText": { - "description": "AttributeText", + "columnPoint": { + "description": "ColumnPoint", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72599,44 +79906,41 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "type": "array", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": [ + 0, + 0 + ], "x-nullable": true } }, @@ -72658,27 +79962,29 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "attributeMediumtext": { - "description": "AttributeMediumtext", + "columnLine": { + "description": "ColumnLine", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72687,44 +79993,47 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "type": "array", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "x-nullable": true } }, @@ -72746,27 +80055,35 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "attributeLongtext": { - "description": "AttributeLongtext", + "columnPolygon": { + "description": "ColumnPolygon", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -72775,44 +80092,59 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "type": "array", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "x-nullable": true } }, @@ -72834,271 +80166,143 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false - } - }, - "usageDocumentsDB": { - "description": "UsageDocumentsDB", - "type": "object", - "properties": { - "range": { - "type": "string", - "description": "Time range of the usage stats.", - "x-example": "30d" - }, - "collectionsTotal": { - "type": "integer", - "description": "Total aggregated number of collections.", - "x-example": 0, - "format": "int32" - }, - "documentsTotal": { - "type": "integer", - "description": "Total aggregated number of documents.", - "x-example": 0, - "format": "int32" - }, - "storageTotal": { - "type": "integer", - "description": "Total aggregated storage used in bytes.", - "x-example": 0, - "format": "int32" - }, - "databaseReadsTotal": { - "type": "integer", - "description": "Total number of database reads.", - "x-example": 0, - "format": "int32" - }, - "databaseWritesTotal": { - "type": "integer", - "description": "Total number of database writes.", - "x-example": 0, - "format": "int32" - }, - "collections": { - "type": "array", - "description": "Aggregated number of collections per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] - }, - "documents": { - "type": "array", - "description": "Aggregated number of documents per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] - }, - "storage": { - "type": "array", - "description": "Aggregated storage used in bytes per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] - }, - "databaseReads": { - "type": "array", - "description": "An array of aggregated number of database reads.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] - }, - "databaseWrites": { - "type": "array", - "description": "An array of aggregated number of database writes.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] - } - }, - "required": [ - "range", - "collectionsTotal", - "documentsTotal", - "storageTotal", - "databaseReadsTotal", - "databaseWritesTotal", - "collections", - "documents", - "storage", - "databaseReads", - "databaseWrites" - ], - "example": { - "range": "30d", - "collectionsTotal": 0, - "documentsTotal": 0, - "storageTotal": 0, - "databaseReadsTotal": 0, - "databaseWritesTotal": 0, - "collections": [], - "documents": [], - "storage": [], - "databaseReads": [], - "databaseWrites": [] + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, - "vectorsdbCollection": { - "description": "VectorsDB Collection", + "columnVarchar": { + "description": "ColumnVarchar", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Collection ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { + "key": { "type": "string", - "description": "Collection creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Column Key.", + "x-example": "fullName" }, - "$updatedAt": { + "type": { "type": "string", - "description": "Collection update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "description": "Column type.", + "x-example": "string" }, - "databaseId": { + "status": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" }, - "name": { + "error": { "type": "string", - "description": "Collection name.", - "x-example": "My Collection" + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" }, - "enabled": { + "required": { "type": "boolean", - "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "description": "Is column required?", + "x-example": true }, - "documentSecurity": { + "array": { "type": "boolean", - "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "description": "Is column an array?", + "x-example": false, + "x-nullable": true }, - "attributes": { - "type": "array", - "description": "Collection attributes.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/attributeObject" - }, - { - "$ref": "#\/definitions\/attributeVector" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "object": "#\/definitions\/attributeObject", - "vector": "#\/definitions\/attributeVector" - } - } - }, - "x-example": {} + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "indexes": { - "type": "array", - "description": "Collection indexes.", - "items": { - "type": "object", - "$ref": "#\/definitions\/index" - }, - "x-example": {} + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "bytesMax": { + "size": { "type": "integer", - "description": "Maximum document size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, + "description": "Column size.", + "x-example": 128, "format": "int32" }, - "bytesUsed": { - "type": "integer", - "description": "Currently used document size in bytes based on defined attributes.", - "x-example": 1500, - "format": "int32" + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true }, - "dimension": { - "type": "integer", - "description": "Embedding dimension.", - "x-example": 1536, - "format": "int32" + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ - "$id", + "key", + "type", + "status", + "error", + "required", "$createdAt", "$updatedAt", - "$permissions", - "databaseId", - "name", - "enabled", - "documentSecurity", - "attributes", - "indexes", - "bytesMax", - "bytesUsed", - "dimension" + "size" ], "example": { - "$id": "5e5ea5c16897e", + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "databaseId": "5e5ea5c16897e", - "name": "My Collection", - "enabled": false, - "documentSecurity": true, - "attributes": {}, - "indexes": {}, - "bytesMax": 65535, - "bytesUsed": 1500, - "dimension": 1536 + "size": 128, + "default": "default", + "encrypt": false } }, - "attributeObject": { - "description": "AttributeObject", + "columnText": { + "description": "ColumnText", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -73107,33 +80311,45 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ @@ -73153,26 +80369,28 @@ "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00" + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "attributeVector": { - "description": "AttributeVector", + "columnMediumtext": { + "description": "ColumnMediumtext", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -73181,39 +80399,45 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Vector dimensions.", - "x-example": 1536, - "format": "int32" + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ @@ -73223,8 +80447,7 @@ "error", "required", "$createdAt", - "$updatedAt", - "size" + "$updatedAt" ], "example": { "key": "fullName", @@ -73235,7043 +80458,7043 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 1536 + "default": "default", + "encrypt": false } }, - "usageVectorsDBs": { - "description": "UsageVectorsDBs", + "columnLongtext": { + "description": "ColumnLongtext", "type": "object", "properties": { - "range": { + "key": { "type": "string", - "description": "Time range of the usage stats.", - "x-example": "30d" - }, - "databasesTotal": { - "type": "integer", - "description": "Total aggregated number of VectorsDB databases.", - "x-example": 0, - "format": "int32" - }, - "collectionsTotal": { - "type": "integer", - "description": "Total aggregated number of collections.", - "x-example": 0, - "format": "int32" - }, - "documentsTotal": { - "type": "integer", - "description": "Total aggregated number of documents.", - "x-example": 0, - "format": "int32" + "description": "Column Key.", + "x-example": "fullName" }, - "storageTotal": { - "type": "integer", - "description": "Total aggregated storage in bytes.", - "x-example": 0, - "format": "int32" + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" }, - "databasesReadsTotal": { - "type": "integer", - "description": "Total number of database reads.", - "x-example": 0, - "format": "int32" + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" }, - "databasesWritesTotal": { - "type": "integer", - "description": "Total number of database writes.", - "x-example": 0, - "format": "int32" + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" }, - "databases": { - "type": "array", - "description": "Aggregated number of databases per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true }, - "collections": { - "type": "array", - "description": "Aggregated number of collections per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true }, - "documents": { - "type": "array", - "description": "Aggregated number of documents per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "storage": { - "type": "array", - "description": "Aggregated storage in bytes per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "databasesReads": { - "type": "array", - "description": "An array of aggregated number of database reads.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true }, - "databasesWrites": { - "type": "array", - "description": "An array of aggregated number of database writes.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ - "range", - "databasesTotal", - "collectionsTotal", - "documentsTotal", - "storageTotal", - "databasesReadsTotal", - "databasesWritesTotal", - "databases", - "collections", - "documents", - "storage", - "databasesReads", - "databasesWrites" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "range": "30d", - "databasesTotal": 0, - "collectionsTotal": 0, - "documentsTotal": 0, - "storageTotal": 0, - "databasesReadsTotal": 0, - "databasesWritesTotal": 0, - "databases": [], - "collections": [], - "documents": [], - "storage": [], - "databasesReads": [], - "databasesWrites": [] + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": "default", + "encrypt": false } }, - "usageVectorsDB": { - "description": "UsageVectorsDB", + "index": { + "description": "Index", "type": "object", "properties": { - "range": { + "$id": { "type": "string", - "description": "Time range of the usage stats.", - "x-example": "30d" - }, - "collectionsTotal": { - "type": "integer", - "description": "Total aggregated number of collections.", - "x-example": 0, - "format": "int32" + "description": "Index ID.", + "x-example": "5e5ea5c16897e" }, - "documentsTotal": { - "type": "integer", - "description": "Total aggregated number of documents.", - "x-example": 0, - "format": "int32" + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "storageTotal": { - "type": "integer", - "description": "Total aggregated storage used in bytes.", - "x-example": 0, - "format": "int32" + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "databaseReadsTotal": { - "type": "integer", - "description": "Total number of database reads.", - "x-example": 0, - "format": "int32" + "key": { + "type": "string", + "description": "Index key.", + "x-example": "index1" }, - "databaseWritesTotal": { - "type": "integer", - "description": "Total number of database writes.", - "x-example": 0, - "format": "int32" + "type": { + "type": "string", + "description": "Index type.", + "x-example": "primary" }, - "collections": { - "type": "array", - "description": "Aggregated number of collections per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ] }, - "documents": { - "type": "array", - "description": "Aggregated number of documents per period.", - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - }, - "x-example": [] + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" }, - "storage": { + "attributes": { "type": "array", - "description": "Aggregated storage used in bytes per period.", + "description": "Index attributes.", "items": { - "type": "object", - "$ref": "#\/definitions\/metric" + "type": "string" }, "x-example": [] }, - "databaseReads": { + "lengths": { "type": "array", - "description": "An array of aggregated number of database reads.", + "description": "Index attributes length.", "items": { - "type": "object", - "$ref": "#\/definitions\/metric" + "type": "integer", + "format": "int32" }, "x-example": [] }, - "databaseWrites": { + "orders": { "type": "array", - "description": "An array of aggregated number of database writes.", + "description": "Index orders.", "items": { - "type": "object", - "$ref": "#\/definitions\/metric" + "type": "string" }, - "x-example": [] + "x-example": [], + "x-nullable": true } }, "required": [ - "range", - "collectionsTotal", - "documentsTotal", - "storageTotal", - "databaseReadsTotal", - "databaseWritesTotal", - "collections", - "documents", - "storage", - "databaseReads", - "databaseWrites" + "$id", + "$createdAt", + "$updatedAt", + "key", + "type", + "status", + "error", + "attributes", + "lengths" ], "example": { - "range": "30d", - "collectionsTotal": 0, - "documentsTotal": 0, - "storageTotal": 0, - "databaseReadsTotal": 0, - "databaseWritesTotal": 0, - "collections": [], - "documents": [], - "storage": [], - "databaseReads": [], - "databaseWrites": [] + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "key": "index1", + "type": "primary", + "status": "available", + "error": "string", + "attributes": [], + "lengths": [], + "orders": [] } }, - "table": { - "description": "Table", + "columnIndex": { + "description": "Index", "type": "object", "properties": { "$id": { "type": "string", - "description": "Table ID.", + "description": "Index ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Table creation date in ISO 8601 format.", + "description": "Index creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Table update date in ISO 8601 format.", + "description": "Index update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$permissions": { - "type": "array", - "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - }, - "databaseId": { + "key": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "Index Key.", + "x-example": "index1" }, - "name": { + "type": { "type": "string", - "description": "Table name.", - "x-example": "My Table" + "description": "Index type.", + "x-example": "primary" }, - "enabled": { - "type": "boolean", - "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" }, - "rowSecurity": { - "type": "boolean", - "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" }, "columns": { "type": "array", - "description": "Table columns.", + "description": "Index columns.", "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/columnBoolean" - }, - { - "$ref": "#\/definitions\/columnInteger" - }, - { - "$ref": "#\/definitions\/columnFloat" - }, - { - "$ref": "#\/definitions\/columnEmail" - }, - { - "$ref": "#\/definitions\/columnEnum" - }, - { - "$ref": "#\/definitions\/columnUrl" - }, - { - "$ref": "#\/definitions\/columnIp" - }, - { - "$ref": "#\/definitions\/columnDatetime" - }, - { - "$ref": "#\/definitions\/columnRelationship" - }, - { - "$ref": "#\/definitions\/columnPoint" - }, - { - "$ref": "#\/definitions\/columnLine" - }, - { - "$ref": "#\/definitions\/columnPolygon" - }, - { - "$ref": "#\/definitions\/columnVarchar" - }, - { - "$ref": "#\/definitions\/columnText" - }, - { - "$ref": "#\/definitions\/columnMediumtext" - }, - { - "$ref": "#\/definitions\/columnLongtext" - }, - { - "$ref": "#\/definitions\/columnString" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/definitions\/columnBoolean", - "integer": "#\/definitions\/columnInteger", - "double": "#\/definitions\/columnFloat", - "string": "#\/definitions\/columnString", - "datetime": "#\/definitions\/columnDatetime", - "relationship": "#\/definitions\/columnRelationship", - "point": "#\/definitions\/columnPoint", - "linestring": "#\/definitions\/columnLine", - "polygon": "#\/definitions\/columnPolygon", - "varchar": "#\/definitions\/columnVarchar", - "text": "#\/definitions\/columnText", - "mediumtext": "#\/definitions\/columnMediumtext", - "longtext": "#\/definitions\/columnLongtext" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/definitions\/columnBoolean": { - "type": "boolean" - }, - "#\/definitions\/columnInteger": { - "type": "integer" - }, - "#\/definitions\/columnFloat": { - "type": "double" - }, - "#\/definitions\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/definitions\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/definitions\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/definitions\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/definitions\/columnDatetime": { - "type": "datetime" - }, - "#\/definitions\/columnRelationship": { - "type": "relationship" - }, - "#\/definitions\/columnPoint": { - "type": "point" - }, - "#\/definitions\/columnLine": { - "type": "linestring" - }, - "#\/definitions\/columnPolygon": { - "type": "polygon" - }, - "#\/definitions\/columnVarchar": { - "type": "varchar" - }, - "#\/definitions\/columnText": { - "type": "text" - }, - "#\/definitions\/columnMediumtext": { - "type": "mediumtext" - }, - "#\/definitions\/columnLongtext": { - "type": "longtext" - }, - "#\/definitions\/columnString": { - "type": "string" - } - } - } + "type": "string" }, - "x-example": {} + "x-example": [] }, - "indexes": { + "lengths": { "type": "array", - "description": "Table indexes.", + "description": "Index columns length.", "items": { - "type": "object", - "$ref": "#\/definitions\/columnIndex" + "type": "integer", + "format": "int32" }, - "x-example": {} - }, - "bytesMax": { - "type": "integer", - "description": "Maximum row size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "x-example": [] }, - "bytesUsed": { - "type": "integer", - "description": "Currently used row size in bytes based on defined columns.", - "x-example": 1500, - "format": "int32" + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], + "x-nullable": true } }, "required": [ "$id", "$createdAt", "$updatedAt", - "$permissions", - "databaseId", - "name", - "enabled", - "rowSecurity", + "key", + "type", + "status", + "error", "columns", - "indexes", - "bytesMax", - "bytesUsed" + "lengths" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "databaseId": "5e5ea5c16897e", - "name": "My Table", - "enabled": false, - "rowSecurity": true, - "columns": {}, - "indexes": {}, - "bytesMax": 65535, - "bytesUsed": 1500 - } - }, - "columnList": { - "description": "Columns List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of columns in the given table.", - "x-example": 5, - "format": "int32" - }, - "columns": { - "type": "array", - "description": "List of columns.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/columnBoolean" - }, - { - "$ref": "#\/definitions\/columnInteger" - }, - { - "$ref": "#\/definitions\/columnFloat" - }, - { - "$ref": "#\/definitions\/columnEmail" - }, - { - "$ref": "#\/definitions\/columnEnum" - }, - { - "$ref": "#\/definitions\/columnUrl" - }, - { - "$ref": "#\/definitions\/columnIp" - }, - { - "$ref": "#\/definitions\/columnDatetime" - }, - { - "$ref": "#\/definitions\/columnRelationship" - }, - { - "$ref": "#\/definitions\/columnPoint" - }, - { - "$ref": "#\/definitions\/columnLine" - }, - { - "$ref": "#\/definitions\/columnPolygon" - }, - { - "$ref": "#\/definitions\/columnVarchar" - }, - { - "$ref": "#\/definitions\/columnText" - }, - { - "$ref": "#\/definitions\/columnMediumtext" - }, - { - "$ref": "#\/definitions\/columnLongtext" - }, - { - "$ref": "#\/definitions\/columnString" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/definitions\/columnBoolean", - "integer": "#\/definitions\/columnInteger", - "double": "#\/definitions\/columnFloat", - "string": "#\/definitions\/columnString", - "datetime": "#\/definitions\/columnDatetime", - "relationship": "#\/definitions\/columnRelationship", - "point": "#\/definitions\/columnPoint", - "linestring": "#\/definitions\/columnLine", - "polygon": "#\/definitions\/columnPolygon", - "varchar": "#\/definitions\/columnVarchar", - "text": "#\/definitions\/columnText", - "mediumtext": "#\/definitions\/columnMediumtext", - "longtext": "#\/definitions\/columnLongtext" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/definitions\/columnBoolean": { - "type": "boolean" - }, - "#\/definitions\/columnInteger": { - "type": "integer" - }, - "#\/definitions\/columnFloat": { - "type": "double" - }, - "#\/definitions\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/definitions\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/definitions\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/definitions\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/definitions\/columnDatetime": { - "type": "datetime" - }, - "#\/definitions\/columnRelationship": { - "type": "relationship" - }, - "#\/definitions\/columnPoint": { - "type": "point" - }, - "#\/definitions\/columnLine": { - "type": "linestring" - }, - "#\/definitions\/columnPolygon": { - "type": "polygon" - }, - "#\/definitions\/columnVarchar": { - "type": "varchar" - }, - "#\/definitions\/columnText": { - "type": "text" - }, - "#\/definitions\/columnMediumtext": { - "type": "mediumtext" - }, - "#\/definitions\/columnLongtext": { - "type": "longtext" - }, - "#\/definitions\/columnString": { - "type": "string" - } - } - } - }, - "x-example": "" - } - }, - "required": [ - "total", - "columns" - ], - "example": { - "total": 5, - "columns": "" + "key": "index1", + "type": "primary", + "status": "available", + "error": "string", + "columns": [], + "lengths": [], + "orders": [] } }, - "columnString": { - "description": "ColumnString", + "row": { + "description": "Row", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, - "type": { + "$id": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Row ID.", + "x-example": "5e5ea5c16897e" }, - "status": { + "$sequence": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Row sequence ID.", + "x-example": "1", + "readOnly": true }, - "error": { + "$tableId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "description": "Table ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Row creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Row update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Column size.", - "x-example": 128, - "format": "int32" - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] } }, + "additionalProperties": true, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", + "$sequence", + "$tableId", + "$databaseId", "$createdAt", "$updatedAt", - "size" + "$permissions" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$tableId": "5e5ea5c15117e", + "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "$permissions": [ + "read(\"any\")" + ] } }, - "columnInteger": { - "description": "ColumnInteger", + "document": { + "description": "Document", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "count" + "description": "Document ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$sequence": { "type": "string", - "description": "Column type.", - "x-example": "integer" + "description": "Document sequence ID.", + "x-example": "1", + "readOnly": true }, - "status": { + "$collectionId": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Collection ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, - "error": { + "$databaseId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "Database ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Document creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Document update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "min": { - "type": "integer", - "description": "Minimum value to enforce for new documents.", - "x-example": 1, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value to enforce for new documents.", - "x-example": 10, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 10, - "format": "int32", - "x-nullable": true + "$permissions": { + "type": "array", + "description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] } }, + "additionalProperties": true, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", + "$sequence", + "$collectionId", + "$databaseId", "$createdAt", - "$updatedAt" + "$updatedAt", + "$permissions" ], "example": { - "key": "count", - "type": "integer", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$collectionId": "5e5ea5c15117e", + "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "min": 1, - "max": 10, - "default": 10 + "$permissions": [ + "read(\"any\")" + ], + "username": "john.doe", + "email": "john.doe@example.com", + "fullName": "John Doe", + "age": 30, + "isAdmin": false } }, - "columnFloat": { - "description": "ColumnFloat", + "log": { + "description": "Log", "type": "object", "properties": { - "key": { + "event": { "type": "string", - "description": "Column Key.", - "x-example": "percentageCompleted" + "description": "Event name.", + "x-example": "account.sessions.create" }, - "type": { + "userId": { "type": "string", - "description": "Column type.", - "x-example": "double" + "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", + "x-example": "610fc2f985ee0" }, - "status": { + "userEmail": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", + "x-example": "john@appwrite.io" }, - "error": { + "userName": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", + "x-example": "John Doe" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "mode": { + "type": "string", + "description": "API mode when event triggered.", + "x-example": "admin" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" }, - "$createdAt": { + "ip": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "IP session in use when the session was created.", + "x-example": "127.0.0.1" }, - "$updatedAt": { + "time": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Log creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "min": { - "type": "number", - "description": "Minimum value to enforce for new documents.", - "x-example": 1.5, - "format": "double", - "x-nullable": true + "osCode": { + "type": "string", + "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", + "x-example": "Mac" }, - "max": { - "type": "number", - "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, - "format": "double", - "x-nullable": true + "osName": { + "type": "string", + "description": "Operating system name.", + "x-example": "Mac" }, - "default": { - "type": "number", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 2.5, - "format": "double", - "x-nullable": true + "osVersion": { + "type": "string", + "description": "Operating system version.", + "x-example": "Mac" + }, + "clientType": { + "type": "string", + "description": "Client type.", + "x-example": "browser" + }, + "clientCode": { + "type": "string", + "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", + "x-example": "CM" + }, + "clientName": { + "type": "string", + "description": "Client name.", + "x-example": "Chrome Mobile iOS" + }, + "clientVersion": { + "type": "string", + "description": "Client version.", + "x-example": "84.0" + }, + "clientEngine": { + "type": "string", + "description": "Client engine name.", + "x-example": "WebKit" + }, + "clientEngineVersion": { + "type": "string", + "description": "Client engine name.", + "x-example": "605.1.15" + }, + "deviceName": { + "type": "string", + "description": "Device name.", + "x-example": "smartphone" + }, + "deviceBrand": { + "type": "string", + "description": "Device brand name.", + "x-example": "Google" + }, + "deviceModel": { + "type": "string", + "description": "Device model name.", + "x-example": "Nexus 5" + }, + "countryCode": { + "type": "string", + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" + }, + "countryName": { + "type": "string", + "description": "Country name.", + "x-example": "United States" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "event", + "userId", + "userEmail", + "userName", + "mode", + "userType", + "ip", + "time", + "osCode", + "osName", + "osVersion", + "clientType", + "clientCode", + "clientName", + "clientVersion", + "clientEngine", + "clientEngineVersion", + "deviceName", + "deviceBrand", + "deviceModel", + "countryCode", + "countryName" ], "example": { - "key": "percentageCompleted", - "type": "double", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "min": 1.5, - "max": 10.5, - "default": 2.5 + "event": "account.sessions.create", + "userId": "610fc2f985ee0", + "userEmail": "john@appwrite.io", + "userName": "John Doe", + "mode": "admin", + "userType": "user", + "ip": "127.0.0.1", + "time": "2020-10-15T06:38:00.000+00:00", + "osCode": "Mac", + "osName": "Mac", + "osVersion": "Mac", + "clientType": "browser", + "clientCode": "CM", + "clientName": "Chrome Mobile iOS", + "clientVersion": "84.0", + "clientEngine": "WebKit", + "clientEngineVersion": "605.1.15", + "deviceName": "smartphone", + "deviceBrand": "Google", + "deviceModel": "Nexus 5", + "countryCode": "US", + "countryName": "United States" } }, - "columnBoolean": { - "description": "ColumnBoolean", + "user": { + "description": "User", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "isEnabled" + "description": "User ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "boolean" + "description": "User creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "User update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "User name.", + "x-example": "John Doe" + }, + "password": { + "type": "string", + "description": "Hashed user password.", + "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "x-nullable": true + }, + "hash": { + "type": "string", + "description": "Password hashing algorithm.", + "x-example": "argon2", + "x-nullable": true + }, + "hashOptions": { + "type": "object", + "description": "Password hashing algorithm configuration.", + "x-example": {}, + "items": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/algoArgon2" + }, + { + "$ref": "#\/definitions\/algoScrypt" + }, + { + "$ref": "#\/definitions\/algoScryptModified" + }, + { + "$ref": "#\/definitions\/algoBcrypt" + }, + { + "$ref": "#\/definitions\/algoPhpass" + }, + { + "$ref": "#\/definitions\/algoSha" + }, + { + "$ref": "#\/definitions\/algoMd5" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/definitions\/algoArgon2", + "scrypt": "#\/definitions\/algoScrypt", + "scryptMod": "#\/definitions\/algoScryptModified", + "bcrypt": "#\/definitions\/algoBcrypt", + "phpass": "#\/definitions\/algoPhpass", + "sha": "#\/definitions\/algoSha", + "md5": "#\/definitions\/algoMd5" + } + } + }, + "x-nullable": true + }, + "registration": { + "type": "string", + "description": "User registration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, "status": { + "type": "boolean", + "description": "User status. Pass `true` for enabled and `false` for disabled.", + "x-example": true + }, + "labels": { + "type": "array", + "description": "Labels for the user.", + "items": { + "type": "string" + }, + "x-example": [ + "vip" + ] + }, + "passwordUpdate": { + "type": "string", + "description": "Password update time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "email": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "User email address.", + "x-example": "john@appwrite.io" }, - "error": { + "phone": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User phone number in E.164 format.", + "x-example": "+4930901820" }, - "required": { + "emailVerification": { "type": "boolean", - "description": "Is column required?", + "description": "Email verification status.", "x-example": true }, - "array": { + "phoneVerification": { "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "Phone verification status.", + "x-example": true }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "mfa": { + "type": "boolean", + "description": "Multi factor authentication status.", + "x-example": true }, - "$updatedAt": { + "prefs": { + "type": "object", + "description": "User preferences as a key-value object", + "x-example": { + "theme": "pink", + "timezone": "UTC" + }, + "items": { + "type": "object", + "$ref": "#\/definitions\/preferences" + } + }, + "targets": { + "type": "array", + "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", + "items": { + "type": "object", + "$ref": "#\/definitions\/target" + }, + "x-example": [] + }, + "accessedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "impersonator": { "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Whether the user can impersonate other users.", "x-example": false, "x-nullable": true + }, + "impersonatorUserId": { + "type": "string", + "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", + "x-example": "5e5ea5c16897e", + "x-nullable": true } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "name", + "registration", + "status", + "labels", + "passwordUpdate", + "email", + "phone", + "emailVerification", + "phoneVerification", + "mfa", + "prefs", + "targets", + "accessedAt" ], "example": { - "key": "isEnabled", - "type": "boolean", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": false + "name": "John Doe", + "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "hash": "argon2", + "hashOptions": {}, + "registration": "2020-10-15T06:38:00.000+00:00", + "status": true, + "labels": [ + "vip" + ], + "passwordUpdate": "2020-10-15T06:38:00.000+00:00", + "email": "john@appwrite.io", + "phone": "+4930901820", + "emailVerification": true, + "phoneVerification": true, + "mfa": true, + "prefs": { + "theme": "pink", + "timezone": "UTC" + }, + "targets": [], + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "impersonator": false, + "impersonatorUserId": "5e5ea5c16897e" } }, - "columnEmail": { - "description": "ColumnEmail", + "algoMd5": { + "description": "AlgoMD5", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "userEmail" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "email" - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default@example.com", - "x-nullable": true + "description": "Algo type.", + "x-example": "md5" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "type" ], "example": { - "key": "userEmail", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "email", - "default": "default@example.com" + "type": "md5" } }, - "columnEnum": { - "description": "ColumnEnum", + "algoSha": { + "description": "AlgoSHA", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "status" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { + "description": "Algo type.", + "x-example": "sha" + } + }, + "required": [ + "type" + ], + "example": { + "type": "sha" + } + }, + "algoPhpass": { + "description": "AlgoPHPass", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { + "description": "Algo type.", + "x-example": "phpass" + } + }, + "required": [ + "type" + ], + "example": { + "type": "phpass" + } + }, + "algoBcrypt": { + "description": "AlgoBcrypt", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { + "description": "Algo type.", + "x-example": "bcrypt" + } + }, + "required": [ + "type" + ], + "example": { + "type": "bcrypt" + } + }, + "algoScrypt": { + "description": "AlgoScrypt", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Algo type.", + "x-example": "scrypt" }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "costCpu": { + "type": "integer", + "description": "CPU complexity of computed hash.", + "x-example": 8, + "format": "int32" }, - "elements": { - "type": "array", - "description": "Array of elements in enumerated type.", - "items": { - "type": "string" - }, - "x-example": "element" + "costMemory": { + "type": "integer", + "description": "Memory complexity of computed hash.", + "x-example": 14, + "format": "int32" }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "enum" + "costParallel": { + "type": "integer", + "description": "Parallelization of computed hash.", + "x-example": 1, + "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", - "x-nullable": true + "length": { + "type": "integer", + "description": "Length used to compute hash.", + "x-example": 64, + "format": "int32" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "elements", - "format" + "costCpu", + "costMemory", + "costParallel", + "length" ], "example": { - "key": "status", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "elements": "element", - "format": "enum", - "default": "element" + "type": "scrypt", + "costCpu": 8, + "costMemory": 14, + "costParallel": 1, + "length": 64 } }, - "columnIp": { - "description": "ColumnIP", + "algoScryptModified": { + "description": "AlgoScryptModified", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "ipAddress" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Algo type.", + "x-example": "scryptMod" }, - "$updatedAt": { + "salt": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Salt used to compute hash.", + "x-example": "UxLMreBr6tYyjQ==" }, - "format": { + "saltSeparator": { "type": "string", - "description": "String format.", - "x-example": "ip" + "description": "Separator used to compute hash.", + "x-example": "Bw==" }, - "default": { + "signerKey": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", - "x-nullable": true + "description": "Key used to compute hash.", + "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "salt", + "saltSeparator", + "signerKey" ], "example": { - "key": "ipAddress", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "ip", - "default": "192.0.2.0" + "type": "scryptMod", + "salt": "UxLMreBr6tYyjQ==", + "saltSeparator": "Bw==", + "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, - "columnUrl": { - "description": "ColumnURL", + "algoArgon2": { + "description": "AlgoArgon2", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "githubUrl" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Algo type.", + "x-example": "argon2" }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "memoryCost": { + "type": "integer", + "description": "Memory used to compute hash.", + "x-example": 65536, + "format": "int32" }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "url" + "timeCost": { + "type": "integer", + "description": "Amount of time consumed to compute hash", + "x-example": 4, + "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "x-nullable": true + "threads": { + "type": "integer", + "description": "Number of threads used to compute hash.", + "x-example": 3, + "format": "int32" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "memoryCost", + "timeCost", + "threads" ], "example": { - "key": "githubUrl", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "url", - "default": "https:\/\/example.com" + "type": "argon2", + "memoryCost": 65536, + "timeCost": 4, + "threads": 3 } }, - "columnDatetime": { - "description": "ColumnDatetime", + "preferences": { + "description": "Preferences", + "type": "object", + "additionalProperties": true, + "example": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } + }, + "session": { + "description": "Session", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "birthDay" + "description": "Session ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "datetime" + "description": "Session creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "$updatedAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Session update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { + "userId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User ID.", + "x-example": "5e5bb8c16897e" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "expire": { + "type": "string", + "description": "Session expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "provider": { + "type": "string", + "description": "Session Provider.", + "x-example": "email" }, - "$createdAt": { + "providerUid": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Session Provider User ID.", + "x-example": "user@example.com" }, - "$updatedAt": { + "providerAccessToken": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Session Provider Access Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + }, + "providerAccessTokenExpiry": { + "type": "string", + "description": "The date of when the access token expires in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "format": { + "providerRefreshToken": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "Session Provider Refresh Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, - "default": { + "ip": { "type": "string", - "description": "Default value for column when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", - "x-nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" - ], - "example": { - "key": "birthDay", - "type": "datetime", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" - } - }, - "columnRelationship": { - "description": "ColumnRelationship", - "type": "object", - "properties": { - "key": { + "description": "IP in use when the session was created.", + "x-example": "127.0.0.1" + }, + "osCode": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", + "x-example": "Mac" }, - "type": { + "osName": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Operating system name.", + "x-example": "Mac" }, - "status": { + "osVersion": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Operating system version.", + "x-example": "Mac" }, - "error": { + "clientType": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "Client type.", + "x-example": "browser" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "clientCode": { + "type": "string", + "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", + "x-example": "CM" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "clientName": { + "type": "string", + "description": "Client name.", + "x-example": "Chrome Mobile iOS" }, - "$createdAt": { + "clientVersion": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Client version.", + "x-example": "84.0" }, - "$updatedAt": { + "clientEngine": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Client engine name.", + "x-example": "WebKit" }, - "relatedTable": { + "clientEngineVersion": { "type": "string", - "description": "The ID of the related table.", - "x-example": "table" + "description": "Client engine name.", + "x-example": "605.1.15" }, - "relationType": { + "deviceName": { "type": "string", - "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + "description": "Device name.", + "x-example": "smartphone" }, - "twoWay": { - "type": "boolean", - "description": "Is the relationship two-way?", - "x-example": false + "deviceBrand": { + "type": "string", + "description": "Device brand name.", + "x-example": "Google" }, - "twoWayKey": { + "deviceModel": { "type": "string", - "description": "The key of the two-way relationship.", - "x-example": "string" + "description": "Device model name.", + "x-example": "Nexus 5" }, - "onDelete": { + "countryCode": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" }, - "side": { + "countryName": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Country name.", + "x-example": "United States" + }, + "current": { + "type": "boolean", + "description": "Returns true if this the current user session.", + "x-example": true + }, + "factors": { + "type": "array", + "description": "Returns a list of active session factors.", + "items": { + "type": "string" + }, + "x-example": [ + "email" + ] + }, + "secret": { + "type": "string", + "description": "Secret used to authenticate the user. Only included if the request was made with an API key", + "x-example": "5e5bb8c16897e" + }, + "mfaUpdatedAt": { + "type": "string", + "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", "$updatedAt", - "relatedTable", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "userId", + "expire", + "provider", + "providerUid", + "providerAccessToken", + "providerAccessTokenExpiry", + "providerRefreshToken", + "ip", + "osCode", + "osName", + "osVersion", + "clientType", + "clientCode", + "clientName", + "clientVersion", + "clientEngine", + "clientEngineVersion", + "deviceName", + "deviceBrand", + "deviceModel", + "countryCode", + "countryName", + "current", + "factors", + "secret", + "mfaUpdatedAt" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "relatedTable": "table", - "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", - "twoWay": false, - "twoWayKey": "string", - "onDelete": "restrict|cascade|setNull", - "side": "parent|child" + "userId": "5e5bb8c16897e", + "expire": "2020-10-15T06:38:00.000+00:00", + "provider": "email", + "providerUid": "user@example.com", + "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", + "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "ip": "127.0.0.1", + "osCode": "Mac", + "osName": "Mac", + "osVersion": "Mac", + "clientType": "browser", + "clientCode": "CM", + "clientName": "Chrome Mobile iOS", + "clientVersion": "84.0", + "clientEngine": "WebKit", + "clientEngineVersion": "605.1.15", + "deviceName": "smartphone", + "deviceBrand": "Google", + "deviceModel": "Nexus 5", + "countryCode": "US", + "countryName": "United States", + "current": true, + "factors": [ + "email" + ], + "secret": "5e5bb8c16897e", + "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "columnPoint": { - "description": "ColumnPoint", + "identity": { + "description": "Identity", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Identity ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Identity creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "$updatedAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Identity update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { + "userId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User ID.", + "x-example": "5e5bb8c16897e" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "provider": { + "type": "string", + "description": "Identity Provider.", + "x-example": "email" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "providerUid": { + "type": "string", + "description": "ID of the User in the Identity Provider.", + "x-example": "5e5bb8c16897e" }, - "$createdAt": { + "providerEmail": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Email of the User in the Identity Provider.", + "x-example": "user@example.com" }, - "$updatedAt": { + "providerAccessToken": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Identity Provider Access Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + }, + "providerAccessTokenExpiry": { + "type": "string", + "description": "The date of when the access token expires in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - 0, - 0 - ], - "x-nullable": true + "providerRefreshToken": { + "type": "string", + "description": "Identity Provider Refresh Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "userId", + "provider", + "providerUid", + "providerEmail", + "providerAccessToken", + "providerAccessTokenExpiry", + "providerRefreshToken" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "userId": "5e5bb8c16897e", + "provider": "email", + "providerUid": "5e5bb8c16897e", + "providerEmail": "user@example.com", + "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", + "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, - "columnLine": { - "description": "ColumnLine", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { + "token": { + "description": "Token", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "Token ID.", + "x-example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Token creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$updatedAt": { + "userId": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "User ID.", + "x-example": "5e5ea5c168bb8" + }, + "secret": { + "type": "string", + "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" + }, + "expire": { + "type": "string", + "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], - "x-nullable": true + "phrase": { + "type": "string", + "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", + "x-example": "Golden Fox" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "userId", + "secret", + "expire", + "phrase" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "bb8ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ] + "userId": "5e5ea5c168bb8", + "secret": "", + "expire": "2020-10-15T06:38:00.000+00:00", + "phrase": "Golden Fox" } }, - "columnPolygon": { - "description": "ColumnPolygon", + "jwt": { + "description": "JWT", "type": "object", "properties": { - "key": { + "jwt": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + }, + "required": [ + "jwt" + ], + "example": { + "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + }, + "locale": { + "description": "Locale", + "type": "object", + "properties": { + "ip": { + "type": "string", + "description": "User IP address.", + "x-example": "127.0.0.1" }, - "type": { + "countryCode": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", + "x-example": "US" }, - "status": { + "country": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Country name. This field support localization.", + "x-example": "United States" }, - "error": { + "continentCode": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", + "x-example": "NA" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "continent": { + "type": "string", + "description": "Continent name. This field support localization.", + "x-example": "North America" }, - "array": { + "eu": { "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "True if country is part of the European Union.", + "x-example": false }, - "$createdAt": { + "currency": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { + "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", + "x-example": "USD" + } + }, + "required": [ + "ip", + "countryCode", + "country", + "continentCode", + "continent", + "eu", + "currency" + ], + "example": { + "ip": "127.0.0.1", + "countryCode": "US", + "country": "United States", + "continentCode": "NA", + "continent": "North America", + "eu": false, + "currency": "USD" + } + }, + "localeCode": { + "description": "LocaleCode", + "type": "object", + "properties": { + "code": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", + "x-example": "en-us" }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ], - "x-nullable": true + "name": { + "type": "string", + "description": "Locale name", + "x-example": "US" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "code", + "name" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "code": "en-us", + "name": "US" } }, - "columnVarchar": { - "description": "ColumnVarchar", + "file": { + "description": "File", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "File ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "bucketId": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Bucket ID.", + "x-example": "5e5ea5c16897e" }, - "status": { + "$createdAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "File creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { + "$updatedAt": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "File update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "$permissions": { + "type": "array", + "description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "name": { + "type": "string", + "description": "File name.", + "x-example": "Pink.png" }, - "$createdAt": { + "signature": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "File MD5 signature.", + "x-example": "5d529fd02b544198ae075bd57c1762bb" }, - "$updatedAt": { + "mimeType": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "File mime type.", + "x-example": "image\/png" }, - "size": { + "sizeOriginal": { "type": "integer", - "description": "Column size.", - "x-example": 128, + "description": "File original size in bytes.", + "x-example": 17890, "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true + "chunksTotal": { + "type": "integer", + "description": "Total number of chunks available", + "x-example": 17890, + "format": "int32" }, - "encrypt": { + "chunksUploaded": { + "type": "integer", + "description": "Total number of chunks uploaded", + "x-example": 17890, + "format": "int32" + }, + "encryption": { "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true + "description": "Whether file contents are encrypted at rest.", + "x-example": true + }, + "compression": { + "type": "string", + "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", + "x-example": "gzip" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", + "bucketId", "$createdAt", "$updatedAt", - "size" + "$permissions", + "name", + "signature", + "mimeType", + "sizeOriginal", + "chunksTotal", + "chunksUploaded", + "encryption", + "compression" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", + "bucketId": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "$permissions": [ + "read(\"any\")" + ], + "name": "Pink.png", + "signature": "5d529fd02b544198ae075bd57c1762bb", + "mimeType": "image\/png", + "sizeOriginal": 17890, + "chunksTotal": 17890, + "chunksUploaded": 17890, + "encryption": true, + "compression": "gzip" } }, - "columnText": { - "description": "ColumnText", + "bucket": { + "description": "Bucket", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Bucket ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Bucket creation time in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "$updatedAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Bucket update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "$permissions": { + "type": "array", + "description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] }, - "required": { + "fileSecurity": { "type": "boolean", - "description": "Is column required?", + "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "x-example": true }, - "array": { + "name": { + "type": "string", + "description": "Bucket name.", + "x-example": "Documents" + }, + "enabled": { "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "Bucket enabled.", + "x-example": false }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size supported.", + "x-example": 100, + "format": "int32" }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions.", + "items": { + "type": "string" + }, + "x-example": [ + "jpg", + "png" + ] }, - "default": { + "compression": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true + "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", + "x-example": "gzip" }, - "encrypt": { + "encryption": { "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true + "description": "Bucket is encrypted.", + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Virus scanning is enabled.", + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Image transformations are enabled.", + "x-example": false + }, + "totalSize": { + "type": "integer", + "description": "Total size of this bucket in bytes.", + "x-example": 128, + "format": "int32" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "$permissions", + "fileSecurity", + "name", + "enabled", + "maximumFileSize", + "allowedFileExtensions", + "compression", + "encryption", + "antivirus", + "transformations", + "totalSize" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "$permissions": [ + "read(\"any\")" + ], + "fileSecurity": true, + "name": "Documents", + "enabled": false, + "maximumFileSize": 100, + "allowedFileExtensions": [ + "jpg", + "png" + ], + "compression": "gzip", + "encryption": false, + "antivirus": false, + "transformations": false, + "totalSize": 128 } }, - "columnMediumtext": { - "description": "ColumnMediumtext", + "resourceToken": { + "description": "ResourceToken", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Token ID.", + "x-example": "bb8ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Token creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "resourceId": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Resource ID.", + "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" }, - "error": { + "resourceType": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "Resource type.", + "x-example": "files" }, - "$createdAt": { + "expire": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$updatedAt": { + "secret": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, - "default": { + "accessedAt": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "resourceId", + "resourceType", + "expire", + "secret", + "accessedAt" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "bb8ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8", + "resourceType": "files", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "accessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "columnLongtext": { - "description": "ColumnLongtext", + "team": { + "description": "Team", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { + "$id": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "Team ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Team creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Team update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "name": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true + "description": "Team name.", + "x-example": "VIP" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true + "total": { + "type": "integer", + "description": "Total number of team members.", + "x-example": 7, + "format": "int32" + }, + "prefs": { + "type": "object", + "description": "Team preferences as a key-value object", + "x-example": { + "theme": "pink", + "timezone": "UTC" + }, + "items": { + "type": "object", + "$ref": "#\/definitions\/preferences" + } } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "name", + "total", + "prefs" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "name": "VIP", + "total": 7, + "prefs": { + "theme": "pink", + "timezone": "UTC" + } } }, - "index": { - "description": "Index", + "membership": { + "description": "Membership", "type": "object", "properties": { "$id": { "type": "string", - "description": "Index ID.", + "description": "Membership ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Index creation date in ISO 8601 format.", + "description": "Membership creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Index update date in ISO 8601 format.", + "description": "Membership update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "key": { + "userId": { "type": "string", - "description": "Index key.", - "x-example": "index1" + "description": "User ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "userName": { "type": "string", - "description": "Index type.", - "x-example": "primary" + "description": "User name. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "John Doe" }, - "status": { + "userEmail": { "type": "string", - "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ] + "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "john@appwrite.io" }, - "error": { + "userPhone": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "+1 555 555 5555" }, - "attributes": { - "type": "array", - "description": "Index attributes.", - "items": { - "type": "string" - }, - "x-example": [] + "teamId": { + "type": "string", + "description": "Team ID.", + "x-example": "5e5ea5c16897e" }, - "lengths": { - "type": "array", - "description": "Index attributes length.", - "items": { - "type": "integer", - "format": "int32" - }, - "x-example": [] + "teamName": { + "type": "string", + "description": "Team name.", + "x-example": "VIP" }, - "orders": { + "invited": { + "type": "string", + "description": "Date, the user has been invited to join the team in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "joined": { + "type": "string", + "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "confirm": { + "type": "boolean", + "description": "User confirmation status, true if the user has joined the team or false otherwise.", + "x-example": false + }, + "mfa": { + "type": "boolean", + "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", + "x-example": false + }, + "roles": { "type": "array", - "description": "Index orders.", + "description": "User list of roles", "items": { "type": "string" }, - "x-example": [], - "x-nullable": true + "x-example": [ + "owner" + ] } }, "required": [ "$id", "$createdAt", "$updatedAt", - "key", - "type", - "status", - "error", - "attributes", - "lengths" + "userId", + "userName", + "userEmail", + "userPhone", + "teamId", + "teamName", + "invited", + "joined", + "confirm", + "mfa", + "roles" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "key": "index1", - "type": "primary", - "status": "available", - "error": "string", - "attributes": [], - "lengths": [], - "orders": [] + "userId": "5e5ea5c16897e", + "userName": "John Doe", + "userEmail": "john@appwrite.io", + "userPhone": "+1 555 555 5555", + "teamId": "5e5ea5c16897e", + "teamName": "VIP", + "invited": "2020-10-15T06:38:00.000+00:00", + "joined": "2020-10-15T06:38:00.000+00:00", + "confirm": false, + "mfa": false, + "roles": [ + "owner" + ] } }, - "columnIndex": { - "description": "Index", + "site": { + "description": "Site", "type": "object", "properties": { "$id": { "type": "string", - "description": "Index ID.", + "description": "Site ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Index creation date in ISO 8601 format.", + "description": "Site creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Index update date in ISO 8601 format.", + "description": "Site update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "key": { + "name": { "type": "string", - "description": "Index Key.", - "x-example": "index1" + "description": "Site name.", + "x-example": "My Site" }, - "type": { + "enabled": { + "type": "boolean", + "description": "Site enabled.", + "x-example": false + }, + "live": { + "type": "boolean", + "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "x-example": false + }, + "framework": { "type": "string", - "description": "Index type.", - "x-example": "primary" + "description": "Site framework.", + "x-example": "react" }, - "status": { + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, + "deploymentId": { "type": "string", - "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available" + "description": "Site's active deployment ID.", + "x-example": "5e5ea5c16897e" }, - "error": { + "deploymentCreatedAt": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "description": "Active deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "columns": { - "type": "array", - "description": "Index columns.", - "items": { - "type": "string" - }, - "x-example": [] + "deploymentScreenshotLight": { + "type": "string", + "description": "Screenshot of active deployment with light theme preference file ID.", + "x-example": "5e5ea5c16897e" }, - "lengths": { + "deploymentScreenshotDark": { + "type": "string", + "description": "Screenshot of active deployment with dark theme preference file ID.", + "x-example": "5e5ea5c16897e" + }, + "latestDeploymentId": { + "type": "string", + "description": "Site's latest deployment ID.", + "x-example": "5e5ea5c16897e" + }, + "latestDeploymentCreatedAt": { + "type": "string", + "description": "Latest deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "latestDeploymentStatus": { + "type": "string", + "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", + "x-example": "ready" + }, + "vars": { "type": "array", - "description": "Index columns length.", + "description": "Site variables.", "items": { - "type": "integer", - "format": "int32" + "type": "object", + "$ref": "#\/definitions\/variable" }, "x-example": [] }, - "orders": { - "type": "array", - "description": "Index orders.", - "items": { - "type": "string" - }, - "x-example": [], - "x-nullable": true - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "key", - "type", - "status", - "error", - "columns", - "lengths" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "key": "index1", - "type": "primary", - "status": "available", - "error": "string", - "columns": [], - "lengths": [], - "orders": [] - } - }, - "row": { - "description": "Row", - "type": "object", - "properties": { - "$id": { + "timeout": { + "type": "integer", + "description": "Site request timeout in seconds.", + "x-example": 300, + "format": "int32" + }, + "installCommand": { "type": "string", - "description": "Row ID.", - "x-example": "5e5ea5c16897e" + "description": "The install command used to install the site dependencies.", + "x-example": "npm install" }, - "$sequence": { + "buildCommand": { "type": "string", - "description": "Row sequence ID.", - "x-example": "1", - "readOnly": true + "description": "The build command used to build the site.", + "x-example": "npm run build" }, - "$tableId": { + "startCommand": { "type": "string", - "description": "Table ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "Custom command to use when starting site runtime.", + "x-example": "node custom-server.mjs" }, - "$databaseId": { + "outputDirectory": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "The directory where the site build output is located.", + "x-example": "build" }, - "$createdAt": { + "installationId": { "type": "string", - "description": "Row creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site VCS (Version Control System) installation id.", + "x-example": "6m40at4ejk5h2u9s1hboo" }, - "$updatedAt": { + "providerRepositoryId": { "type": "string", - "description": "Row update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "VCS (Version Control System) Repository ID", + "x-example": "appwrite" }, - "$permissions": { - "type": "array", - "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - } - }, - "additionalProperties": true, - "required": [ - "$id", - "$sequence", - "$tableId", - "$databaseId", - "$createdAt", - "$updatedAt", - "$permissions" - ], - "example": { - "$id": "5e5ea5c16897e", - "$sequence": "1", - "$tableId": "5e5ea5c15117e", - "$databaseId": "5e5ea5c15117e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ] - } - }, - "document": { - "description": "Document", - "type": "object", - "properties": { - "$id": { + "providerBranch": { "type": "string", - "description": "Document ID.", - "x-example": "5e5ea5c16897e" + "description": "VCS (Version Control System) branch name", + "x-example": "main" }, - "$sequence": { + "providerRootDirectory": { "type": "string", - "description": "Document sequence ID.", - "x-example": "1", - "readOnly": true + "description": "Path to site in VCS (Version Control System) repository", + "x-example": "sites\/helloWorld" }, - "$collectionId": { + "providerSilentMode": { + "type": "boolean", + "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", + "x-example": false + }, + "buildSpecification": { "type": "string", - "description": "Collection ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" }, - "$databaseId": { + "runtimeSpecification": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "Machine specification for SSR executions.", + "x-example": "s-1vcpu-512mb" }, - "$createdAt": { + "buildRuntime": { "type": "string", - "description": "Document creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site build runtime.", + "x-example": "node-22" }, - "$updatedAt": { + "adapter": { "type": "string", - "description": "Document update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site framework adapter.", + "x-example": "static" }, - "$permissions": { - "type": "array", - "description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "fallbackFile": { + "type": "string", + "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", + "x-example": "index.html" } }, - "additionalProperties": true, "required": [ "$id", - "$sequence", - "$collectionId", - "$databaseId", "$createdAt", "$updatedAt", - "$permissions" + "name", + "enabled", + "live", + "logging", + "framework", + "deploymentRetention", + "deploymentId", + "deploymentCreatedAt", + "deploymentScreenshotLight", + "deploymentScreenshotDark", + "latestDeploymentId", + "latestDeploymentCreatedAt", + "latestDeploymentStatus", + "vars", + "timeout", + "installCommand", + "buildCommand", + "startCommand", + "outputDirectory", + "installationId", + "providerRepositoryId", + "providerBranch", + "providerRootDirectory", + "providerSilentMode", + "buildSpecification", + "runtimeSpecification", + "buildRuntime", + "adapter", + "fallbackFile" ], "example": { "$id": "5e5ea5c16897e", - "$sequence": "1", - "$collectionId": "5e5ea5c15117e", - "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "username": "john.doe", - "email": "john.doe@example.com", - "fullName": "John Doe", - "age": 30, - "isAdmin": false + "name": "My Site", + "enabled": false, + "live": false, + "logging": false, + "framework": "react", + "deploymentRetention": 7, + "deploymentId": "5e5ea5c16897e", + "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "deploymentScreenshotLight": "5e5ea5c16897e", + "deploymentScreenshotDark": "5e5ea5c16897e", + "latestDeploymentId": "5e5ea5c16897e", + "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentStatus": "ready", + "vars": [], + "timeout": 300, + "installCommand": "npm install", + "buildCommand": "npm run build", + "startCommand": "node custom-server.mjs", + "outputDirectory": "build", + "installationId": "6m40at4ejk5h2u9s1hboo", + "providerRepositoryId": "appwrite", + "providerBranch": "main", + "providerRootDirectory": "sites\/helloWorld", + "providerSilentMode": false, + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb", + "buildRuntime": "node-22", + "adapter": "static", + "fallbackFile": "index.html" } }, - "log": { - "description": "Log", + "templateSite": { + "description": "Template Site", "type": "object", "properties": { - "event": { - "type": "string", - "description": "Event name.", - "x-example": "account.sessions.create" - }, - "userId": { + "key": { "type": "string", - "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", - "x-example": "610fc2f985ee0" + "description": "Site Template ID.", + "x-example": "starter" }, - "userEmail": { + "name": { "type": "string", - "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "john@appwrite.io" + "description": "Site Template Name.", + "x-example": "Starter site" }, - "userName": { + "tagline": { "type": "string", - "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "John Doe" + "description": "Short description of template", + "x-example": "Minimal web app integrating with Appwrite." }, - "mode": { + "demoUrl": { "type": "string", - "description": "API mode when event triggered.", - "x-example": "admin" + "description": "URL hosting a template demo.", + "x-example": "https:\/\/nextjs-starter.appwrite.network\/" }, - "userType": { + "screenshotDark": { "type": "string", - "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", - "x-example": "user" + "description": "File URL with preview screenshot in dark theme preference.", + "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png" }, - "ip": { + "screenshotLight": { "type": "string", - "description": "IP session in use when the session was created.", - "x-example": "127.0.0.1" + "description": "File URL with preview screenshot in light theme preference.", + "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png" }, - "time": { - "type": "string", - "description": "Log creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "useCases": { + "type": "array", + "description": "Site use cases.", + "items": { + "type": "string" + }, + "x-example": "Starter" }, - "osCode": { - "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "frameworks": { + "type": "array", + "description": "List of frameworks that can be used with this template.", + "items": { + "type": "object", + "$ref": "#\/definitions\/templateFramework" + }, + "x-example": [] }, - "osName": { + "vcsProvider": { "type": "string", - "description": "Operating system name.", - "x-example": "Mac" + "description": "VCS (Version Control System) Provider.", + "x-example": "github" }, - "osVersion": { + "providerRepositoryId": { "type": "string", - "description": "Operating system version.", - "x-example": "Mac" + "description": "VCS (Version Control System) Repository ID", + "x-example": "templates" }, - "clientType": { + "providerOwner": { "type": "string", - "description": "Client type.", - "x-example": "browser" + "description": "VCS (Version Control System) Owner.", + "x-example": "appwrite" }, - "clientCode": { + "providerVersion": { "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "description": "VCS (Version Control System) branch version (tag).", + "x-example": "main" }, - "clientName": { + "variables": { + "type": "array", + "description": "Site variables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/templateVariable" + }, + "x-example": [] + } + }, + "required": [ + "key", + "name", + "tagline", + "demoUrl", + "screenshotDark", + "screenshotLight", + "useCases", + "frameworks", + "vcsProvider", + "providerRepositoryId", + "providerOwner", + "providerVersion", + "variables" + ], + "example": { + "key": "starter", + "name": "Starter site", + "tagline": "Minimal web app integrating with Appwrite.", + "demoUrl": "https:\/\/nextjs-starter.appwrite.network\/", + "screenshotDark": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png", + "screenshotLight": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png", + "useCases": "Starter", + "frameworks": [], + "vcsProvider": "github", + "providerRepositoryId": "templates", + "providerOwner": "appwrite", + "providerVersion": "main", + "variables": [] + } + }, + "templateFramework": { + "description": "Template Framework", + "type": "object", + "properties": { + "key": { "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "description": "Parent framework key.", + "x-example": "sveltekit" }, - "clientVersion": { + "name": { "type": "string", - "description": "Client version.", - "x-example": "84.0" + "description": "Framework Name.", + "x-example": "SvelteKit" }, - "clientEngine": { + "installCommand": { "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" + "description": "The install command used to install the dependencies.", + "x-example": "npm install" }, - "clientEngineVersion": { + "buildCommand": { "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" + "description": "The build command used to build the deployment.", + "x-example": "npm run build" }, - "deviceName": { + "outputDirectory": { "type": "string", - "description": "Device name.", - "x-example": "smartphone" + "description": "The output directory to store the build output.", + "x-example": ".\/build" }, - "deviceBrand": { + "providerRootDirectory": { "type": "string", - "description": "Device brand name.", - "x-example": "Google" + "description": "Path to site in VCS (Version Control System) repository", + "x-example": ".\/svelte-kit\/starter" }, - "deviceModel": { + "buildRuntime": { "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" + "description": "Runtime used during build step of template.", + "x-example": "node-22" }, - "countryCode": { + "adapter": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "Site framework runtime", + "x-example": "ssr" }, - "countryName": { + "fallbackFile": { "type": "string", - "description": "Country name.", - "x-example": "United States" + "description": "Fallback file for SPA. Only relevant for static serve runtime.", + "x-example": "index.html" } }, "required": [ - "event", - "userId", - "userEmail", - "userName", - "mode", - "userType", - "ip", - "time", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", - "countryCode", - "countryName" + "key", + "name", + "installCommand", + "buildCommand", + "outputDirectory", + "providerRootDirectory", + "buildRuntime", + "adapter", + "fallbackFile" ], "example": { - "event": "account.sessions.create", - "userId": "610fc2f985ee0", - "userEmail": "john@appwrite.io", - "userName": "John Doe", - "mode": "admin", - "userType": "user", - "ip": "127.0.0.1", - "time": "2020-10-15T06:38:00.000+00:00", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", - "countryCode": "US", - "countryName": "United States" + "key": "sveltekit", + "name": "SvelteKit", + "installCommand": "npm install", + "buildCommand": "npm run build", + "outputDirectory": ".\/build", + "providerRootDirectory": ".\/svelte-kit\/starter", + "buildRuntime": "node-22", + "adapter": "ssr", + "fallbackFile": "index.html" } }, - "user": { - "description": "User", + "function": { + "description": "Function", "type": "object", "properties": { "$id": { "type": "string", - "description": "User ID.", + "description": "Function ID.", "x-example": "5e5ea5c16897e" }, - "$createdAt": { + "$createdAt": { + "type": "string", + "description": "Function creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Function update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "execute": { + "type": "array", + "description": "Execution permissions.", + "items": { + "type": "string" + }, + "x-example": "users" + }, + "name": { + "type": "string", + "description": "Function name.", + "x-example": "My Function" + }, + "enabled": { + "type": "boolean", + "description": "Function enabled.", + "x-example": false + }, + "live": { + "type": "boolean", + "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", + "x-example": false + }, + "runtime": { + "type": "string", + "description": "Function execution and build runtime.", + "x-example": "python-3.8" + }, + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, + "deploymentId": { "type": "string", - "description": "User creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Function's active deployment ID.", + "x-example": "5e5ea5c16897e" }, - "$updatedAt": { + "deploymentCreatedAt": { "type": "string", - "description": "User update date in ISO 8601 format.", + "description": "Active deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "latestDeploymentId": { "type": "string", - "description": "User name.", - "x-example": "John Doe" + "description": "Function's latest deployment ID.", + "x-example": "5e5ea5c16897e" }, - "password": { + "latestDeploymentCreatedAt": { "type": "string", - "description": "Hashed user password.", - "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", - "x-nullable": true + "description": "Latest deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "hash": { + "latestDeploymentStatus": { "type": "string", - "description": "Password hashing algorithm.", - "x-example": "argon2", - "x-nullable": true + "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", + "x-example": "ready" }, - "hashOptions": { - "type": "object", - "description": "Password hashing algorithm configuration.", - "x-example": {}, + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", "items": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/algoArgon2" - }, - { - "$ref": "#\/definitions\/algoScrypt" - }, - { - "$ref": "#\/definitions\/algoScryptModified" - }, - { - "$ref": "#\/definitions\/algoBcrypt" - }, - { - "$ref": "#\/definitions\/algoPhpass" - }, - { - "$ref": "#\/definitions\/algoSha" - }, - { - "$ref": "#\/definitions\/algoMd5" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/definitions\/algoArgon2", - "scrypt": "#\/definitions\/algoScrypt", - "scryptMod": "#\/definitions\/algoScryptModified", - "bcrypt": "#\/definitions\/algoBcrypt", - "phpass": "#\/definitions\/algoPhpass", - "sha": "#\/definitions\/algoSha", - "md5": "#\/definitions\/algoMd5" - } - } + "type": "string" }, - "x-nullable": true - }, - "registration": { - "type": "string", - "description": "User registration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "x-example": "users.read" }, - "status": { - "type": "boolean", - "description": "User status. Pass `true` for enabled and `false` for disabled.", - "x-example": true + "vars": { + "type": "array", + "description": "Function variables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/variable" + }, + "x-example": [] }, - "labels": { + "events": { "type": "array", - "description": "Labels for the user.", + "description": "Function trigger events.", "items": { "type": "string" }, - "x-example": [ - "vip" - ] + "x-example": "account.create" }, - "passwordUpdate": { + "schedule": { "type": "string", - "description": "Password update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Function execution schedule in CRON format.", + "x-example": "5 4 * * *" }, - "email": { - "type": "string", - "description": "User email address.", - "x-example": "john@appwrite.io" + "timeout": { + "type": "integer", + "description": "Function execution timeout in seconds.", + "x-example": 300, + "format": "int32" }, - "phone": { + "entrypoint": { "type": "string", - "description": "User phone number in E.164 format.", - "x-example": "+4930901820" + "description": "The entrypoint file used to execute the deployment.", + "x-example": "index.js" }, - "emailVerification": { - "type": "boolean", - "description": "Email verification status.", - "x-example": true + "commands": { + "type": "string", + "description": "The build command used to build the deployment.", + "x-example": "npm install" }, - "phoneVerification": { - "type": "boolean", - "description": "Phone verification status.", - "x-example": true + "version": { + "type": "string", + "description": "Version of Open Runtimes used for the function.", + "x-example": "v2" }, - "mfa": { - "type": "boolean", - "description": "Multi factor authentication status.", - "x-example": true + "installationId": { + "type": "string", + "description": "Function VCS (Version Control System) installation id.", + "x-example": "6m40at4ejk5h2u9s1hboo" }, - "prefs": { - "type": "object", - "description": "User preferences as a key-value object", - "x-example": { - "theme": "pink", - "timezone": "UTC" - }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } + "providerRepositoryId": { + "type": "string", + "description": "VCS (Version Control System) Repository ID", + "x-example": "appwrite" }, - "targets": { - "type": "array", - "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", - "items": { - "type": "object", - "$ref": "#\/definitions\/target" - }, - "x-example": [] + "providerBranch": { + "type": "string", + "description": "VCS (Version Control System) branch name", + "x-example": "main" }, - "accessedAt": { + "providerRootDirectory": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Path to function in VCS (Version Control System) repository", + "x-example": "functions\/helloWorld" }, - "impersonator": { + "providerSilentMode": { "type": "boolean", - "description": "Whether the user can impersonate other users.", - "x-example": false, - "x-nullable": true + "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", + "x-example": false }, - "impersonatorUserId": { + "buildSpecification": { "type": "string", - "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", - "x-example": "5e5ea5c16897e", - "x-nullable": true + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { + "type": "string", + "description": "Machine specification for executions.", + "x-example": "s-1vcpu-512mb" } }, "required": [ "$id", "$createdAt", "$updatedAt", + "execute", "name", - "registration", - "status", - "labels", - "passwordUpdate", - "email", - "phone", - "emailVerification", - "phoneVerification", - "mfa", - "prefs", - "targets", - "accessedAt" + "enabled", + "live", + "logging", + "runtime", + "deploymentRetention", + "deploymentId", + "deploymentCreatedAt", + "latestDeploymentId", + "latestDeploymentCreatedAt", + "latestDeploymentStatus", + "scopes", + "vars", + "events", + "schedule", + "timeout", + "entrypoint", + "commands", + "version", + "installationId", + "providerRepositoryId", + "providerBranch", + "providerRootDirectory", + "providerSilentMode", + "buildSpecification", + "runtimeSpecification" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "John Doe", - "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", - "hash": "argon2", - "hashOptions": {}, - "registration": "2020-10-15T06:38:00.000+00:00", - "status": true, - "labels": [ - "vip" - ], - "passwordUpdate": "2020-10-15T06:38:00.000+00:00", - "email": "john@appwrite.io", - "phone": "+4930901820", - "emailVerification": true, - "phoneVerification": true, - "mfa": true, - "prefs": { - "theme": "pink", - "timezone": "UTC" - }, - "targets": [], - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "impersonator": false, - "impersonatorUserId": "5e5ea5c16897e" + "execute": "users", + "name": "My Function", + "enabled": false, + "live": false, + "logging": false, + "runtime": "python-3.8", + "deploymentRetention": 7, + "deploymentId": "5e5ea5c16897e", + "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentId": "5e5ea5c16897e", + "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentStatus": "ready", + "scopes": "users.read", + "vars": [], + "events": "account.create", + "schedule": "5 4 * * *", + "timeout": 300, + "entrypoint": "index.js", + "commands": "npm install", + "version": "v2", + "installationId": "6m40at4ejk5h2u9s1hboo", + "providerRepositoryId": "appwrite", + "providerBranch": "main", + "providerRootDirectory": "functions\/helloWorld", + "providerSilentMode": false, + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb" } }, - "algoMd5": { - "description": "AlgoMD5", + "templateFunction": { + "description": "Template Function", "type": "object", "properties": { - "type": { + "icon": { "type": "string", - "description": "Algo type.", - "x-example": "md5" - } - }, - "required": [ - "type" - ], - "example": { - "type": "md5" - } - }, - "algoSha": { - "description": "AlgoSHA", - "type": "object", - "properties": { - "type": { + "description": "Function Template Icon.", + "x-example": "icon-lightning-bolt" + }, + "id": { "type": "string", - "description": "Algo type.", - "x-example": "sha" - } - }, - "required": [ - "type" - ], - "example": { - "type": "sha" - } - }, - "algoPhpass": { - "description": "AlgoPHPass", - "type": "object", - "properties": { - "type": { + "description": "Function Template ID.", + "x-example": "starter" + }, + "name": { "type": "string", - "description": "Algo type.", - "x-example": "phpass" - } - }, - "required": [ - "type" - ], - "example": { - "type": "phpass" - } - }, - "algoBcrypt": { - "description": "AlgoBcrypt", - "type": "object", - "properties": { - "type": { + "description": "Function Template Name.", + "x-example": "Starter function" + }, + "tagline": { "type": "string", - "description": "Algo type.", - "x-example": "bcrypt" - } - }, - "required": [ - "type" - ], - "example": { - "type": "bcrypt" - } - }, - "algoScrypt": { - "description": "AlgoScrypt", - "type": "object", - "properties": { - "type": { + "description": "Function Template Tagline.", + "x-example": "A simple function to get started." + }, + "permissions": { + "type": "array", + "description": "Execution permissions.", + "items": { + "type": "string" + }, + "x-example": "any" + }, + "events": { + "type": "array", + "description": "Function trigger events.", + "items": { + "type": "string" + }, + "x-example": "account.create" + }, + "cron": { "type": "string", - "description": "Algo type.", - "x-example": "scrypt" + "description": "Function execution schedult in CRON format.", + "x-example": "0 0 * * *" }, - "costCpu": { + "timeout": { "type": "integer", - "description": "CPU complexity of computed hash.", - "x-example": 8, + "description": "Function execution timeout in seconds.", + "x-example": 300, "format": "int32" }, - "costMemory": { - "type": "integer", - "description": "Memory complexity of computed hash.", - "x-example": 14, - "format": "int32" + "useCases": { + "type": "array", + "description": "Function use cases.", + "items": { + "type": "string" + }, + "x-example": "Starter" }, - "costParallel": { - "type": "integer", - "description": "Parallelization of computed hash.", - "x-example": 1, - "format": "int32" + "runtimes": { + "type": "array", + "description": "List of runtimes that can be used with this template.", + "items": { + "type": "object", + "$ref": "#\/definitions\/templateRuntime" + }, + "x-example": [] }, - "length": { - "type": "integer", - "description": "Length used to compute hash.", - "x-example": 64, - "format": "int32" + "instructions": { + "type": "string", + "description": "Function Template Instructions.", + "x-example": "For documentation and instructions check out ." + }, + "vcsProvider": { + "type": "string", + "description": "VCS (Version Control System) Provider.", + "x-example": "github" + }, + "providerRepositoryId": { + "type": "string", + "description": "VCS (Version Control System) Repository ID", + "x-example": "templates" + }, + "providerOwner": { + "type": "string", + "description": "VCS (Version Control System) Owner.", + "x-example": "appwrite" + }, + "providerVersion": { + "type": "string", + "description": "VCS (Version Control System) branch version (tag).", + "x-example": "main" + }, + "variables": { + "type": "array", + "description": "Function variables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/templateVariable" + }, + "x-example": [] + }, + "scopes": { + "type": "array", + "description": "Function scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" } }, "required": [ - "type", - "costCpu", - "costMemory", - "costParallel", - "length" + "icon", + "id", + "name", + "tagline", + "permissions", + "events", + "cron", + "timeout", + "useCases", + "runtimes", + "instructions", + "vcsProvider", + "providerRepositoryId", + "providerOwner", + "providerVersion", + "variables", + "scopes" ], "example": { - "type": "scrypt", - "costCpu": 8, - "costMemory": 14, - "costParallel": 1, - "length": 64 + "icon": "icon-lightning-bolt", + "id": "starter", + "name": "Starter function", + "tagline": "A simple function to get started.", + "permissions": "any", + "events": "account.create", + "cron": "0 0 * * *", + "timeout": 300, + "useCases": "Starter", + "runtimes": [], + "instructions": "For documentation and instructions check out .", + "vcsProvider": "github", + "providerRepositoryId": "templates", + "providerOwner": "appwrite", + "providerVersion": "main", + "variables": [], + "scopes": "users.read" } }, - "algoScryptModified": { - "description": "AlgoScryptModified", + "templateRuntime": { + "description": "Template Runtime", "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Algo type.", - "x-example": "scryptMod" + "description": "Runtime Name.", + "x-example": "node-19.0" }, - "salt": { + "commands": { "type": "string", - "description": "Salt used to compute hash.", - "x-example": "UxLMreBr6tYyjQ==" + "description": "The build command used to build the deployment.", + "x-example": "npm install" }, - "saltSeparator": { + "entrypoint": { "type": "string", - "description": "Separator used to compute hash.", - "x-example": "Bw==" + "description": "The entrypoint file used to execute the deployment.", + "x-example": "index.js" }, - "signerKey": { + "providerRootDirectory": { "type": "string", - "description": "Key used to compute hash.", - "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "description": "Path to function in VCS (Version Control System) repository", + "x-example": "node\/starter" } }, "required": [ - "type", - "salt", - "saltSeparator", - "signerKey" + "name", + "commands", + "entrypoint", + "providerRootDirectory" ], "example": { - "type": "scryptMod", - "salt": "UxLMreBr6tYyjQ==", - "saltSeparator": "Bw==", - "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "name": "node-19.0", + "commands": "npm install", + "entrypoint": "index.js", + "providerRootDirectory": "node\/starter" } }, - "algoArgon2": { - "description": "AlgoArgon2", + "templateVariable": { + "description": "Template Variable", "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Algo type.", - "x-example": "argon2" + "description": "Variable Name.", + "x-example": "APPWRITE_DATABASE_ID" }, - "memoryCost": { - "type": "integer", - "description": "Memory used to compute hash.", - "x-example": 65536, - "format": "int32" + "description": { + "type": "string", + "description": "Variable Description.", + "x-example": "The ID of the Appwrite database that contains the collection to sync." }, - "timeCost": { - "type": "integer", - "description": "Amount of time consumed to compute hash", - "x-example": 4, - "format": "int32" + "value": { + "type": "string", + "description": "Variable Value.", + "x-example": "512" }, - "threads": { - "type": "integer", - "description": "Number of threads used to compute hash.", - "x-example": 3, - "format": "int32" + "secret": { + "type": "boolean", + "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", + "x-example": false + }, + "placeholder": { + "type": "string", + "description": "Variable Placeholder.", + "x-example": "64a55...7b912" + }, + "required": { + "type": "boolean", + "description": "Is the variable required?", + "x-example": false + }, + "type": { + "type": "string", + "description": "Variable Type.", + "x-example": "password" } }, "required": [ - "type", - "memoryCost", - "timeCost", - "threads" + "name", + "description", + "value", + "secret", + "placeholder", + "required", + "type" ], "example": { - "type": "argon2", - "memoryCost": 65536, - "timeCost": 4, - "threads": 3 - } - }, - "preferences": { - "description": "Preferences", - "type": "object", - "additionalProperties": true, - "example": { - "language": "en", - "timezone": "UTC", - "darkTheme": true + "name": "APPWRITE_DATABASE_ID", + "description": "The ID of the Appwrite database that contains the collection to sync.", + "value": "512", + "secret": false, + "placeholder": "64a55...7b912", + "required": false, + "type": "password" } }, - "session": { - "description": "Session", + "installation": { + "description": "Installation", "type": "object", "properties": { "$id": { "type": "string", - "description": "Session ID.", + "description": "Function ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Session creation date in ISO 8601 format.", + "description": "Function creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Session update date in ISO 8601 format.", + "description": "Function update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "userId": { + "provider": { "type": "string", - "description": "User ID.", - "x-example": "5e5bb8c16897e" + "description": "VCS (Version Control System) provider name.", + "x-example": "github" }, - "expire": { + "organization": { "type": "string", - "description": "Session expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "VCS (Version Control System) organization name.", + "x-example": "appwrite" }, - "provider": { + "providerInstallationId": { "type": "string", - "description": "Session Provider.", - "x-example": "email" + "description": "VCS (Version Control System) installation ID.", + "x-example": "5322" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "provider", + "organization", + "providerInstallationId" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "provider": "github", + "organization": "appwrite", + "providerInstallationId": "5322" + } + }, + "providerRepository": { + "description": "ProviderRepository", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" }, - "providerUid": { + "name": { "type": "string", - "description": "Session Provider User ID.", - "x-example": "user@example.com" + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" }, - "providerAccessToken": { + "organization": { "type": "string", - "description": "Session Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" }, - "providerAccessTokenExpiry": { + "provider": { "type": "string", - "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "VCS (Version Control System) provider name.", + "x-example": "github" }, - "providerRefreshToken": { + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "defaultBranch": { "type": "string", - "description": "Session Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "VCS (Version Control System) repository's default branch name.", + "x-example": "main" }, - "ip": { + "providerInstallationId": { "type": "string", - "description": "IP in use when the session was created.", - "x-example": "127.0.0.1" + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" }, - "osCode": { + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, + "pushedAt": { "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" }, - "osName": { + "variables": { + "type": "array", + "description": "Environment variables found in .env files", + "items": { + "type": "string" + }, + "x-example": [ + "PORT", + "NODE_ENV" + ] + } + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "defaultBranch", + "providerInstallationId", + "authorized", + "pushedAt", + "variables" + ], + "example": { + "id": "5e5ea5c16897e", + "name": "appwrite", + "organization": "appwrite", + "provider": "github", + "private": true, + "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, + "pushedAt": "datetime", + "variables": [ + "PORT", + "NODE_ENV" + ] + } + }, + "providerRepositoryFramework": { + "description": "ProviderRepositoryFramework", + "type": "object", + "properties": { + "id": { "type": "string", - "description": "Operating system name.", - "x-example": "Mac" + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" }, - "osVersion": { + "name": { "type": "string", - "description": "Operating system version.", - "x-example": "Mac" + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" }, - "clientType": { + "organization": { "type": "string", - "description": "Client type.", - "x-example": "browser" + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" }, - "clientCode": { + "provider": { "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "description": "VCS (Version Control System) provider name.", + "x-example": "github" }, - "clientName": { + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "defaultBranch": { "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "description": "VCS (Version Control System) repository's default branch name.", + "x-example": "main" }, - "clientVersion": { + "providerInstallationId": { "type": "string", - "description": "Client version.", - "x-example": "84.0" + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" }, - "clientEngine": { + "authorized": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository authorized for the installation?", + "x-example": true + }, + "pushedAt": { "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" }, - "clientEngineVersion": { + "variables": { + "type": "array", + "description": "Environment variables found in .env files", + "items": { + "type": "string" + }, + "x-example": [ + "PORT", + "NODE_ENV" + ] + }, + "framework": { "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" + "description": "Auto-detected framework. Empty if type is not \"framework\".", + "x-example": "nextjs" + } + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "defaultBranch", + "providerInstallationId", + "authorized", + "pushedAt", + "variables", + "framework" + ], + "example": { + "id": "5e5ea5c16897e", + "name": "appwrite", + "organization": "appwrite", + "provider": "github", + "private": true, + "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, + "pushedAt": "datetime", + "variables": [ + "PORT", + "NODE_ENV" + ], + "framework": "nextjs" + } + }, + "providerRepositoryRuntime": { + "description": "ProviderRepositoryRuntime", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" }, - "deviceName": { + "name": { "type": "string", - "description": "Device name.", - "x-example": "smartphone" + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" }, - "deviceBrand": { + "organization": { "type": "string", - "description": "Device brand name.", - "x-example": "Google" + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" }, - "deviceModel": { + "provider": { "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" + "description": "VCS (Version Control System) provider name.", + "x-example": "github" }, - "countryCode": { + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "defaultBranch": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "VCS (Version Control System) repository's default branch name.", + "x-example": "main" }, - "countryName": { + "providerInstallationId": { "type": "string", - "description": "Country name.", - "x-example": "United States" + "description": "VCS (Version Control System) installation ID.", + "x-example": "108104697" }, - "current": { + "authorized": { "type": "boolean", - "description": "Returns true if this the current user session.", + "description": "Is VCS (Version Control System) repository authorized for the installation?", "x-example": true }, - "factors": { + "pushedAt": { + "type": "string", + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" + }, + "variables": { "type": "array", - "description": "Returns a list of active session factors.", + "description": "Environment variables found in .env files", "items": { "type": "string" }, "x-example": [ - "email" + "PORT", + "NODE_ENV" ] }, - "secret": { - "type": "string", - "description": "Secret used to authenticate the user. Only included if the request was made with an API key", - "x-example": "5e5bb8c16897e" - }, - "mfaUpdatedAt": { + "runtime": { "type": "string", - "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Auto-detected runtime. Empty if type is not \"runtime\".", + "x-example": "node-22" } }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "userId", - "expire", - "provider", - "providerUid", - "providerAccessToken", - "providerAccessTokenExpiry", - "providerRefreshToken", - "ip", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", - "countryCode", - "countryName", - "current", - "factors", - "secret", - "mfaUpdatedAt" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5bb8c16897e", - "expire": "2020-10-15T06:38:00.000+00:00", - "provider": "email", - "providerUid": "user@example.com", - "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", - "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "ip": "127.0.0.1", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", - "countryCode": "US", - "countryName": "United States", - "current": true, - "factors": [ - "email" + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "defaultBranch", + "providerInstallationId", + "authorized", + "pushedAt", + "variables", + "runtime" + ], + "example": { + "id": "5e5ea5c16897e", + "name": "appwrite", + "organization": "appwrite", + "provider": "github", + "private": true, + "defaultBranch": "main", + "providerInstallationId": "108104697", + "authorized": true, + "pushedAt": "datetime", + "variables": [ + "PORT", + "NODE_ENV" ], - "secret": "5e5bb8c16897e", - "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00" + "runtime": "node-22" } }, - "identity": { - "description": "Identity", + "detectionFramework": { + "description": "DetectionFramework", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Identity ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Identity creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Identity update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "userId": { - "type": "string", - "description": "User ID.", - "x-example": "5e5bb8c16897e" - }, - "provider": { + "type": { "type": "string", - "description": "Identity Provider.", - "x-example": "email" + "description": "Repository detection type.", + "x-example": "framework", + "enum": [ + "framework" + ] }, - "providerUid": { - "type": "string", - "description": "ID of the User in the Identity Provider.", - "x-example": "5e5bb8c16897e" + "variables": { + "type": "array", + "description": "Environment variables found in .env files", + "items": { + "type": "object", + "$ref": "#\/definitions\/detectionVariable" + }, + "x-example": {}, + "x-nullable": true }, - "providerEmail": { + "framework": { "type": "string", - "description": "Email of the User in the Identity Provider.", - "x-example": "user@example.com" + "description": "Framework", + "x-example": "nuxt" }, - "providerAccessToken": { + "installCommand": { "type": "string", - "description": "Identity Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Site Install Command", + "x-example": "npm install" }, - "providerAccessTokenExpiry": { + "buildCommand": { "type": "string", - "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Site Build Command", + "x-example": "npm run build" }, - "providerRefreshToken": { + "outputDirectory": { "type": "string", - "description": "Identity Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Site Output Directory", + "x-example": "dist" } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "userId", - "provider", - "providerUid", - "providerEmail", - "providerAccessToken", - "providerAccessTokenExpiry", - "providerRefreshToken" + "type", + "framework", + "installCommand", + "buildCommand", + "outputDirectory" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5bb8c16897e", - "provider": "email", - "providerUid": "5e5bb8c16897e", - "providerEmail": "user@example.com", - "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", - "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "type": "framework", + "variables": {}, + "framework": "nuxt", + "installCommand": "npm install", + "buildCommand": "npm run build", + "outputDirectory": "dist" } }, - "token": { - "description": "Token", + "detectionRuntime": { + "description": "DetectionRuntime", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" - }, - "$createdAt": { + "type": { "type": "string", - "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Repository detection type.", + "x-example": "runtime", + "enum": [ + "runtime" + ] }, - "userId": { - "type": "string", - "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "variables": { + "type": "array", + "description": "Environment variables found in .env files", + "items": { + "type": "object", + "$ref": "#\/definitions\/detectionVariable" + }, + "x-example": {}, + "x-nullable": true }, - "secret": { + "runtime": { "type": "string", - "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "description": "Runtime", + "x-example": "node" }, - "expire": { + "entrypoint": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Function Entrypoint", + "x-example": "index.js" }, - "phrase": { + "commands": { "type": "string", - "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", - "x-example": "Golden Fox" + "description": "Function install and build commands", + "x-example": "npm install && npm run build" } }, "required": [ - "$id", - "$createdAt", - "userId", - "secret", - "expire", - "phrase" + "type", + "runtime", + "entrypoint", + "commands" ], "example": { - "$id": "bb8ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c168bb8", - "secret": "", - "expire": "2020-10-15T06:38:00.000+00:00", - "phrase": "Golden Fox" + "type": "runtime", + "variables": {}, + "runtime": "node", + "entrypoint": "index.js", + "commands": "npm install && npm run build" } }, - "jwt": { - "description": "JWT", + "detectionVariable": { + "description": "DetectionVariable", "type": "object", "properties": { - "jwt": { + "name": { "type": "string", - "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "description": "Name of environment variable", + "x-example": "NODE_ENV" + }, + "value": { + "type": "string", + "description": "Value of environment variable", + "x-example": "production" } }, "required": [ - "jwt" + "name", + "value" ], "example": { - "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "name": "NODE_ENV", + "value": "production" } }, - "locale": { - "description": "Locale", + "vcsContent": { + "description": "VcsContents", "type": "object", "properties": { - "ip": { - "type": "string", - "description": "User IP address.", - "x-example": "127.0.0.1" - }, - "countryCode": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", - "x-example": "US" - }, - "country": { - "type": "string", - "description": "Country name. This field support localization.", - "x-example": "United States" - }, - "continentCode": { - "type": "string", - "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", - "x-example": "NA" - }, - "continent": { - "type": "string", - "description": "Continent name. This field support localization.", - "x-example": "North America" + "size": { + "type": "integer", + "description": "Content size in bytes. Only files have size, and for directories, 0 is returned.", + "x-example": 1523, + "format": "int32", + "x-nullable": true }, - "eu": { + "isDirectory": { "type": "boolean", - "description": "True if country is part of the European Union.", - "x-example": false + "description": "If a content is a directory. Directories can be used to check nested contents.", + "x-example": true, + "x-nullable": true }, - "currency": { + "name": { "type": "string", - "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", - "x-example": "USD" + "description": "Name of directory or file.", + "x-example": "Main.java" } }, "required": [ - "ip", - "countryCode", - "country", - "continentCode", - "continent", - "eu", - "currency" + "name" ], "example": { - "ip": "127.0.0.1", - "countryCode": "US", - "country": "United States", - "continentCode": "NA", - "continent": "North America", - "eu": false, - "currency": "USD" + "size": 1523, + "isDirectory": true, + "name": "Main.java" } }, - "localeCode": { - "description": "LocaleCode", + "branch": { + "description": "Branch", "type": "object", "properties": { - "code": { - "type": "string", - "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", - "x-example": "en-us" - }, "name": { "type": "string", - "description": "Locale name", - "x-example": "US" + "description": "Branch Name.", + "x-example": "main" } }, "required": [ - "code", "name" ], "example": { - "code": "en-us", - "name": "US" + "name": "main" } }, - "file": { - "description": "File", + "runtime": { + "description": "Runtime", "type": "object", "properties": { "$id": { "type": "string", - "description": "File ID.", - "x-example": "5e5ea5c16897e" + "description": "Runtime ID.", + "x-example": "python-3.8" }, - "bucketId": { + "key": { "type": "string", - "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" + "description": "Parent runtime key.", + "x-example": "python" }, - "$createdAt": { + "name": { "type": "string", - "description": "File creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Runtime Name.", + "x-example": "Python" }, - "$updatedAt": { + "version": { "type": "string", - "description": "File update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "description": "Runtime version.", + "x-example": "3.8" }, - "name": { + "base": { "type": "string", - "description": "File name.", - "x-example": "Pink.png" + "description": "Base Docker image used to build the runtime.", + "x-example": "python:3.8-alpine" }, - "signature": { + "image": { "type": "string", - "description": "File MD5 signature.", - "x-example": "5d529fd02b544198ae075bd57c1762bb" + "description": "Image name of Docker Hub.", + "x-example": "appwrite\\\/runtime-for-python:3.8" }, - "mimeType": { + "logo": { "type": "string", - "description": "File mime type.", - "x-example": "image\/png" - }, - "sizeOriginal": { - "type": "integer", - "description": "File original size in bytes.", - "x-example": 17890, - "format": "int32" - }, - "chunksTotal": { - "type": "integer", - "description": "Total number of chunks available", - "x-example": 17890, - "format": "int32" - }, - "chunksUploaded": { - "type": "integer", - "description": "Total number of chunks uploaded", - "x-example": 17890, - "format": "int32" - }, - "encryption": { - "type": "boolean", - "description": "Whether file contents are encrypted at rest.", - "x-example": true + "description": "Name of the logo image.", + "x-example": "python.png" }, - "compression": { - "type": "string", - "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "supports": { + "type": "array", + "description": "List of supported architectures.", + "items": { + "type": "string" + }, + "x-example": "amd64" } }, "required": [ "$id", - "bucketId", - "$createdAt", - "$updatedAt", - "$permissions", + "key", "name", - "signature", - "mimeType", - "sizeOriginal", - "chunksTotal", - "chunksUploaded", - "encryption", - "compression" + "version", + "base", + "image", + "logo", + "supports" ], "example": { - "$id": "5e5ea5c16897e", - "bucketId": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "name": "Pink.png", - "signature": "5d529fd02b544198ae075bd57c1762bb", - "mimeType": "image\/png", - "sizeOriginal": 17890, - "chunksTotal": 17890, - "chunksUploaded": 17890, - "encryption": true, - "compression": "gzip" + "$id": "python-3.8", + "key": "python", + "name": "Python", + "version": "3.8", + "base": "python:3.8-alpine", + "image": "appwrite\\\/runtime-for-python:3.8", + "logo": "python.png", + "supports": "amd64" } }, - "bucket": { - "description": "Bucket", + "framework": { + "description": "Framework", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Bucket creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { + "key": { "type": "string", - "description": "Bucket update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - }, - "fileSecurity": { - "type": "boolean", - "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "description": "Framework key.", + "x-example": "sveltekit" }, "name": { "type": "string", - "description": "Bucket name.", - "x-example": "Documents" - }, - "enabled": { - "type": "boolean", - "description": "Bucket enabled.", - "x-example": false + "description": "Framework Name.", + "x-example": "SvelteKit" }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size supported.", - "x-example": 100, - "format": "int32" + "buildRuntime": { + "type": "string", + "description": "Default runtime version.", + "x-example": "node-22" }, - "allowedFileExtensions": { + "runtimes": { "type": "array", - "description": "Allowed file extensions.", + "description": "List of supported runtime versions.", "items": { "type": "string" }, "x-example": [ - "jpg", - "png" - ] - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" - }, - "encryption": { - "type": "boolean", - "description": "Bucket is encrypted.", - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Virus scanning is enabled.", - "x-example": false - }, - "transformations": { - "type": "boolean", - "description": "Image transformations are enabled.", - "x-example": false + "static-1", + "node-22" + ] }, - "totalSize": { - "type": "integer", - "description": "Total size of this bucket in bytes.", - "x-example": 128, - "format": "int32" + "adapters": { + "type": "array", + "description": "List of supported adapters.", + "items": { + "type": "object", + "$ref": "#\/definitions\/frameworkAdapter" + }, + "x-example": [ + { + "key": "static", + "buildRuntime": "node-22", + "buildCommand": "npm run build", + "installCommand": "npm install", + "outputDirectory": ".\/dist" + } + ] } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "$permissions", - "fileSecurity", + "key", "name", - "enabled", - "maximumFileSize", - "allowedFileExtensions", - "compression", - "encryption", - "antivirus", - "transformations", - "totalSize" + "buildRuntime", + "runtimes", + "adapters" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "fileSecurity": true, - "name": "Documents", - "enabled": false, - "maximumFileSize": 100, - "allowedFileExtensions": [ - "jpg", - "png" + "key": "sveltekit", + "name": "SvelteKit", + "buildRuntime": "node-22", + "runtimes": [ + "static-1", + "node-22" ], - "compression": "gzip", - "encryption": false, - "antivirus": false, - "transformations": false, - "totalSize": 128 + "adapters": [ + { + "key": "static", + "buildRuntime": "node-22", + "buildCommand": "npm run build", + "installCommand": "npm install", + "outputDirectory": ".\/dist" + } + ] } }, - "resourceToken": { - "description": "ResourceToken", + "frameworkAdapter": { + "description": "Framework Adapter", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "resourceId": { + "key": { "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" + "description": "Adapter key.", + "x-example": "static" }, - "resourceType": { + "installCommand": { "type": "string", - "description": "Resource type.", - "x-example": "files" + "description": "Default command to download dependencies.", + "x-example": "npm install" }, - "expire": { + "buildCommand": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Default command to build site into output directory.", + "x-example": "npm run build" }, - "secret": { + "outputDirectory": { "type": "string", - "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "description": "Default output directory of build.", + "x-example": ".\/dist" }, - "accessedAt": { + "fallbackFile": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", + "x-example": "index.html" } }, "required": [ - "$id", - "$createdAt", - "resourceId", - "resourceType", - "expire", - "secret", - "accessedAt" + "key", + "installCommand", + "buildCommand", + "outputDirectory", + "fallbackFile" ], "example": { - "$id": "bb8ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8", - "resourceType": "files", - "expire": "2020-10-15T06:38:00.000+00:00", - "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", - "accessedAt": "2020-10-15T06:38:00.000+00:00" + "key": "static", + "installCommand": "npm install", + "buildCommand": "npm run build", + "outputDirectory": ".\/dist", + "fallbackFile": "index.html" } }, - "team": { - "description": "Team", + "deployment": { + "description": "Deployment", "type": "object", "properties": { "$id": { "type": "string", - "description": "Team ID.", + "description": "Deployment ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Team creation date in ISO 8601 format.", + "description": "Deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Team update date in ISO 8601 format.", + "description": "Deployment update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "type": { "type": "string", - "description": "Team name.", - "x-example": "VIP" + "description": "Type of deployment.", + "x-example": "vcs" }, - "total": { + "resourceId": { + "type": "string", + "description": "Resource ID.", + "x-example": "5e5ea6g16897e" + }, + "resourceType": { + "type": "string", + "description": "Resource type.", + "x-example": "functions" + }, + "entrypoint": { + "type": "string", + "description": "The entrypoint file to use to execute the deployment code.", + "x-example": "index.js" + }, + "sourceSize": { "type": "integer", - "description": "Total number of team members.", - "x-example": 7, + "description": "The code size in bytes.", + "x-example": 128, "format": "int32" }, - "prefs": { - "type": "object", - "description": "Team preferences as a key-value object", - "x-example": { - "theme": "pink", - "timezone": "UTC" - }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "name", - "total", - "prefs" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "VIP", - "total": 7, - "prefs": { - "theme": "pink", - "timezone": "UTC" - } - } - }, - "membership": { - "description": "Membership", - "type": "object", - "properties": { - "$id": { + "buildSize": { + "type": "integer", + "description": "The build output size in bytes.", + "x-example": 128, + "format": "int32" + }, + "totalSize": { + "type": "integer", + "description": "The total size in bytes (source and build output).", + "x-example": 128, + "format": "int32" + }, + "buildId": { "type": "string", - "description": "Membership ID.", + "description": "The current build ID.", "x-example": "5e5ea5c16897e" }, - "$createdAt": { - "type": "string", - "description": "Membership creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "activate": { + "type": "boolean", + "description": "Whether the deployment should be automatically activated.", + "x-example": true }, - "$updatedAt": { + "screenshotLight": { "type": "string", - "description": "Membership update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Screenshot with light theme preference file ID.", + "x-example": "5e5ea5c16897e" }, - "userId": { + "screenshotDark": { "type": "string", - "description": "User ID.", + "description": "Screenshot with dark theme preference file ID.", "x-example": "5e5ea5c16897e" }, - "userName": { + "status": { "type": "string", - "description": "User name. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "John Doe" + "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", + "x-example": "ready", + "enum": [ + "waiting", + "processing", + "building", + "ready", + "canceled", + "failed" + ] }, - "userEmail": { + "buildLogs": { "type": "string", - "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "john@appwrite.io" + "description": "The build logs.", + "x-example": "Compiling source files..." }, - "userPhone": { + "buildDuration": { + "type": "integer", + "description": "The current build time in seconds.", + "x-example": 128, + "format": "int32" + }, + "providerRepositoryName": { "type": "string", - "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "+1 555 555 5555" + "description": "The name of the vcs provider repository", + "x-example": "database" }, - "teamId": { + "providerRepositoryOwner": { "type": "string", - "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "description": "The name of the vcs provider repository owner", + "x-example": "utopia" }, - "teamName": { + "providerRepositoryUrl": { "type": "string", - "description": "Team name.", - "x-example": "VIP" + "description": "The url of the vcs provider repository", + "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" }, - "invited": { + "providerCommitHash": { "type": "string", - "description": "Date, the user has been invited to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "The commit hash of the vcs commit", + "x-example": "7c3f25d" }, - "joined": { + "providerCommitAuthorUrl": { "type": "string", - "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "The url of vcs commit author", + "x-example": "https:\/\/github.com\/vermakhushboo" }, - "confirm": { - "type": "boolean", - "description": "User confirmation status, true if the user has joined the team or false otherwise.", - "x-example": false + "providerCommitAuthor": { + "type": "string", + "description": "The name of vcs commit author", + "x-example": "Khushboo Verma" }, - "mfa": { - "type": "boolean", - "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", - "x-example": false + "providerCommitMessage": { + "type": "string", + "description": "The commit message", + "x-example": "Update index.js" }, - "roles": { - "type": "array", - "description": "User list of roles", - "items": { - "type": "string" - }, - "x-example": [ - "owner" - ] + "providerCommitUrl": { + "type": "string", + "description": "The url of the vcs commit", + "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + }, + "providerBranch": { + "type": "string", + "description": "The branch of the vcs repository", + "x-example": "0.7.x" + }, + "providerBranchUrl": { + "type": "string", + "description": "The branch of the vcs repository", + "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "userId", - "userName", - "userEmail", - "userPhone", - "teamId", - "teamName", - "invited", - "joined", - "confirm", - "mfa", - "roles" + "type", + "resourceId", + "resourceType", + "entrypoint", + "sourceSize", + "buildSize", + "totalSize", + "buildId", + "activate", + "screenshotLight", + "screenshotDark", + "status", + "buildLogs", + "buildDuration", + "providerRepositoryName", + "providerRepositoryOwner", + "providerRepositoryUrl", + "providerCommitHash", + "providerCommitAuthorUrl", + "providerCommitAuthor", + "providerCommitMessage", + "providerCommitUrl", + "providerBranch", + "providerBranchUrl" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c16897e", - "userName": "John Doe", - "userEmail": "john@appwrite.io", - "userPhone": "+1 555 555 5555", - "teamId": "5e5ea5c16897e", - "teamName": "VIP", - "invited": "2020-10-15T06:38:00.000+00:00", - "joined": "2020-10-15T06:38:00.000+00:00", - "confirm": false, - "mfa": false, - "roles": [ - "owner" - ] + "type": "vcs", + "resourceId": "5e5ea6g16897e", + "resourceType": "functions", + "entrypoint": "index.js", + "sourceSize": 128, + "buildSize": 128, + "totalSize": 128, + "buildId": "5e5ea5c16897e", + "activate": true, + "screenshotLight": "5e5ea5c16897e", + "screenshotDark": "5e5ea5c16897e", + "status": "ready", + "buildLogs": "Compiling source files...", + "buildDuration": 128, + "providerRepositoryName": "database", + "providerRepositoryOwner": "utopia", + "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function", + "providerCommitHash": "7c3f25d", + "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo", + "providerCommitAuthor": "Khushboo Verma", + "providerCommitMessage": "Update index.js", + "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", + "providerBranch": "0.7.x", + "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, - "site": { - "description": "Site", + "execution": { + "description": "Execution", "type": "object", "properties": { "$id": { "type": "string", - "description": "Site ID.", + "description": "Execution ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Site creation date in ISO 8601 format.", + "description": "Execution creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Site update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "name": { - "type": "string", - "description": "Site name.", - "x-example": "My Site" - }, - "enabled": { - "type": "boolean", - "description": "Site enabled.", - "x-example": false - }, - "live": { - "type": "boolean", - "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false - }, - "framework": { - "type": "string", - "description": "Site framework.", - "x-example": "react" - }, - "deploymentRetention": { - "type": "integer", - "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" - }, - "deploymentId": { - "type": "string", - "description": "Site's active deployment ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentCreatedAt": { - "type": "string", - "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "deploymentScreenshotLight": { - "type": "string", - "description": "Screenshot of active deployment with light theme preference file ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentScreenshotDark": { - "type": "string", - "description": "Screenshot of active deployment with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" - }, - "latestDeploymentId": { - "type": "string", - "description": "Site's latest deployment ID.", - "x-example": "5e5ea5c16897e" - }, - "latestDeploymentCreatedAt": { - "type": "string", - "description": "Latest deployment creation date in ISO 8601 format.", + "description": "Execution update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "latestDeploymentStatus": { - "type": "string", - "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" - }, - "vars": { - "type": "array", - "description": "Site variables.", - "items": { - "type": "object", - "$ref": "#\/definitions\/variable" - }, - "x-example": [] - }, - "timeout": { - "type": "integer", - "description": "Site request timeout in seconds.", - "x-example": 300, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "The install command used to install the site dependencies.", - "x-example": "npm install" - }, - "buildCommand": { - "type": "string", - "description": "The build command used to build the site.", - "x-example": "npm run build" + "$permissions": { + "type": "array", + "description": "Execution roles.", + "items": { + "type": "string" + }, + "x-example": [ + "any" + ] }, - "startCommand": { + "functionId": { "type": "string", - "description": "Custom command to use when starting site runtime.", - "x-example": "node custom-server.mjs" + "description": "Function ID.", + "x-example": "5e5ea6g16897e" }, - "outputDirectory": { + "deploymentId": { "type": "string", - "description": "The directory where the site build output is located.", - "x-example": "build" + "description": "Function's deployment ID used to create the execution.", + "x-example": "5e5ea5c16897e" }, - "installationId": { + "trigger": { "type": "string", - "description": "Site VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.", + "x-example": "http", + "enum": [ + "http", + "schedule", + "event" + ] }, - "providerRepositoryId": { + "status": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", + "x-example": "processing", + "enum": [ + "waiting", + "processing", + "completed", + "failed", + "scheduled" + ] }, - "providerBranch": { + "requestMethod": { "type": "string", - "description": "VCS (Version Control System) branch name", - "x-example": "main" + "description": "HTTP request method type.", + "x-example": "GET" }, - "providerRootDirectory": { + "requestPath": { "type": "string", - "description": "Path to site in VCS (Version Control System) repository", - "x-example": "sites\/helloWorld" + "description": "HTTP request path and query.", + "x-example": "\/articles?id=5" }, - "providerSilentMode": { - "type": "boolean", - "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "requestHeaders": { + "type": "array", + "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", + "items": { + "type": "object", + "$ref": "#\/definitions\/headers" + }, + "x-example": [ + { + "Content-Type": "application\/json" + } + ] }, - "buildSpecification": { - "type": "string", - "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "responseStatusCode": { + "type": "integer", + "description": "HTTP response status code.", + "x-example": 200, + "format": "int32" }, - "runtimeSpecification": { + "responseBody": { "type": "string", - "description": "Machine specification for SSR executions.", - "x-example": "s-1vcpu-512mb" + "description": "HTTP response body. This will return empty unless execution is created as synchronous.", + "x-example": "" }, - "buildRuntime": { + "responseHeaders": { + "type": "array", + "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", + "items": { + "type": "object", + "$ref": "#\/definitions\/headers" + }, + "x-example": [ + { + "Content-Type": "application\/json" + } + ] + }, + "logs": { "type": "string", - "description": "Site build runtime.", - "x-example": "node-22" + "description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" }, - "adapter": { + "errors": { "type": "string", - "description": "Site framework adapter.", - "x-example": "static" + "description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" }, - "fallbackFile": { + "duration": { + "type": "number", + "description": "Resource(function\/site) execution duration in seconds.", + "x-example": 0.4, + "format": "double" + }, + "scheduledAt": { "type": "string", - "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true } }, "required": [ "$id", "$createdAt", "$updatedAt", - "name", - "enabled", - "live", - "logging", - "framework", - "deploymentRetention", + "$permissions", + "functionId", "deploymentId", - "deploymentCreatedAt", - "deploymentScreenshotLight", - "deploymentScreenshotDark", - "latestDeploymentId", - "latestDeploymentCreatedAt", - "latestDeploymentStatus", - "vars", - "timeout", - "installCommand", - "buildCommand", - "startCommand", - "outputDirectory", - "installationId", - "providerRepositoryId", - "providerBranch", - "providerRootDirectory", - "providerSilentMode", - "buildSpecification", - "runtimeSpecification", - "buildRuntime", - "adapter", - "fallbackFile" + "trigger", + "status", + "requestMethod", + "requestPath", + "requestHeaders", + "responseStatusCode", + "responseBody", + "responseHeaders", + "logs", + "errors", + "duration" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My Site", - "enabled": false, - "live": false, - "logging": false, - "framework": "react", - "deploymentRetention": 7, + "$permissions": [ + "any" + ], + "functionId": "5e5ea6g16897e", "deploymentId": "5e5ea5c16897e", - "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "deploymentScreenshotLight": "5e5ea5c16897e", - "deploymentScreenshotDark": "5e5ea5c16897e", - "latestDeploymentId": "5e5ea5c16897e", - "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentStatus": "ready", - "vars": [], - "timeout": 300, - "installCommand": "npm install", - "buildCommand": "npm run build", - "startCommand": "node custom-server.mjs", - "outputDirectory": "build", - "installationId": "6m40at4ejk5h2u9s1hboo", - "providerRepositoryId": "appwrite", - "providerBranch": "main", - "providerRootDirectory": "sites\/helloWorld", - "providerSilentMode": false, - "buildSpecification": "s-1vcpu-512mb", - "runtimeSpecification": "s-1vcpu-512mb", - "buildRuntime": "node-22", - "adapter": "static", - "fallbackFile": "index.html" + "trigger": "http", + "status": "processing", + "requestMethod": "GET", + "requestPath": "\/articles?id=5", + "requestHeaders": [ + { + "Content-Type": "application\/json" + } + ], + "responseStatusCode": 200, + "responseBody": "", + "responseHeaders": [ + { + "Content-Type": "application\/json" + } + ], + "logs": "", + "errors": "", + "duration": 0.4, + "scheduledAt": "2020-10-15T06:38:00.000+00:00" } }, - "templateSite": { - "description": "Template Site", + "project": { + "description": "Project", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Site Template ID.", - "x-example": "starter" - }, - "name": { - "type": "string", - "description": "Site Template Name.", - "x-example": "Starter site" - }, - "tagline": { - "type": "string", - "description": "Short description of template", - "x-example": "Minimal web app integrating with Appwrite." - }, - "demoUrl": { + "$id": { "type": "string", - "description": "URL hosting a template demo.", - "x-example": "https:\/\/nextjs-starter.appwrite.network\/" + "description": "Project ID.", + "x-example": "5e5ea5c16897e" }, - "screenshotDark": { + "$createdAt": { "type": "string", - "description": "File URL with preview screenshot in dark theme preference.", - "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png" + "description": "Project creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "screenshotLight": { + "$updatedAt": { "type": "string", - "description": "File URL with preview screenshot in light theme preference.", - "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png" - }, - "useCases": { - "type": "array", - "description": "Site use cases.", - "items": { - "type": "string" - }, - "x-example": "Starter" - }, - "frameworks": { - "type": "array", - "description": "List of frameworks that can be used with this template.", - "items": { - "type": "object", - "$ref": "#\/definitions\/templateFramework" - }, - "x-example": [] + "description": "Project update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "vcsProvider": { + "name": { "type": "string", - "description": "VCS (Version Control System) Provider.", - "x-example": "github" + "description": "Project name.", + "x-example": "New Project" }, - "providerRepositoryId": { + "description": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "templates" + "description": "Project description.", + "x-example": "This is a new project." }, - "providerOwner": { + "teamId": { "type": "string", - "description": "VCS (Version Control System) Owner.", - "x-example": "appwrite" + "description": "Project team ID.", + "x-example": "1592981250" }, - "providerVersion": { + "logo": { "type": "string", - "description": "VCS (Version Control System) branch version (tag).", - "x-example": "main" + "description": "Project logo file ID.", + "x-example": "5f5c451b403cb" }, - "variables": { - "type": "array", - "description": "Site variables.", - "items": { - "type": "object", - "$ref": "#\/definitions\/templateVariable" - }, - "x-example": [] - } - }, - "required": [ - "key", - "name", - "tagline", - "demoUrl", - "screenshotDark", - "screenshotLight", - "useCases", - "frameworks", - "vcsProvider", - "providerRepositoryId", - "providerOwner", - "providerVersion", - "variables" - ], - "example": { - "key": "starter", - "name": "Starter site", - "tagline": "Minimal web app integrating with Appwrite.", - "demoUrl": "https:\/\/nextjs-starter.appwrite.network\/", - "screenshotDark": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png", - "screenshotLight": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png", - "useCases": "Starter", - "frameworks": [], - "vcsProvider": "github", - "providerRepositoryId": "templates", - "providerOwner": "appwrite", - "providerVersion": "main", - "variables": [] - } - }, - "templateFramework": { - "description": "Template Framework", - "type": "object", - "properties": { - "key": { + "url": { "type": "string", - "description": "Parent framework key.", - "x-example": "sveltekit" + "description": "Project website URL.", + "x-example": "5f5c451b403cb" }, - "name": { + "legalName": { "type": "string", - "description": "Framework Name.", - "x-example": "SvelteKit" + "description": "Company legal name.", + "x-example": "Company LTD." }, - "installCommand": { + "legalCountry": { "type": "string", - "description": "The install command used to install the dependencies.", - "x-example": "npm install" + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", + "x-example": "US" }, - "buildCommand": { + "legalState": { "type": "string", - "description": "The build command used to build the deployment.", - "x-example": "npm run build" + "description": "State name.", + "x-example": "New York" }, - "outputDirectory": { + "legalCity": { "type": "string", - "description": "The output directory to store the build output.", - "x-example": ".\/build" + "description": "City name.", + "x-example": "New York City." }, - "providerRootDirectory": { + "legalAddress": { "type": "string", - "description": "Path to site in VCS (Version Control System) repository", - "x-example": ".\/svelte-kit\/starter" + "description": "Company Address.", + "x-example": "620 Eighth Avenue, New York, NY 10018" }, - "buildRuntime": { + "legalTaxId": { "type": "string", - "description": "Runtime used during build step of template.", - "x-example": "node-22" + "description": "Company Tax ID.", + "x-example": "131102020" }, - "adapter": { - "type": "string", - "description": "Site framework runtime", - "x-example": "ssr" + "authDuration": { + "type": "integer", + "description": "Session duration in seconds.", + "x-example": 60, + "format": "int32" }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for SPA. Only relevant for static serve runtime.", - "x-example": "index.html" - } - }, - "required": [ - "key", - "name", - "installCommand", - "buildCommand", - "outputDirectory", - "providerRootDirectory", - "buildRuntime", - "adapter", - "fallbackFile" - ], - "example": { - "key": "sveltekit", - "name": "SvelteKit", - "installCommand": "npm install", - "buildCommand": "npm run build", - "outputDirectory": ".\/build", - "providerRootDirectory": ".\/svelte-kit\/starter", - "buildRuntime": "node-22", - "adapter": "ssr", - "fallbackFile": "index.html" - } - }, - "function": { - "description": "Function", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Function ID.", - "x-example": "5e5ea5c16897e" + "authLimit": { + "type": "integer", + "description": "Max users allowed. 0 is unlimited.", + "x-example": 100, + "format": "int32" }, - "$createdAt": { - "type": "string", - "description": "Function creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authSessionsLimit": { + "type": "integer", + "description": "Max sessions allowed per user. 100 maximum.", + "x-example": 10, + "format": "int32" }, - "$updatedAt": { - "type": "string", - "description": "Function update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authPasswordHistory": { + "type": "integer", + "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", + "x-example": 5, + "format": "int32" }, - "execute": { - "type": "array", - "description": "Execution permissions.", - "items": { - "type": "string" - }, - "x-example": "users" + "authPasswordDictionary": { + "type": "boolean", + "description": "Whether or not to check user's password against most commonly used passwords.", + "x-example": true }, - "name": { - "type": "string", - "description": "Function name.", - "x-example": "My Function" + "authPersonalDataCheck": { + "type": "boolean", + "description": "Whether or not to check the user password for similarity with their personal data.", + "x-example": true }, - "enabled": { + "authDisposableEmails": { "type": "boolean", - "description": "Function enabled.", - "x-example": false + "description": "Whether or not to disallow disposable email addresses during signup and email updates.", + "x-example": true }, - "live": { + "authCanonicalEmails": { "type": "boolean", - "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", - "x-example": false + "description": "Whether or not to require canonical email addresses during signup and email updates.", + "x-example": true }, - "logging": { + "authFreeEmails": { "type": "boolean", - "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", - "x-example": false + "description": "Whether or not to disallow free email addresses during signup and email updates.", + "x-example": true }, - "runtime": { - "type": "string", - "description": "Function execution and build runtime.", - "x-example": "python-3.8" + "authMockNumbers": { + "type": "array", + "description": "An array of mock numbers and their corresponding verification codes (OTPs).", + "items": { + "type": "object", + "$ref": "#\/definitions\/mockNumber" + }, + "x-example": [ + {} + ] + }, + "authSessionAlerts": { + "type": "boolean", + "description": "Whether or not to send session alert emails to users.", + "x-example": true }, - "deploymentRetention": { - "type": "integer", - "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" + "authMembershipsUserName": { + "type": "boolean", + "description": "Whether or not to show user names in the teams membership response.", + "x-example": true }, - "deploymentId": { - "type": "string", - "description": "Function's active deployment ID.", - "x-example": "5e5ea5c16897e" + "authMembershipsUserEmail": { + "type": "boolean", + "description": "Whether or not to show user emails in the teams membership response.", + "x-example": true }, - "deploymentCreatedAt": { - "type": "string", - "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authMembershipsMfa": { + "type": "boolean", + "description": "Whether or not to show user MFA status in the teams membership response.", + "x-example": true }, - "latestDeploymentId": { - "type": "string", - "description": "Function's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "authMembershipsUserId": { + "type": "boolean", + "description": "Whether or not to show user IDs in the teams membership response.", + "x-example": true }, - "latestDeploymentCreatedAt": { - "type": "string", - "description": "Latest deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authMembershipsUserPhone": { + "type": "boolean", + "description": "Whether or not to show user phone numbers in the teams membership response.", + "x-example": true }, - "latestDeploymentStatus": { - "type": "string", - "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" + "authInvalidateSessions": { + "type": "boolean", + "description": "Whether or not all existing sessions should be invalidated on password change", + "x-example": true }, - "scopes": { + "oAuthProviders": { "type": "array", - "description": "Allowed permission scopes.", + "description": "List of Auth Providers.", "items": { - "type": "string" + "type": "object", + "$ref": "#\/definitions\/authProvider" }, - "x-example": "users.read" + "x-example": [ + {} + ] }, - "vars": { + "platforms": { "type": "array", - "description": "Function variables.", + "description": "List of Platforms.", "items": { - "type": "object", - "$ref": "#\/definitions\/variable" + "x-anyOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "web": "#\/definitions\/platformWeb", + "apple": "#\/definitions\/platformApple", + "android": "#\/definitions\/platformAndroid", + "windows": "#\/definitions\/platformWindows", + "linux": "#\/definitions\/platformLinux" + } + } }, - "x-example": [] + "x-example": {} }, - "events": { + "webhooks": { "type": "array", - "description": "Function trigger events.", + "description": "List of Webhooks.", "items": { - "type": "string" + "type": "object", + "$ref": "#\/definitions\/webhook" }, - "x-example": "account.create" - }, - "schedule": { - "type": "string", - "description": "Function execution schedule in CRON format.", - "x-example": "5 4 * * *" + "x-example": {} }, - "timeout": { - "type": "integer", - "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" + "keys": { + "type": "array", + "description": "List of API Keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/key" + }, + "x-example": {} }, - "entrypoint": { - "type": "string", - "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "devKeys": { + "type": "array", + "description": "List of dev keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/devKey" + }, + "x-example": {} }, - "commands": { - "type": "string", - "description": "The build command used to build the deployment.", - "x-example": "npm install" + "smtpEnabled": { + "type": "boolean", + "description": "Status for custom SMTP", + "x-example": false }, - "version": { + "smtpSenderName": { "type": "string", - "description": "Version of Open Runtimes used for the function.", - "x-example": "v2" + "description": "SMTP sender name", + "x-example": "John Appwrite" }, - "installationId": { + "smtpSenderEmail": { "type": "string", - "description": "Function VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "description": "SMTP sender email", + "x-example": "john@appwrite.io" }, - "providerRepositoryId": { + "smtpReplyToName": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "description": "SMTP reply to name", + "x-example": "Support Team" }, - "providerBranch": { + "smtpReplyToEmail": { "type": "string", - "description": "VCS (Version Control System) branch name", - "x-example": "main" + "description": "SMTP reply to email", + "x-example": "support@appwrite.io" }, - "providerRootDirectory": { + "smtpHost": { "type": "string", - "description": "Path to function in VCS (Version Control System) repository", - "x-example": "functions\/helloWorld" + "description": "SMTP server host name", + "x-example": "mail.appwrite.io" }, - "providerSilentMode": { - "type": "boolean", - "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "smtpPort": { + "type": "integer", + "description": "SMTP server port", + "x-example": 25, + "format": "int32" }, - "buildSpecification": { + "smtpUsername": { "type": "string", - "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "description": "SMTP server username", + "x-example": "emailuser" }, - "runtimeSpecification": { - "type": "string", - "description": "Machine specification for executions.", - "x-example": "s-1vcpu-512mb" - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "execute", - "name", - "enabled", - "live", - "logging", - "runtime", - "deploymentRetention", - "deploymentId", - "deploymentCreatedAt", - "latestDeploymentId", - "latestDeploymentCreatedAt", - "latestDeploymentStatus", - "scopes", - "vars", - "events", - "schedule", - "timeout", - "entrypoint", - "commands", - "version", - "installationId", - "providerRepositoryId", - "providerBranch", - "providerRootDirectory", - "providerSilentMode", - "buildSpecification", - "runtimeSpecification" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "execute": "users", - "name": "My Function", - "enabled": false, - "live": false, - "logging": false, - "runtime": "python-3.8", - "deploymentRetention": 7, - "deploymentId": "5e5ea5c16897e", - "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentId": "5e5ea5c16897e", - "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentStatus": "ready", - "scopes": "users.read", - "vars": [], - "events": "account.create", - "schedule": "5 4 * * *", - "timeout": 300, - "entrypoint": "index.js", - "commands": "npm install", - "version": "v2", - "installationId": "6m40at4ejk5h2u9s1hboo", - "providerRepositoryId": "appwrite", - "providerBranch": "main", - "providerRootDirectory": "functions\/helloWorld", - "providerSilentMode": false, - "buildSpecification": "s-1vcpu-512mb", - "runtimeSpecification": "s-1vcpu-512mb" - } - }, - "templateFunction": { - "description": "Template Function", - "type": "object", - "properties": { - "icon": { + "smtpPassword": { "type": "string", - "description": "Function Template Icon.", - "x-example": "icon-lightning-bolt" + "description": "SMTP server password. This property is write-only and always returned empty.", + "x-example": "" }, - "id": { + "smtpSecure": { "type": "string", - "description": "Function Template ID.", - "x-example": "starter" + "description": "SMTP server secure protocol", + "x-example": "tls" }, - "name": { - "type": "string", - "description": "Function Template Name.", - "x-example": "Starter function" + "pingCount": { + "type": "integer", + "description": "Number of times the ping was received for this project.", + "x-example": 1, + "format": "int32" }, - "tagline": { + "pingedAt": { "type": "string", - "description": "Function Template Tagline.", - "x-example": "A simple function to get started." - }, - "permissions": { - "type": "array", - "description": "Execution permissions.", - "items": { - "type": "string" - }, - "x-example": "any" + "description": "Last ping datetime in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "events": { + "labels": { "type": "array", - "description": "Function trigger events.", + "description": "Labels for the project.", "items": { "type": "string" }, - "x-example": "account.create" + "x-example": [ + "vip" + ] }, - "cron": { + "status": { "type": "string", - "description": "Function execution schedult in CRON format.", - "x-example": "0 0 * * *" + "description": "Project status", + "x-example": "active" }, - "timeout": { - "type": "integer", - "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" + "authEmailPassword": { + "type": "boolean", + "description": "Email\/Password auth method status", + "x-example": true }, - "useCases": { - "type": "array", - "description": "Function use cases.", - "items": { - "type": "string" - }, - "x-example": "Starter" + "authUsersAuthMagicURL": { + "type": "boolean", + "description": "Magic URL auth method status", + "x-example": true }, - "runtimes": { - "type": "array", - "description": "List of runtimes that can be used with this template.", - "items": { - "type": "object", - "$ref": "#\/definitions\/templateRuntime" - }, - "x-example": [] + "authEmailOtp": { + "type": "boolean", + "description": "Email (OTP) auth method status", + "x-example": true }, - "instructions": { - "type": "string", - "description": "Function Template Instructions.", - "x-example": "For documentation and instructions check out ." + "authAnonymous": { + "type": "boolean", + "description": "Anonymous auth method status", + "x-example": true }, - "vcsProvider": { - "type": "string", - "description": "VCS (Version Control System) Provider.", - "x-example": "github" + "authInvites": { + "type": "boolean", + "description": "Invites auth method status", + "x-example": true }, - "providerRepositoryId": { - "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "templates" + "authJWT": { + "type": "boolean", + "description": "JWT auth method status", + "x-example": true }, - "providerOwner": { - "type": "string", - "description": "VCS (Version Control System) Owner.", - "x-example": "appwrite" + "authPhone": { + "type": "boolean", + "description": "Phone auth method status", + "x-example": true }, - "providerVersion": { - "type": "string", - "description": "VCS (Version Control System) branch version (tag).", - "x-example": "main" + "serviceStatusForAccount": { + "type": "boolean", + "description": "Account service status", + "x-example": true }, - "variables": { - "type": "array", - "description": "Function variables.", - "items": { - "type": "object", - "$ref": "#\/definitions\/templateVariable" - }, - "x-example": [] + "serviceStatusForAvatars": { + "type": "boolean", + "description": "Avatars service status", + "x-example": true }, - "scopes": { - "type": "array", - "description": "Function scopes.", - "items": { - "type": "string" - }, - "x-example": "users.read" - } - }, - "required": [ - "icon", - "id", - "name", - "tagline", - "permissions", - "events", - "cron", - "timeout", - "useCases", - "runtimes", - "instructions", - "vcsProvider", - "providerRepositoryId", - "providerOwner", - "providerVersion", - "variables", - "scopes" - ], - "example": { - "icon": "icon-lightning-bolt", - "id": "starter", - "name": "Starter function", - "tagline": "A simple function to get started.", - "permissions": "any", - "events": "account.create", - "cron": "0 0 * * *", - "timeout": 300, - "useCases": "Starter", - "runtimes": [], - "instructions": "For documentation and instructions check out .", - "vcsProvider": "github", - "providerRepositoryId": "templates", - "providerOwner": "appwrite", - "providerVersion": "main", - "variables": [], - "scopes": "users.read" - } - }, - "templateRuntime": { - "description": "Template Runtime", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Runtime Name.", - "x-example": "node-19.0" + "serviceStatusForDatabases": { + "type": "boolean", + "description": "Databases (legacy) service status", + "x-example": true }, - "commands": { - "type": "string", - "description": "The build command used to build the deployment.", - "x-example": "npm install" + "serviceStatusForTablesdb": { + "type": "boolean", + "description": "TablesDB service status", + "x-example": true + }, + "serviceStatusForLocale": { + "type": "boolean", + "description": "Locale service status", + "x-example": true + }, + "serviceStatusForHealth": { + "type": "boolean", + "description": "Health service status", + "x-example": true + }, + "serviceStatusForProject": { + "type": "boolean", + "description": "Project service status", + "x-example": true + }, + "serviceStatusForStorage": { + "type": "boolean", + "description": "Storage service status", + "x-example": true + }, + "serviceStatusForTeams": { + "type": "boolean", + "description": "Teams service status", + "x-example": true + }, + "serviceStatusForUsers": { + "type": "boolean", + "description": "Users service status", + "x-example": true + }, + "serviceStatusForVcs": { + "type": "boolean", + "description": "VCS service status", + "x-example": true + }, + "serviceStatusForSites": { + "type": "boolean", + "description": "Sites service status", + "x-example": true + }, + "serviceStatusForFunctions": { + "type": "boolean", + "description": "Functions service status", + "x-example": true + }, + "serviceStatusForProxy": { + "type": "boolean", + "description": "Proxy service status", + "x-example": true }, - "entrypoint": { - "type": "string", - "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "serviceStatusForGraphql": { + "type": "boolean", + "description": "GraphQL service status", + "x-example": true }, - "providerRootDirectory": { - "type": "string", - "description": "Path to function in VCS (Version Control System) repository", - "x-example": "node\/starter" - } - }, - "required": [ - "name", - "commands", - "entrypoint", - "providerRootDirectory" - ], - "example": { - "name": "node-19.0", - "commands": "npm install", - "entrypoint": "index.js", - "providerRootDirectory": "node\/starter" - } - }, - "templateVariable": { - "description": "Template Variable", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Variable Name.", - "x-example": "APPWRITE_DATABASE_ID" + "serviceStatusForMigrations": { + "type": "boolean", + "description": "Migrations service status", + "x-example": true }, - "description": { - "type": "string", - "description": "Variable Description.", - "x-example": "The ID of the Appwrite database that contains the collection to sync." + "serviceStatusForMessaging": { + "type": "boolean", + "description": "Messaging service status", + "x-example": true }, - "value": { - "type": "string", - "description": "Variable Value.", - "x-example": "512" + "protocolStatusForRest": { + "type": "boolean", + "description": "REST protocol status", + "x-example": true }, - "secret": { + "protocolStatusForGraphql": { "type": "boolean", - "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", - "x-example": false + "description": "GraphQL protocol status", + "x-example": true }, - "placeholder": { + "protocolStatusForWebsocket": { + "type": "boolean", + "description": "Websocket protocol status", + "x-example": true + }, + "region": { "type": "string", - "description": "Variable Placeholder.", - "x-example": "64a55...7b912" + "description": "Project region", + "x-example": "fra" }, - "required": { - "type": "boolean", - "description": "Is the variable required?", - "x-example": false + "billingLimits": { + "type": "object", + "description": "Billing limits reached", + "x-example": "", + "items": { + "type": "object", + "$ref": "#\/definitions\/billingLimits" + } }, - "type": { + "blocks": { + "type": "array", + "description": "Project blocks information", + "items": { + "type": "object", + "$ref": "#\/definitions\/block" + }, + "x-example": "" + }, + "consoleAccessedAt": { "type": "string", - "description": "Variable Type.", - "x-example": "password" + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ + "$id", + "$createdAt", + "$updatedAt", "name", "description", - "value", - "secret", - "placeholder", - "required", - "type" + "teamId", + "logo", + "url", + "legalName", + "legalCountry", + "legalState", + "legalCity", + "legalAddress", + "legalTaxId", + "authDuration", + "authLimit", + "authSessionsLimit", + "authPasswordHistory", + "authPasswordDictionary", + "authPersonalDataCheck", + "authDisposableEmails", + "authCanonicalEmails", + "authFreeEmails", + "authMockNumbers", + "authSessionAlerts", + "authMembershipsUserName", + "authMembershipsUserEmail", + "authMembershipsMfa", + "authMembershipsUserId", + "authMembershipsUserPhone", + "authInvalidateSessions", + "oAuthProviders", + "platforms", + "webhooks", + "keys", + "devKeys", + "smtpEnabled", + "smtpSenderName", + "smtpSenderEmail", + "smtpReplyToName", + "smtpReplyToEmail", + "smtpHost", + "smtpPort", + "smtpUsername", + "smtpPassword", + "smtpSecure", + "pingCount", + "pingedAt", + "labels", + "status", + "authEmailPassword", + "authUsersAuthMagicURL", + "authEmailOtp", + "authAnonymous", + "authInvites", + "authJWT", + "authPhone", + "serviceStatusForAccount", + "serviceStatusForAvatars", + "serviceStatusForDatabases", + "serviceStatusForTablesdb", + "serviceStatusForLocale", + "serviceStatusForHealth", + "serviceStatusForProject", + "serviceStatusForStorage", + "serviceStatusForTeams", + "serviceStatusForUsers", + "serviceStatusForVcs", + "serviceStatusForSites", + "serviceStatusForFunctions", + "serviceStatusForProxy", + "serviceStatusForGraphql", + "serviceStatusForMigrations", + "serviceStatusForMessaging", + "protocolStatusForRest", + "protocolStatusForGraphql", + "protocolStatusForWebsocket", + "region", + "billingLimits", + "blocks", + "consoleAccessedAt" ], "example": { - "name": "APPWRITE_DATABASE_ID", - "description": "The ID of the Appwrite database that contains the collection to sync.", - "value": "512", - "secret": false, - "placeholder": "64a55...7b912", - "required": false, - "type": "password" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "New Project", + "description": "This is a new project.", + "teamId": "1592981250", + "logo": "5f5c451b403cb", + "url": "5f5c451b403cb", + "legalName": "Company LTD.", + "legalCountry": "US", + "legalState": "New York", + "legalCity": "New York City.", + "legalAddress": "620 Eighth Avenue, New York, NY 10018", + "legalTaxId": "131102020", + "authDuration": 60, + "authLimit": 100, + "authSessionsLimit": 10, + "authPasswordHistory": 5, + "authPasswordDictionary": true, + "authPersonalDataCheck": true, + "authDisposableEmails": true, + "authCanonicalEmails": true, + "authFreeEmails": true, + "authMockNumbers": [ + {} + ], + "authSessionAlerts": true, + "authMembershipsUserName": true, + "authMembershipsUserEmail": true, + "authMembershipsMfa": true, + "authMembershipsUserId": true, + "authMembershipsUserPhone": true, + "authInvalidateSessions": true, + "oAuthProviders": [ + {} + ], + "platforms": {}, + "webhooks": {}, + "keys": {}, + "devKeys": {}, + "smtpEnabled": false, + "smtpSenderName": "John Appwrite", + "smtpSenderEmail": "john@appwrite.io", + "smtpReplyToName": "Support Team", + "smtpReplyToEmail": "support@appwrite.io", + "smtpHost": "mail.appwrite.io", + "smtpPort": 25, + "smtpUsername": "emailuser", + "smtpPassword": "", + "smtpSecure": "tls", + "pingCount": 1, + "pingedAt": "2020-10-15T06:38:00.000+00:00", + "labels": [ + "vip" + ], + "status": "active", + "authEmailPassword": true, + "authUsersAuthMagicURL": true, + "authEmailOtp": true, + "authAnonymous": true, + "authInvites": true, + "authJWT": true, + "authPhone": true, + "serviceStatusForAccount": true, + "serviceStatusForAvatars": true, + "serviceStatusForDatabases": true, + "serviceStatusForTablesdb": true, + "serviceStatusForLocale": true, + "serviceStatusForHealth": true, + "serviceStatusForProject": true, + "serviceStatusForStorage": true, + "serviceStatusForTeams": true, + "serviceStatusForUsers": true, + "serviceStatusForVcs": true, + "serviceStatusForSites": true, + "serviceStatusForFunctions": true, + "serviceStatusForProxy": true, + "serviceStatusForGraphql": true, + "serviceStatusForMigrations": true, + "serviceStatusForMessaging": true, + "protocolStatusForRest": true, + "protocolStatusForGraphql": true, + "protocolStatusForWebsocket": true, + "region": "fra", + "billingLimits": "", + "blocks": "", + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "installation": { - "description": "Installation", + "webhook": { + "description": "Webhook", "type": "object", "properties": { "$id": { "type": "string", - "description": "Function ID.", + "description": "Webhook ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Function creation date in ISO 8601 format.", + "description": "Webhook creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Function update date in ISO 8601 format.", + "description": "Webhook update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "provider": { - "type": "string", - "description": "VCS (Version Control System) provider name.", - "x-example": "github" - }, - "organization": { - "type": "string", - "description": "VCS (Version Control System) organization name.", - "x-example": "appwrite" - }, - "providerInstallationId": { - "type": "string", - "description": "VCS (Version Control System) installation ID.", - "x-example": "5322" - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "provider", - "organization", - "providerInstallationId" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "provider": "github", - "organization": "appwrite", - "providerInstallationId": "5322" - } - }, - "providerRepository": { - "description": "ProviderRepository", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "VCS (Version Control System) repository ID.", - "x-example": "5e5ea5c16897e" - }, "name": { "type": "string", - "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" + "description": "Webhook name.", + "x-example": "My Webhook" }, - "organization": { + "url": { "type": "string", - "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" + "description": "Webhook URL endpoint.", + "x-example": "https:\/\/example.com\/webhook" }, - "provider": { - "type": "string", - "description": "VCS (Version Control System) provider name.", - "x-example": "github" + "events": { + "type": "array", + "description": "Webhook trigger events.", + "items": { + "type": "string" + }, + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] }, - "private": { + "tls": { "type": "boolean", - "description": "Is VCS (Version Control System) repository private?", + "description": "Indicates if SSL \/ TLS certificate verification is enabled.", "x-example": true }, - "defaultBranch": { + "authUsername": { "type": "string", - "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "description": "HTTP basic authentication username.", + "x-example": "username" }, - "providerInstallationId": { + "authPassword": { "type": "string", - "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" + "description": "HTTP basic authentication password.", + "x-example": "password" }, - "authorized": { + "secret": { + "type": "string", + "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", + "x-example": "ad3d581ca230e2b7059c545e5a" + }, + "enabled": { "type": "boolean", - "description": "Is VCS (Version Control System) repository authorized for the installation?", + "description": "Indicates if this webhook is enabled.", "x-example": true }, - "pushedAt": { + "logs": { "type": "string", - "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" + "description": "Webhook error logs from the most recent failure.", + "x-example": "Failed to connect to remote server." }, - "variables": { - "type": "array", - "description": "Environment variables found in .env files", - "items": { - "type": "string" - }, - "x-example": [ - "PORT", - "NODE_ENV" - ] + "attempts": { + "type": "integer", + "description": "Number of consecutive failed webhook attempts.", + "x-example": 10, + "format": "int32" } }, "required": [ - "id", + "$id", + "$createdAt", + "$updatedAt", "name", - "organization", - "provider", - "private", - "defaultBranch", - "providerInstallationId", - "authorized", - "pushedAt", - "variables" + "url", + "events", + "tls", + "authUsername", + "authPassword", + "secret", + "enabled", + "logs", + "attempts" ], "example": { - "id": "5e5ea5c16897e", - "name": "appwrite", - "organization": "appwrite", - "provider": "github", - "private": true, - "defaultBranch": "main", - "providerInstallationId": "108104697", - "authorized": true, - "pushedAt": "datetime", - "variables": [ - "PORT", - "NODE_ENV" - ] + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Webhook", + "url": "https:\/\/example.com\/webhook", + "events": [ + "databases.tables.update", + "databases.collections.update" + ], + "tls": true, + "authUsername": "username", + "authPassword": "password", + "secret": "ad3d581ca230e2b7059c545e5a", + "enabled": true, + "logs": "Failed to connect to remote server.", + "attempts": 10 } }, - "providerRepositoryFramework": { - "description": "ProviderRepositoryFramework", + "key": { + "description": "Key", "type": "object", "properties": { - "id": { + "$id": { "type": "string", - "description": "VCS (Version Control System) repository ID.", + "description": "Key ID.", "x-example": "5e5ea5c16897e" }, - "name": { - "type": "string", - "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" - }, - "organization": { + "$createdAt": { "type": "string", - "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "provider": { + "$updatedAt": { "type": "string", - "description": "VCS (Version Control System) provider name.", - "x-example": "github" - }, - "private": { - "type": "boolean", - "description": "Is VCS (Version Control System) repository private?", - "x-example": true + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "defaultBranch": { + "name": { "type": "string", - "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "description": "Key name.", + "x-example": "My API Key" }, - "providerInstallationId": { + "expire": { "type": "string", - "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "authorized": { - "type": "boolean", - "description": "Is VCS (Version Control System) repository authorized for the installation?", - "x-example": true + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" }, - "pushedAt": { + "secret": { "type": "string", - "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + }, + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "variables": { + "sdks": { "type": "array", - "description": "Environment variables found in .env files", + "description": "List of SDK user agents that used this key.", "items": { "type": "string" }, - "x-example": [ - "PORT", - "NODE_ENV" - ] - }, - "framework": { - "type": "string", - "description": "Auto-detected framework. Empty if type is not \"framework\".", - "x-example": "nextjs" + "x-example": "appwrite:flutter" } }, "required": [ - "id", + "$id", + "$createdAt", + "$updatedAt", "name", - "organization", - "provider", - "private", - "defaultBranch", - "providerInstallationId", - "authorized", - "pushedAt", - "variables", - "framework" + "expire", + "scopes", + "secret", + "accessedAt", + "sdks" ], "example": { - "id": "5e5ea5c16897e", - "name": "appwrite", - "organization": "appwrite", - "provider": "github", - "private": true, - "defaultBranch": "main", - "providerInstallationId": "108104697", - "authorized": true, - "pushedAt": "datetime", - "variables": [ - "PORT", - "NODE_ENV" - ], - "framework": "nextjs" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "scopes": "users.read", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" } }, - "providerRepositoryRuntime": { - "description": "ProviderRepositoryRuntime", + "ephemeralKey": { + "description": "Ephemeral Key", "type": "object", "properties": { - "id": { + "$id": { "type": "string", - "description": "VCS (Version Control System) repository ID.", + "description": "Key ID.", "x-example": "5e5ea5c16897e" }, - "name": { + "$createdAt": { "type": "string", - "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "organization": { + "$updatedAt": { "type": "string", - "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "provider": { + "name": { "type": "string", - "description": "VCS (Version Control System) provider name.", - "x-example": "github" - }, - "private": { - "type": "boolean", - "description": "Is VCS (Version Control System) repository private?", - "x-example": true + "description": "Key name.", + "x-example": "My API Key" }, - "defaultBranch": { + "expire": { "type": "string", - "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerInstallationId": { - "type": "string", - "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" }, - "authorized": { - "type": "boolean", - "description": "Is VCS (Version Control System) repository authorized for the installation?", - "x-example": true + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "pushedAt": { + "accessedAt": { "type": "string", - "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "variables": { + "sdks": { "type": "array", - "description": "Environment variables found in .env files", + "description": "List of SDK user agents that used this key.", "items": { "type": "string" }, - "x-example": [ - "PORT", - "NODE_ENV" - ] - }, - "runtime": { - "type": "string", - "description": "Auto-detected runtime. Empty if type is not \"runtime\".", - "x-example": "node-22" + "x-example": "appwrite:flutter" } }, "required": [ - "id", + "$id", + "$createdAt", + "$updatedAt", "name", - "organization", - "provider", - "private", - "defaultBranch", - "providerInstallationId", - "authorized", - "pushedAt", - "variables", - "runtime" + "expire", + "scopes", + "secret", + "accessedAt", + "sdks" ], "example": { - "id": "5e5ea5c16897e", - "name": "appwrite", - "organization": "appwrite", - "provider": "github", - "private": true, - "defaultBranch": "main", - "providerInstallationId": "108104697", - "authorized": true, - "pushedAt": "datetime", - "variables": [ - "PORT", - "NODE_ENV" - ], - "runtime": "node-22" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "scopes": "users.read", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" } }, - "detectionFramework": { - "description": "DetectionFramework", + "devKey": { + "description": "DevKey", "type": "object", "properties": { - "type": { + "$id": { "type": "string", - "description": "Repository detection type.", - "x-example": "framework", - "enum": [ - "framework" - ] + "description": "Key ID.", + "x-example": "5e5ea5c16897e" }, - "variables": { - "type": "array", - "description": "Environment variables found in .env files", - "items": { - "type": "object", - "$ref": "#\/definitions\/detectionVariable" - }, - "x-example": {}, - "x-nullable": true + "$createdAt": { + "type": "string", + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "framework": { + "$updatedAt": { "type": "string", - "description": "Framework", - "x-example": "nuxt" + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "installCommand": { + "name": { "type": "string", - "description": "Site Install Command", - "x-example": "npm install" + "description": "Key name.", + "x-example": "Dev API Key" }, - "buildCommand": { + "expire": { "type": "string", - "description": "Site Build Command", - "x-example": "npm run build" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "outputDirectory": { + "secret": { "type": "string", - "description": "Site Output Directory", - "x-example": "dist" + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + }, + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" } }, "required": [ - "type", - "framework", - "installCommand", - "buildCommand", - "outputDirectory" + "$id", + "$createdAt", + "$updatedAt", + "name", + "expire", + "secret", + "accessedAt", + "sdks" ], "example": { - "type": "framework", - "variables": {}, - "framework": "nuxt", - "installCommand": "npm install", - "buildCommand": "npm run build", - "outputDirectory": "dist" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Dev API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" } }, - "detectionRuntime": { - "description": "DetectionRuntime", + "mockNumber": { + "description": "Mock Number", "type": "object", "properties": { - "type": { + "number": { "type": "string", - "description": "Repository detection type.", - "x-example": "runtime", - "enum": [ - "runtime" - ] - }, - "variables": { - "type": "array", - "description": "Environment variables found in .env files", - "items": { - "type": "object", - "$ref": "#\/definitions\/detectionVariable" - }, - "x-example": {}, - "x-nullable": true + "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", + "x-example": "+1612842323" }, - "runtime": { + "otp": { "type": "string", - "description": "Runtime", - "x-example": "node" + "description": "Mock OTP for the number. ", + "x-example": "123456" }, - "entrypoint": { + "$createdAt": { "type": "string", - "description": "Function Entrypoint", - "x-example": "index.js" + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "commands": { + "$updatedAt": { "type": "string", - "description": "Function install and build commands", - "x-example": "npm install && npm run build" + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "type", - "runtime", - "entrypoint", - "commands" + "number", + "otp", + "$createdAt", + "$updatedAt" ], "example": { - "type": "runtime", - "variables": {}, - "runtime": "node", - "entrypoint": "index.js", - "commands": "npm install && npm run build" + "number": "+1612842323", + "otp": "123456", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "detectionVariable": { - "description": "DetectionVariable", + "oAuth2Github": { + "description": "OAuth2GitHub", "type": "object", "properties": { - "name": { + "$id": { "type": "string", - "description": "Name of environment variable", - "x-example": "NODE_ENV" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "value": { + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "clientId": { "type": "string", - "description": "Value of environment variable", - "x-example": "production" + "description": "GitHub OAuth2 client ID. For GitHub Apps, use the \"App ID\" when both an App ID and client ID are available.", + "x-example": "e4d87900000000540733" + }, + "clientSecret": { + "type": "string", + "description": "GitHub OAuth2 client secret.", + "x-example": "5e07c00000000000000000000000000000198bcc" } }, "required": [ - "name", - "value" + "$id", + "enabled", + "clientId", + "clientSecret" ], "example": { - "name": "NODE_ENV", - "value": "production" + "$id": "github", + "enabled": false, + "clientId": "e4d87900000000540733", + "clientSecret": "5e07c00000000000000000000000000000198bcc" } }, - "vcsContent": { - "description": "VcsContents", + "oAuth2Discord": { + "description": "OAuth2Discord", "type": "object", "properties": { - "size": { - "type": "integer", - "description": "Content size in bytes. Only files have size, and for directories, 0 is returned.", - "x-example": 1523, - "format": "int32", - "x-nullable": true + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "isDirectory": { + "enabled": { "type": "boolean", - "description": "If a content is a directory. Directories can be used to check nested contents.", - "x-example": true, - "x-nullable": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "name": { + "clientId": { "type": "string", - "description": "Name of directory or file.", - "x-example": "Main.java" - } - }, - "required": [ - "name" - ], - "example": { - "size": 1523, - "isDirectory": true, - "name": "Main.java" - } - }, - "branch": { - "description": "Branch", - "type": "object", - "properties": { - "name": { + "description": "Discord OAuth2 client ID.", + "x-example": "950722000000343754" + }, + "clientSecret": { "type": "string", - "description": "Branch Name.", - "x-example": "main" + "description": "Discord OAuth2 client secret.", + "x-example": "YmPXnM000000000000000000002zFg5D" } }, "required": [ - "name" + "$id", + "enabled", + "clientId", + "clientSecret" ], "example": { - "name": "main" + "$id": "github", + "enabled": false, + "clientId": "950722000000343754", + "clientSecret": "YmPXnM000000000000000000002zFg5D" } }, - "runtime": { - "description": "Runtime", + "oAuth2Figma": { + "description": "OAuth2Figma", "type": "object", "properties": { "$id": { "type": "string", - "description": "Runtime ID.", - "x-example": "python-3.8" - }, - "key": { - "type": "string", - "description": "Parent runtime key.", - "x-example": "python" - }, - "name": { - "type": "string", - "description": "Runtime Name.", - "x-example": "Python" - }, - "version": { - "type": "string", - "description": "Runtime version.", - "x-example": "3.8" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "base": { - "type": "string", - "description": "Base Docker image used to build the runtime.", - "x-example": "python:3.8-alpine" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "image": { + "clientId": { "type": "string", - "description": "Image name of Docker Hub.", - "x-example": "appwrite\\\/runtime-for-python:3.8" + "description": "Figma OAuth2 client ID.", + "x-example": "byay5H0000000000VtiI40" }, - "logo": { + "clientSecret": { "type": "string", - "description": "Name of the logo image.", - "x-example": "python.png" - }, - "supports": { - "type": "array", - "description": "List of supported architectures.", - "items": { - "type": "string" - }, - "x-example": "amd64" + "description": "Figma OAuth2 client secret.", + "x-example": "yEpOYn0000000000000000004iIsU5" } }, "required": [ "$id", - "key", - "name", - "version", - "base", - "image", - "logo", - "supports" + "enabled", + "clientId", + "clientSecret" ], "example": { - "$id": "python-3.8", - "key": "python", - "name": "Python", - "version": "3.8", - "base": "python:3.8-alpine", - "image": "appwrite\\\/runtime-for-python:3.8", - "logo": "python.png", - "supports": "amd64" + "$id": "github", + "enabled": false, + "clientId": "byay5H0000000000VtiI40", + "clientSecret": "yEpOYn0000000000000000004iIsU5" } }, - "framework": { - "description": "Framework", + "oAuth2Dropbox": { + "description": "OAuth2Dropbox", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Framework key.", - "x-example": "sveltekit" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "name": { - "type": "string", - "description": "Framework Name.", - "x-example": "SvelteKit" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "buildRuntime": { + "appKey": { "type": "string", - "description": "Default runtime version.", - "x-example": "node-22" - }, - "runtimes": { - "type": "array", - "description": "List of supported runtime versions.", - "items": { - "type": "string" - }, - "x-example": [ - "static-1", - "node-22" - ] + "description": "Dropbox OAuth2 app key.", + "x-example": "jl000000000009t" }, - "adapters": { - "type": "array", - "description": "List of supported adapters.", - "items": { - "type": "object", - "$ref": "#\/definitions\/frameworkAdapter" - }, - "x-example": [ - { - "key": "static", - "buildRuntime": "node-22", - "buildCommand": "npm run build", - "installCommand": "npm install", - "outputDirectory": ".\/dist" - } - ] + "appSecret": { + "type": "string", + "description": "Dropbox OAuth2 app secret.", + "x-example": "g200000000000vw" } }, "required": [ - "key", - "name", - "buildRuntime", - "runtimes", - "adapters" + "$id", + "enabled", + "appKey", + "appSecret" ], "example": { - "key": "sveltekit", - "name": "SvelteKit", - "buildRuntime": "node-22", - "runtimes": [ - "static-1", - "node-22" - ], - "adapters": [ - { - "key": "static", - "buildRuntime": "node-22", - "buildCommand": "npm run build", - "installCommand": "npm install", - "outputDirectory": ".\/dist" - } - ] + "$id": "github", + "enabled": false, + "appKey": "jl000000000009t", + "appSecret": "g200000000000vw" } }, - "frameworkAdapter": { - "description": "Framework Adapter", + "oAuth2Dailymotion": { + "description": "OAuth2Dailymotion", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Adapter key.", - "x-example": "static" - }, - "installCommand": { + "$id": { "type": "string", - "description": "Default command to download dependencies.", - "x-example": "npm install" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "buildCommand": { - "type": "string", - "description": "Default command to build site into output directory.", - "x-example": "npm run build" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "outputDirectory": { + "apiKey": { "type": "string", - "description": "Default output directory of build.", - "x-example": ".\/dist" + "description": "Dailymotion OAuth2 API key.", + "x-example": "07a9000000000000067f" }, - "fallbackFile": { + "apiSecret": { "type": "string", - "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "description": "Dailymotion OAuth2 API secret.", + "x-example": "a399a90000000000000000000000000000d90639" } }, "required": [ - "key", - "installCommand", - "buildCommand", - "outputDirectory", - "fallbackFile" + "$id", + "enabled", + "apiKey", + "apiSecret" ], "example": { - "key": "static", - "installCommand": "npm install", - "buildCommand": "npm run build", - "outputDirectory": ".\/dist", - "fallbackFile": "index.html" + "$id": "github", + "enabled": false, + "apiKey": "07a9000000000000067f", + "apiSecret": "a399a90000000000000000000000000000d90639" } }, - "deployment": { - "description": "Deployment", + "oAuth2Bitbucket": { + "description": "OAuth2Bitbucket", "type": "object", "properties": { "$id": { "type": "string", - "description": "Deployment ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "key": { "type": "string", - "description": "Deployment update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Bitbucket OAuth2 key.", + "x-example": "Knt70000000000ByRc" }, - "type": { + "secret": { "type": "string", - "description": "Type of deployment.", - "x-example": "vcs" - }, - "resourceId": { + "description": "Bitbucket OAuth2 secret.", + "x-example": "NMfLZJ00000000000000000000TLQdDx" + } + }, + "required": [ + "$id", + "enabled", + "key", + "secret" + ], + "example": { + "$id": "github", + "enabled": false, + "key": "Knt70000000000ByRc", + "secret": "NMfLZJ00000000000000000000TLQdDx" + } + }, + "oAuth2Bitly": { + "description": "OAuth2Bitly", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea6g16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "resourceType": { - "type": "string", - "description": "Resource type.", - "x-example": "functions" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "entrypoint": { + "clientId": { "type": "string", - "description": "The entrypoint file to use to execute the deployment code.", - "x-example": "index.js" - }, - "sourceSize": { - "type": "integer", - "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" - }, - "buildSize": { - "type": "integer", - "description": "The build output size in bytes.", - "x-example": 128, - "format": "int32" - }, - "totalSize": { - "type": "integer", - "description": "The total size in bytes (source and build output).", - "x-example": 128, - "format": "int32" + "description": "Bitly OAuth2 client ID.", + "x-example": "d95151000000000000000000000000000067af9b" }, - "buildId": { + "clientSecret": { "type": "string", - "description": "The current build ID.", - "x-example": "5e5ea5c16897e" + "description": "Bitly OAuth2 client secret.", + "x-example": "a13e250000000000000000000000000000d73095" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "d95151000000000000000000000000000067af9b", + "clientSecret": "a13e250000000000000000000000000000d73095" + } + }, + "oAuth2Box": { + "description": "OAuth2Box", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "activate": { + "enabled": { "type": "boolean", - "description": "Whether the deployment should be automatically activated.", - "x-example": true - }, - "screenshotLight": { - "type": "string", - "description": "Screenshot with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "screenshotDark": { + "clientId": { "type": "string", - "description": "Screenshot with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "description": "Box OAuth2 client ID.", + "x-example": "deglcs00000000000000000000x2og6y" }, - "status": { + "clientSecret": { "type": "string", - "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", - "x-example": "ready", - "enum": [ - "waiting", - "processing", - "building", - "ready", - "canceled", - "failed" - ] - }, - "buildLogs": { + "description": "Box OAuth2 client secret.", + "x-example": "OKM1f100000000000000000000eshEif" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "deglcs00000000000000000000x2og6y", + "clientSecret": "OKM1f100000000000000000000eshEif" + } + }, + "oAuth2Autodesk": { + "description": "OAuth2Autodesk", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The build logs.", - "x-example": "Compiling source files..." + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "buildDuration": { - "type": "integer", - "description": "The current build time in seconds.", - "x-example": 128, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerRepositoryName": { + "clientId": { "type": "string", - "description": "The name of the vcs provider repository", - "x-example": "database" + "description": "Autodesk OAuth2 client ID.", + "x-example": "5zw90v00000000000000000000kVYXN7" }, - "providerRepositoryOwner": { + "clientSecret": { "type": "string", - "description": "The name of the vcs provider repository owner", - "x-example": "utopia" - }, - "providerRepositoryUrl": { + "description": "Autodesk OAuth2 client secret.", + "x-example": "7I000000000000MW" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "5zw90v00000000000000000000kVYXN7", + "clientSecret": "7I000000000000MW" + } + }, + "oAuth2Google": { + "description": "OAuth2Google", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The url of the vcs provider repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "providerCommitHash": { - "type": "string", - "description": "The commit hash of the vcs commit", - "x-example": "7c3f25d" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerCommitAuthorUrl": { + "clientId": { "type": "string", - "description": "The url of vcs commit author", - "x-example": "https:\/\/github.com\/vermakhushboo" + "description": "Google OAuth2 client ID.", + "x-example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" }, - "providerCommitAuthor": { + "clientSecret": { "type": "string", - "description": "The name of vcs commit author", - "x-example": "Khushboo Verma" - }, - "providerCommitMessage": { + "description": "Google OAuth2 client secret.", + "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", + "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj" + } + }, + "oAuth2Zoom": { + "description": "OAuth2Zoom", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The commit message", - "x-example": "Update index.js" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "providerCommitUrl": { - "type": "string", - "description": "The url of the vcs commit", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerBranch": { + "clientId": { "type": "string", - "description": "The branch of the vcs repository", - "x-example": "0.7.x" + "description": "Zoom OAuth2 client ID.", + "x-example": "QMAC00000000000000w0AQ" }, - "providerBranchUrl": { + "clientSecret": { "type": "string", - "description": "The branch of the vcs repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "description": "Zoom OAuth2 client secret.", + "x-example": "GAWsG4000000000000000000007U01ON" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "type", - "resourceId", - "resourceType", - "entrypoint", - "sourceSize", - "buildSize", - "totalSize", - "buildId", - "activate", - "screenshotLight", - "screenshotDark", - "status", - "buildLogs", - "buildDuration", - "providerRepositoryName", - "providerRepositoryOwner", - "providerRepositoryUrl", - "providerCommitHash", - "providerCommitAuthorUrl", - "providerCommitAuthor", - "providerCommitMessage", - "providerCommitUrl", - "providerBranch", - "providerBranchUrl" + "enabled", + "clientId", + "clientSecret" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "type": "vcs", - "resourceId": "5e5ea6g16897e", - "resourceType": "functions", - "entrypoint": "index.js", - "sourceSize": 128, - "buildSize": 128, - "totalSize": 128, - "buildId": "5e5ea5c16897e", - "activate": true, - "screenshotLight": "5e5ea5c16897e", - "screenshotDark": "5e5ea5c16897e", - "status": "ready", - "buildLogs": "Compiling source files...", - "buildDuration": 128, - "providerRepositoryName": "database", - "providerRepositoryOwner": "utopia", - "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function", - "providerCommitHash": "7c3f25d", - "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo", - "providerCommitAuthor": "Khushboo Verma", - "providerCommitMessage": "Update index.js", - "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", - "providerBranch": "0.7.x", - "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "$id": "github", + "enabled": false, + "clientId": "QMAC00000000000000w0AQ", + "clientSecret": "GAWsG4000000000000000000007U01ON" } }, - "execution": { - "description": "Execution", + "oAuth2Zoho": { + "description": "OAuth2Zoho", "type": "object", "properties": { "$id": { "type": "string", - "description": "Execution ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Execution creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Execution update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Execution roles.", - "items": { - "type": "string" - }, - "x-example": [ - "any" - ] + "description": "Zoho OAuth2 client ID.", + "x-example": "1000.83C178000000000000000000RPNX0B" }, - "functionId": { + "clientSecret": { "type": "string", - "description": "Function ID.", - "x-example": "5e5ea6g16897e" - }, - "deploymentId": { + "description": "Zoho OAuth2 client secret.", + "x-example": "fb5cac000000000000000000000000000000a68f6e" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "1000.83C178000000000000000000RPNX0B", + "clientSecret": "fb5cac000000000000000000000000000000a68f6e" + } + }, + "oAuth2Yandex": { + "description": "OAuth2Yandex", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Function's deployment ID used to create the execution.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "trigger": { - "type": "string", - "description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.", - "x-example": "http", - "enum": [ - "http", - "schedule", - "event" - ] + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "status": { + "clientId": { "type": "string", - "description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", - "x-example": "processing", - "enum": [ - "waiting", - "processing", - "completed", - "failed", - "scheduled" - ] + "description": "Yandex OAuth2 client ID.", + "x-example": "6a8a6a0000000000000000000091483c" }, - "requestMethod": { + "clientSecret": { "type": "string", - "description": "HTTP request method type.", - "x-example": "GET" - }, - "requestPath": { + "description": "Yandex OAuth2 client secret.", + "x-example": "bbf98500000000000000000000c75a63" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "6a8a6a0000000000000000000091483c", + "clientSecret": "bbf98500000000000000000000c75a63" + } + }, + "oAuth2X": { + "description": "OAuth2X", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "HTTP request path and query.", - "x-example": "\/articles?id=5" - }, - "requestHeaders": { - "type": "array", - "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", - "items": { - "type": "object", - "$ref": "#\/definitions\/headers" - }, - "x-example": [ - { - "Content-Type": "application\/json" - } - ] + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "responseStatusCode": { - "type": "integer", - "description": "HTTP response status code.", - "x-example": 200, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "responseBody": { + "customerKey": { "type": "string", - "description": "HTTP response body. This will return empty unless execution is created as synchronous.", - "x-example": "" - }, - "responseHeaders": { - "type": "array", - "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", - "items": { - "type": "object", - "$ref": "#\/definitions\/headers" - }, - "x-example": [ - { - "Content-Type": "application\/json" - } - ] + "description": "X OAuth2 customer key.", + "x-example": "slzZV0000000000000NFLaWT" }, - "logs": { + "secretKey": { "type": "string", - "description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" - }, - "errors": { + "description": "X OAuth2 secret key.", + "x-example": "tkEPkp00000000000000000000000000000000000000FTxbI9" + } + }, + "required": [ + "$id", + "enabled", + "customerKey", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "customerKey": "slzZV0000000000000NFLaWT", + "secretKey": "tkEPkp00000000000000000000000000000000000000FTxbI9" + } + }, + "oAuth2WordPress": { + "description": "OAuth2WordPress", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "duration": { - "type": "number", - "description": "Resource(function\/site) execution duration in seconds.", - "x-example": 0.4, - "format": "double" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "scheduledAt": { + "clientId": { "type": "string", - "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "x-nullable": true + "description": "WordPress OAuth2 client ID.", + "x-example": "130005" + }, + "clientSecret": { + "type": "string", + "description": "WordPress OAuth2 client secret.", + "x-example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "$permissions", - "functionId", - "deploymentId", - "trigger", - "status", - "requestMethod", - "requestPath", - "requestHeaders", - "responseStatusCode", - "responseBody", - "responseHeaders", - "logs", - "errors", - "duration" + "enabled", + "clientId", + "clientSecret" ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "any" - ], - "functionId": "5e5ea6g16897e", - "deploymentId": "5e5ea5c16897e", - "trigger": "http", - "status": "processing", - "requestMethod": "GET", - "requestPath": "\/articles?id=5", - "requestHeaders": [ - { - "Content-Type": "application\/json" - } - ], - "responseStatusCode": 200, - "responseBody": "", - "responseHeaders": [ - { - "Content-Type": "application\/json" - } - ], - "logs": "", - "errors": "", - "duration": 0.4, - "scheduledAt": "2020-10-15T06:38:00.000+00:00" + "example": { + "$id": "github", + "enabled": false, + "clientId": "130005", + "clientSecret": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" } }, - "project": { - "description": "Project", + "oAuth2Twitch": { + "description": "OAuth2Twitch", "type": "object", "properties": { "$id": { "type": "string", - "description": "Project ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Project creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$updatedAt": { - "type": "string", - "description": "Project update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "name": { + "clientId": { "type": "string", - "description": "Project name.", - "x-example": "New Project" + "description": "Twitch OAuth2 client ID.", + "x-example": "vvi0in000000000000000000ikmt9p" }, - "description": { + "clientSecret": { "type": "string", - "description": "Project description.", - "x-example": "This is a new project." - }, - "teamId": { + "description": "Twitch OAuth2 client secret.", + "x-example": "pmapue000000000000000000zylw3v" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "vvi0in000000000000000000ikmt9p", + "clientSecret": "pmapue000000000000000000zylw3v" + } + }, + "oAuth2Stripe": { + "description": "OAuth2Stripe", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Project team ID.", - "x-example": "1592981250" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "logo": { - "type": "string", - "description": "Project logo file ID.", - "x-example": "5f5c451b403cb" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "url": { + "clientId": { "type": "string", - "description": "Project website URL.", - "x-example": "5f5c451b403cb" + "description": "Stripe OAuth2 client ID.", + "x-example": "ca_UKibXX0000000000000000000006byvR" }, - "legalName": { + "apiSecretKey": { "type": "string", - "description": "Company legal name.", - "x-example": "Company LTD." - }, - "legalCountry": { + "description": "Stripe OAuth2 API secret key.", + "x-example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "apiSecretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "ca_UKibXX0000000000000000000006byvR", + "apiSecretKey": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + } + }, + "oAuth2Spotify": { + "description": "OAuth2Spotify", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", - "x-example": "US" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "legalState": { - "type": "string", - "description": "State name.", - "x-example": "New York" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "legalCity": { + "clientId": { "type": "string", - "description": "City name.", - "x-example": "New York City." + "description": "Spotify OAuth2 client ID.", + "x-example": "6ec271000000000000000000009beace" }, - "legalAddress": { + "clientSecret": { "type": "string", - "description": "Company Address.", - "x-example": "620 Eighth Avenue, New York, NY 10018" - }, - "legalTaxId": { + "description": "Spotify OAuth2 client secret.", + "x-example": "db068a000000000000000000008b5b9f" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "6ec271000000000000000000009beace", + "clientSecret": "db068a000000000000000000008b5b9f" + } + }, + "oAuth2Slack": { + "description": "OAuth2Slack", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Company Tax ID.", - "x-example": "131102020" - }, - "authDuration": { - "type": "integer", - "description": "Session duration in seconds.", - "x-example": 60, - "format": "int32" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authLimit": { - "type": "integer", - "description": "Max users allowed. 0 is unlimited.", - "x-example": 100, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authSessionsLimit": { - "type": "integer", - "description": "Max sessions allowed per user. 100 maximum.", - "x-example": 10, - "format": "int32" + "clientId": { + "type": "string", + "description": "Slack OAuth2 client ID.", + "x-example": "23000000089.15000000000023" }, - "authPasswordHistory": { - "type": "integer", - "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", - "x-example": 5, - "format": "int32" + "clientSecret": { + "type": "string", + "description": "Slack OAuth2 client secret.", + "x-example": "81656000000000000000000000f3d2fd" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "23000000089.15000000000023", + "clientSecret": "81656000000000000000000000f3d2fd" + } + }, + "oAuth2Podio": { + "description": "OAuth2Podio", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authPasswordDictionary": { + "enabled": { "type": "boolean", - "description": "Whether or not to check user's password against most commonly used passwords.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authPersonalDataCheck": { - "type": "boolean", - "description": "Whether or not to check the user password for similarity with their personal data.", - "x-example": true + "clientId": { + "type": "string", + "description": "Podio OAuth2 client ID.", + "x-example": "appwrite-oauth-test-app" }, - "authDisposableEmails": { - "type": "boolean", - "description": "Whether or not to disallow disposable email addresses during signup and email updates.", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Podio OAuth2 client secret.", + "x-example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "appwrite-oauth-test-app", + "clientSecret": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + } + }, + "oAuth2Notion": { + "description": "OAuth2Notion", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authCanonicalEmails": { + "enabled": { "type": "boolean", - "description": "Whether or not to require canonical email addresses during signup and email updates.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authFreeEmails": { - "type": "boolean", - "description": "Whether or not to disallow free email addresses during signup and email updates.", - "x-example": true + "oauthClientId": { + "type": "string", + "description": "Notion OAuth2 client ID.", + "x-example": "341d8700-0000-0000-0000-000000446ee3" }, - "authMockNumbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs).", - "items": { - "type": "object", - "$ref": "#\/definitions\/mockNumber" - }, - "x-example": [ - {} - ] + "oauthClientSecret": { + "type": "string", + "description": "Notion OAuth2 client secret.", + "x-example": "secret_dLUr4b000000000000000000000000000000lFHAa9" + } + }, + "required": [ + "$id", + "enabled", + "oauthClientId", + "oauthClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "oauthClientId": "341d8700-0000-0000-0000-000000446ee3", + "oauthClientSecret": "secret_dLUr4b000000000000000000000000000000lFHAa9" + } + }, + "oAuth2Salesforce": { + "description": "OAuth2Salesforce", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authSessionAlerts": { + "enabled": { "type": "boolean", - "description": "Whether or not to send session alert emails to users.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authMembershipsUserName": { - "type": "boolean", - "description": "Whether or not to show user names in the teams membership response.", - "x-example": true + "customerKey": { + "type": "string", + "description": "Salesforce OAuth2 consumer key.", + "x-example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" }, - "authMembershipsUserEmail": { - "type": "boolean", - "description": "Whether or not to show user emails in the teams membership response.", - "x-example": true + "customerSecret": { + "type": "string", + "description": "Salesforce OAuth2 consumer secret.", + "x-example": "3w000000000000e2" + } + }, + "required": [ + "$id", + "enabled", + "customerKey", + "customerSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "customerKey": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", + "customerSecret": "3w000000000000e2" + } + }, + "oAuth2Yahoo": { + "description": "OAuth2Yahoo", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authMembershipsMfa": { + "enabled": { "type": "boolean", - "description": "Whether or not to show user MFA status in the teams membership response.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authMembershipsUserId": { - "type": "boolean", - "description": "Whether or not to show user IDs in the teams membership response.", - "x-example": true + "clientId": { + "type": "string", + "description": "Yahoo OAuth2 client ID.", + "x-example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" }, - "authMembershipsUserPhone": { - "type": "boolean", - "description": "Whether or not to show user phone numbers in the teams membership response.", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Yahoo OAuth2 client secret.", + "x-example": "cf978f0000000000000000000000000000c5e2e9" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", + "clientSecret": "cf978f0000000000000000000000000000c5e2e9" + } + }, + "oAuth2Linkedin": { + "description": "OAuth2Linkedin", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authInvalidateSessions": { + "enabled": { "type": "boolean", - "description": "Whether or not all existing sessions should be invalidated on password change", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "oAuthProviders": { - "type": "array", - "description": "List of Auth Providers.", - "items": { - "type": "object", - "$ref": "#\/definitions\/authProvider" - }, - "x-example": [ - {} - ] + "clientId": { + "type": "string", + "description": "LinkedIn OAuth2 client ID.", + "x-example": "770000000000dv" }, - "platforms": { - "type": "array", - "description": "List of Platforms.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/platformWeb" - }, - { - "$ref": "#\/definitions\/platformApple" - }, - { - "$ref": "#\/definitions\/platformAndroid" - }, - { - "$ref": "#\/definitions\/platformWindows" - }, - { - "$ref": "#\/definitions\/platformLinux" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/definitions\/platformWeb", - "apple": "#\/definitions\/platformApple", - "android": "#\/definitions\/platformAndroid", - "windows": "#\/definitions\/platformWindows", - "linux": "#\/definitions\/platformLinux" - } - } - }, - "x-example": {} + "primaryClientSecret": { + "type": "string", + "description": "LinkedIn OAuth2 primary client secret.", + "x-example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "primaryClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "770000000000dv", + "primaryClientSecret": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + } + }, + "oAuth2Disqus": { + "description": "OAuth2Disqus", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "webhooks": { - "type": "array", - "description": "List of Webhooks.", - "items": { - "type": "object", - "$ref": "#\/definitions\/webhook" - }, - "x-example": {} + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "keys": { - "type": "array", - "description": "List of API Keys.", - "items": { - "type": "object", - "$ref": "#\/definitions\/key" - }, - "x-example": {} + "publicKey": { + "type": "string", + "description": "Disqus OAuth2 public key.", + "x-example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" }, - "devKeys": { - "type": "array", - "description": "List of dev keys.", - "items": { - "type": "object", - "$ref": "#\/definitions\/devKey" - }, - "x-example": {} + "secretKey": { + "type": "string", + "description": "Disqus OAuth2 secret key.", + "x-example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + } + }, + "required": [ + "$id", + "enabled", + "publicKey", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "publicKey": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", + "secretKey": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + } + }, + "oAuth2Amazon": { + "description": "OAuth2Amazon", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpEnabled": { + "enabled": { "type": "boolean", - "description": "Status for custom SMTP", + "description": "OAuth2 provider is active and can be used to create sessions.", "x-example": false }, - "smtpSenderName": { + "clientId": { "type": "string", - "description": "SMTP sender name", - "x-example": "John Appwrite" + "description": "Amazon OAuth2 client ID.", + "x-example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" }, - "smtpSenderEmail": { + "clientSecret": { "type": "string", - "description": "SMTP sender email", - "x-example": "john@appwrite.io" - }, - "smtpReplyToName": { + "description": "Amazon OAuth2 client secret.", + "x-example": "79ffe4000000000000000000000000000000000000000000000000000002de55" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2", + "clientSecret": "79ffe4000000000000000000000000000000000000000000000000000002de55" + } + }, + "oAuth2Etsy": { + "description": "OAuth2Etsy", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "SMTP reply to name", - "x-example": "Support Team" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpReplyToEmail": { + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "keyString": { "type": "string", - "description": "SMTP reply to email", - "x-example": "support@appwrite.io" + "description": "Etsy OAuth2 keystring.", + "x-example": "nsgzxh0000000000008j85a2" }, - "smtpHost": { + "sharedSecret": { "type": "string", - "description": "SMTP server host name", - "x-example": "mail.appwrite.io" + "description": "Etsy OAuth2 shared secret.", + "x-example": "tp000000ru" + } + }, + "required": [ + "$id", + "enabled", + "keyString", + "sharedSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "keyString": "nsgzxh0000000000008j85a2", + "sharedSecret": "tp000000ru" + } + }, + "oAuth2Facebook": { + "description": "OAuth2Facebook", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpPort": { - "type": "integer", - "description": "SMTP server port", - "x-example": 25, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "smtpUsername": { + "appId": { "type": "string", - "description": "SMTP server username", - "x-example": "emailuser" + "description": "Facebook OAuth2 app ID.", + "x-example": "260600000007694" }, - "smtpPassword": { + "appSecret": { "type": "string", - "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "" - }, - "smtpSecure": { + "description": "Facebook OAuth2 app secret.", + "x-example": "2d0b2800000000000000000000d38af4" + } + }, + "required": [ + "$id", + "enabled", + "appId", + "appSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "appId": "260600000007694", + "appSecret": "2d0b2800000000000000000000d38af4" + } + }, + "oAuth2Tradeshift": { + "description": "OAuth2Tradeshift", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "SMTP server secure protocol", - "x-example": "tls" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "pingCount": { - "type": "integer", - "description": "Number of times the ping was received for this project.", - "x-example": 1, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "pingedAt": { + "oauth2ClientId": { "type": "string", - "description": "Last ping datetime in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "labels": { - "type": "array", - "description": "Labels for the project.", - "items": { - "type": "string" - }, - "x-example": [ - "vip" - ] + "description": "Tradeshift OAuth2 client ID.", + "x-example": "appwrite-test-org.appwrite-test-app" }, - "status": { + "oauth2ClientSecret": { "type": "string", - "description": "Project status", - "x-example": "active" + "description": "Tradeshift OAuth2 client secret.", + "x-example": "7cb52700-0000-0000-0000-000000ca5b83" + } + }, + "required": [ + "$id", + "enabled", + "oauth2ClientId", + "oauth2ClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "oauth2ClientId": "appwrite-test-org.appwrite-test-app", + "oauth2ClientSecret": "7cb52700-0000-0000-0000-000000ca5b83" + } + }, + "oAuth2Paypal": { + "description": "OAuth2Paypal", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authEmailPassword": { + "enabled": { "type": "boolean", - "description": "Email\/Password auth method status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authUsersAuthMagicURL": { - "type": "boolean", - "description": "Magic URL auth method status", - "x-example": true + "clientId": { + "type": "string", + "description": "PayPal OAuth2 client ID.", + "x-example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" }, - "authEmailOtp": { - "type": "boolean", - "description": "Email (OTP) auth method status", - "x-example": true + "secretKey": { + "type": "string", + "description": "PayPal OAuth2 secret key.", + "x-example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "secretKey": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + } + }, + "oAuth2Gitlab": { + "description": "OAuth2Gitlab", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authAnonymous": { + "enabled": { "type": "boolean", - "description": "Anonymous auth method status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authInvites": { - "type": "boolean", - "description": "Invites auth method status", - "x-example": true + "applicationId": { + "type": "string", + "description": "GitLab OAuth2 application ID.", + "x-example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" }, - "authJWT": { - "type": "boolean", - "description": "JWT auth method status", - "x-example": true + "secret": { + "type": "string", + "description": "GitLab OAuth2 secret.", + "x-example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" }, - "authPhone": { - "type": "boolean", - "description": "Phone auth method status", - "x-example": true + "endpoint": { + "type": "string", + "description": "GitLab OAuth2 endpoint URL. Defaults to https:\/\/gitlab.com for self-hosted instances.", + "x-example": "https:\/\/gitlab.com" + } + }, + "required": [ + "$id", + "enabled", + "applicationId", + "secret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "applicationId": "d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "secret": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "endpoint": "https:\/\/gitlab.com" + } + }, + "oAuth2Authentik": { + "description": "OAuth2Authentik", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForAccount": { + "enabled": { "type": "boolean", - "description": "Account service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForAvatars": { - "type": "boolean", - "description": "Avatars service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Authentik OAuth2 client ID.", + "x-example": "dTKOPa0000000000000000000000000000e7G8hv" }, - "serviceStatusForDatabases": { - "type": "boolean", - "description": "Databases (legacy) service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Authentik OAuth2 client secret.", + "x-example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" }, - "serviceStatusForTablesdb": { - "type": "boolean", - "description": "TablesDB service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Authentik OAuth2 endpoint domain.", + "x-example": "example.authentik.com" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "dTKOPa0000000000000000000000000000e7G8hv", + "clientSecret": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", + "endpoint": "example.authentik.com" + } + }, + "oAuth2Auth0": { + "description": "OAuth2Auth0", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForLocale": { + "enabled": { "type": "boolean", - "description": "Locale service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForHealth": { - "type": "boolean", - "description": "Health service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Auth0 OAuth2 client ID.", + "x-example": "OaOkIA000000000000000000005KLSYq" }, - "serviceStatusForProject": { - "type": "boolean", - "description": "Project service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Auth0 OAuth2 client secret.", + "x-example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" }, - "serviceStatusForStorage": { - "type": "boolean", - "description": "Storage service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Auth0 OAuth2 endpoint domain.", + "x-example": "example.us.auth0.com" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "OaOkIA000000000000000000005KLSYq", + "clientSecret": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", + "endpoint": "example.us.auth0.com" + } + }, + "oAuth2FusionAuth": { + "description": "OAuth2FusionAuth", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForTeams": { + "enabled": { "type": "boolean", - "description": "Teams service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForUsers": { - "type": "boolean", - "description": "Users service status", - "x-example": true + "clientId": { + "type": "string", + "description": "FusionAuth OAuth2 client ID.", + "x-example": "b2222c00-0000-0000-0000-000000862097" }, - "serviceStatusForVcs": { - "type": "boolean", - "description": "VCS service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "FusionAuth OAuth2 client secret.", + "x-example": "Jx4s0C0000000000000000000000000000000wGqLsc" }, - "serviceStatusForSites": { - "type": "boolean", - "description": "Sites service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "FusionAuth OAuth2 endpoint domain.", + "x-example": "example.fusionauth.io" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "b2222c00-0000-0000-0000-000000862097", + "clientSecret": "Jx4s0C0000000000000000000000000000000wGqLsc", + "endpoint": "example.fusionauth.io" + } + }, + "oAuth2Keycloak": { + "description": "OAuth2Keycloak", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForFunctions": { + "enabled": { "type": "boolean", - "description": "Functions service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForProxy": { - "type": "boolean", - "description": "Proxy service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Keycloak OAuth2 client ID.", + "x-example": "appwrite-o0000000st-app" }, - "serviceStatusForGraphql": { - "type": "boolean", - "description": "GraphQL service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Keycloak OAuth2 client secret.", + "x-example": "jdjrJd00000000000000000000HUsaZO" }, - "serviceStatusForMigrations": { - "type": "boolean", - "description": "Migrations service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Keycloak OAuth2 endpoint domain.", + "x-example": "keycloak.example.com" }, - "serviceStatusForMessaging": { - "type": "boolean", - "description": "Messaging service status", - "x-example": true + "realmName": { + "type": "string", + "description": "Keycloak OAuth2 realm name.", + "x-example": "appwrite-realm" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint", + "realmName" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "appwrite-o0000000st-app", + "clientSecret": "jdjrJd00000000000000000000HUsaZO", + "endpoint": "keycloak.example.com", + "realmName": "appwrite-realm" + } + }, + "oAuth2Oidc": { + "description": "OAuth2Oidc", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "protocolStatusForRest": { + "enabled": { "type": "boolean", - "description": "REST protocol status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "protocolStatusForGraphql": { - "type": "boolean", - "description": "GraphQL protocol status", - "x-example": true + "clientId": { + "type": "string", + "description": "OpenID Connect OAuth2 client ID.", + "x-example": "qibI2x0000000000000000000000000006L2YFoG" }, - "protocolStatusForWebsocket": { - "type": "boolean", - "description": "Websocket protocol status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "OpenID Connect OAuth2 client secret.", + "x-example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" }, - "region": { + "wellKnownURL": { "type": "string", - "description": "Project region", - "x-example": "fra" + "description": "OpenID Connect well-known configuration URL. When set, authorization, token, and user info endpoints can be discovered automatically.", + "x-example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" }, - "billingLimits": { - "type": "object", - "description": "Billing limits reached", - "x-example": "", - "items": { - "type": "object", - "$ref": "#\/definitions\/billingLimits" - } + "authorizationURL": { + "type": "string", + "description": "OpenID Connect authorization endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" }, - "blocks": { - "type": "array", - "description": "Project blocks information", - "items": { - "type": "object", - "$ref": "#\/definitions\/block" - }, - "x-example": "" + "tokenUrl": { + "type": "string", + "description": "OpenID Connect token endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/token" }, - "consoleAccessedAt": { + "userInfoUrl": { "type": "string", - "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "OpenID Connect user info endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "description", - "teamId", - "logo", - "url", - "legalName", - "legalCountry", - "legalState", - "legalCity", - "legalAddress", - "legalTaxId", - "authDuration", - "authLimit", - "authSessionsLimit", - "authPasswordHistory", - "authPasswordDictionary", - "authPersonalDataCheck", - "authDisposableEmails", - "authCanonicalEmails", - "authFreeEmails", - "authMockNumbers", - "authSessionAlerts", - "authMembershipsUserName", - "authMembershipsUserEmail", - "authMembershipsMfa", - "authMembershipsUserId", - "authMembershipsUserPhone", - "authInvalidateSessions", - "oAuthProviders", - "platforms", - "webhooks", - "keys", - "devKeys", - "smtpEnabled", - "smtpSenderName", - "smtpSenderEmail", - "smtpReplyToName", - "smtpReplyToEmail", - "smtpHost", - "smtpPort", - "smtpUsername", - "smtpPassword", - "smtpSecure", - "pingCount", - "pingedAt", - "labels", - "status", - "authEmailPassword", - "authUsersAuthMagicURL", - "authEmailOtp", - "authAnonymous", - "authInvites", - "authJWT", - "authPhone", - "serviceStatusForAccount", - "serviceStatusForAvatars", - "serviceStatusForDatabases", - "serviceStatusForTablesdb", - "serviceStatusForLocale", - "serviceStatusForHealth", - "serviceStatusForProject", - "serviceStatusForStorage", - "serviceStatusForTeams", - "serviceStatusForUsers", - "serviceStatusForVcs", - "serviceStatusForSites", - "serviceStatusForFunctions", - "serviceStatusForProxy", - "serviceStatusForGraphql", - "serviceStatusForMigrations", - "serviceStatusForMessaging", - "protocolStatusForRest", - "protocolStatusForGraphql", - "protocolStatusForWebsocket", - "region", - "billingLimits", - "blocks", - "consoleAccessedAt" + "enabled", + "clientId", + "clientSecret", + "wellKnownURL", + "authorizationURL", + "tokenUrl", + "userInfoUrl" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "New Project", - "description": "This is a new project.", - "teamId": "1592981250", - "logo": "5f5c451b403cb", - "url": "5f5c451b403cb", - "legalName": "Company LTD.", - "legalCountry": "US", - "legalState": "New York", - "legalCity": "New York City.", - "legalAddress": "620 Eighth Avenue, New York, NY 10018", - "legalTaxId": "131102020", - "authDuration": 60, - "authLimit": 100, - "authSessionsLimit": 10, - "authPasswordHistory": 5, - "authPasswordDictionary": true, - "authPersonalDataCheck": true, - "authDisposableEmails": true, - "authCanonicalEmails": true, - "authFreeEmails": true, - "authMockNumbers": [ - {} - ], - "authSessionAlerts": true, - "authMembershipsUserName": true, - "authMembershipsUserEmail": true, - "authMembershipsMfa": true, - "authMembershipsUserId": true, - "authMembershipsUserPhone": true, - "authInvalidateSessions": true, - "oAuthProviders": [ - {} - ], - "platforms": {}, - "webhooks": {}, - "keys": {}, - "devKeys": {}, - "smtpEnabled": false, - "smtpSenderName": "John Appwrite", - "smtpSenderEmail": "john@appwrite.io", - "smtpReplyToName": "Support Team", - "smtpReplyToEmail": "support@appwrite.io", - "smtpHost": "mail.appwrite.io", - "smtpPort": 25, - "smtpUsername": "emailuser", - "smtpPassword": "", - "smtpSecure": "tls", - "pingCount": 1, - "pingedAt": "2020-10-15T06:38:00.000+00:00", - "labels": [ - "vip" - ], - "status": "active", - "authEmailPassword": true, - "authUsersAuthMagicURL": true, - "authEmailOtp": true, - "authAnonymous": true, - "authInvites": true, - "authJWT": true, - "authPhone": true, - "serviceStatusForAccount": true, - "serviceStatusForAvatars": true, - "serviceStatusForDatabases": true, - "serviceStatusForTablesdb": true, - "serviceStatusForLocale": true, - "serviceStatusForHealth": true, - "serviceStatusForProject": true, - "serviceStatusForStorage": true, - "serviceStatusForTeams": true, - "serviceStatusForUsers": true, - "serviceStatusForVcs": true, - "serviceStatusForSites": true, - "serviceStatusForFunctions": true, - "serviceStatusForProxy": true, - "serviceStatusForGraphql": true, - "serviceStatusForMigrations": true, - "serviceStatusForMessaging": true, - "protocolStatusForRest": true, - "protocolStatusForGraphql": true, - "protocolStatusForWebsocket": true, - "region": "fra", - "billingLimits": "", - "blocks": "", - "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + "$id": "github", + "enabled": false, + "clientId": "qibI2x0000000000000000000000000006L2YFoG", + "clientSecret": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", + "wellKnownURL": "https:\/\/myoauth.com\/.well-known\/openid-configuration", + "authorizationURL": "https:\/\/myoauth.com\/oauth2\/authorize", + "tokenUrl": "https:\/\/myoauth.com\/oauth2\/token", + "userInfoUrl": "https:\/\/myoauth.com\/oauth2\/userinfo" } }, - "webhook": { - "description": "Webhook", + "oAuth2Okta": { + "description": "OAuth2Okta", "type": "object", "properties": { "$id": { "type": "string", - "description": "Webhook ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Webhook creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Webhook update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Okta OAuth2 client ID.", + "x-example": "0oa00000000000000698" }, - "name": { + "clientSecret": { "type": "string", - "description": "Webhook name.", - "x-example": "My Webhook" + "description": "Okta OAuth2 client secret.", + "x-example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" }, - "url": { + "domain": { "type": "string", - "description": "Webhook URL endpoint.", - "x-example": "https:\/\/example.com\/webhook" + "description": "Okta OAuth2 domain.", + "x-example": "trial-6400025.okta.com" }, - "events": { - "type": "array", - "description": "Webhook trigger events.", - "items": { - "type": "string" - }, - "x-example": [ - "databases.tables.update", - "databases.collections.update" - ] + "authorizationServerId": { + "type": "string", + "description": "Okta OAuth2 authorization server ID.", + "x-example": "aus000000000000000h7z" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "domain", + "authorizationServerId" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "0oa00000000000000698", + "clientSecret": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "domain": "trial-6400025.okta.com", + "authorizationServerId": "aus000000000000000h7z" + } + }, + "oAuth2Kick": { + "description": "OAuth2Kick", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "tls": { + "enabled": { "type": "boolean", - "description": "Indicates if SSL \/ TLS certificate verification is enabled.", - "x-example": true - }, - "authUsername": { - "type": "string", - "description": "HTTP basic authentication username.", - "x-example": "username" + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authPassword": { + "clientId": { "type": "string", - "description": "HTTP basic authentication password.", - "x-example": "password" + "description": "Kick OAuth2 client ID.", + "x-example": "01KQ7C00000000000001MFHS32" }, - "secret": { + "clientSecret": { "type": "string", - "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", - "x-example": "ad3d581ca230e2b7059c545e5a" + "description": "Kick OAuth2 client secret.", + "x-example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "01KQ7C00000000000001MFHS32", + "clientSecret": "34ac5600000000000000000000000000000000000000000000000000e830c8b" + } + }, + "oAuth2Apple": { + "description": "OAuth2Apple", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "apple" }, "enabled": { "type": "boolean", - "description": "Indicates if this webhook is enabled.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "logs": { + "serviceId": { "type": "string", - "description": "Webhook error logs from the most recent failure.", - "x-example": "Failed to connect to remote server." + "description": "Apple OAuth2 service ID.", + "x-example": "ip.appwrite.app.web" }, - "attempts": { - "type": "integer", - "description": "Number of consecutive failed webhook attempts.", - "x-example": 10, - "format": "int32" + "keyId": { + "type": "string", + "description": "Apple OAuth2 key ID.", + "x-example": "P4000000N8" + }, + "teamId": { + "type": "string", + "description": "Apple OAuth2 team ID.", + "x-example": "D4000000R6" + }, + "p8File": { + "type": "string", + "description": "Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.", + "x-example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "url", - "events", - "tls", - "authUsername", - "authPassword", - "secret", "enabled", - "logs", - "attempts" + "serviceId", + "keyId", + "teamId", + "p8File" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My Webhook", - "url": "https:\/\/example.com\/webhook", - "events": [ - "databases.tables.update", - "databases.collections.update" - ], - "tls": true, - "authUsername": "username", - "authPassword": "password", - "secret": "ad3d581ca230e2b7059c545e5a", - "enabled": true, - "logs": "Failed to connect to remote server.", - "attempts": 10 + "$id": "apple", + "enabled": false, + "serviceId": "ip.appwrite.app.web", + "keyId": "P4000000N8", + "teamId": "D4000000R6", + "p8File": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" } }, - "key": { - "description": "Key", + "oAuth2Microsoft": { + "description": "OAuth2Microsoft", "type": "object", "properties": { "$id": { "type": "string", - "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "applicationId": { "type": "string", - "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Microsoft OAuth2 application ID.", + "x-example": "00001111-aaaa-2222-bbbb-3333cccc4444" }, - "name": { + "applicationSecret": { "type": "string", - "description": "Key name.", - "x-example": "My API Key" + "description": "Microsoft OAuth2 application secret.", + "x-example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" }, - "expire": { + "tenant": { "type": "string", - "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID.", + "x-example": "common" + } + }, + "required": [ + "$id", + "enabled", + "applicationId", + "applicationSecret", + "tenant" + ], + "example": { + "$id": "github", + "enabled": false, + "applicationId": "00001111-aaaa-2222-bbbb-3333cccc4444", + "applicationSecret": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", + "tenant": "common" + } + }, + "oAuth2ProviderList": { + "description": "OAuth2 Providers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of OAuth2 providers in the given project.", + "x-example": 5, + "format": "int32" }, - "scopes": { + "providers": { "type": "array", - "description": "Allowed permission scopes.", + "description": "List of OAuth2 providers.", "items": { - "type": "string" + "x-anyOf": [ + { + "$ref": "#\/definitions\/oAuth2Github" + }, + { + "$ref": "#\/definitions\/oAuth2Discord" + }, + { + "$ref": "#\/definitions\/oAuth2Figma" + }, + { + "$ref": "#\/definitions\/oAuth2Dropbox" + }, + { + "$ref": "#\/definitions\/oAuth2Dailymotion" + }, + { + "$ref": "#\/definitions\/oAuth2Bitbucket" + }, + { + "$ref": "#\/definitions\/oAuth2Bitly" + }, + { + "$ref": "#\/definitions\/oAuth2Box" + }, + { + "$ref": "#\/definitions\/oAuth2Autodesk" + }, + { + "$ref": "#\/definitions\/oAuth2Google" + }, + { + "$ref": "#\/definitions\/oAuth2Zoom" + }, + { + "$ref": "#\/definitions\/oAuth2Zoho" + }, + { + "$ref": "#\/definitions\/oAuth2Yandex" + }, + { + "$ref": "#\/definitions\/oAuth2X" + }, + { + "$ref": "#\/definitions\/oAuth2WordPress" + }, + { + "$ref": "#\/definitions\/oAuth2Twitch" + }, + { + "$ref": "#\/definitions\/oAuth2Stripe" + }, + { + "$ref": "#\/definitions\/oAuth2Spotify" + }, + { + "$ref": "#\/definitions\/oAuth2Slack" + }, + { + "$ref": "#\/definitions\/oAuth2Podio" + }, + { + "$ref": "#\/definitions\/oAuth2Notion" + }, + { + "$ref": "#\/definitions\/oAuth2Salesforce" + }, + { + "$ref": "#\/definitions\/oAuth2Yahoo" + }, + { + "$ref": "#\/definitions\/oAuth2Linkedin" + }, + { + "$ref": "#\/definitions\/oAuth2Disqus" + }, + { + "$ref": "#\/definitions\/oAuth2Amazon" + }, + { + "$ref": "#\/definitions\/oAuth2Etsy" + }, + { + "$ref": "#\/definitions\/oAuth2Facebook" + }, + { + "$ref": "#\/definitions\/oAuth2Tradeshift" + }, + { + "$ref": "#\/definitions\/oAuth2Paypal" + }, + { + "$ref": "#\/definitions\/oAuth2Gitlab" + }, + { + "$ref": "#\/definitions\/oAuth2Authentik" + }, + { + "$ref": "#\/definitions\/oAuth2Auth0" + }, + { + "$ref": "#\/definitions\/oAuth2FusionAuth" + }, + { + "$ref": "#\/definitions\/oAuth2Keycloak" + }, + { + "$ref": "#\/definitions\/oAuth2Oidc" + }, + { + "$ref": "#\/definitions\/oAuth2Apple" + }, + { + "$ref": "#\/definitions\/oAuth2Okta" + }, + { + "$ref": "#\/definitions\/oAuth2Kick" + }, + { + "$ref": "#\/definitions\/oAuth2Microsoft" + } + ], + "x-discriminator": { + "propertyName": "$id", + "mapping": { + "github": "#\/definitions\/oAuth2Github", + "discord": "#\/definitions\/oAuth2Discord", + "figma": "#\/definitions\/oAuth2Figma", + "dropbox": "#\/definitions\/oAuth2Dropbox", + "dailymotion": "#\/definitions\/oAuth2Dailymotion", + "bitbucket": "#\/definitions\/oAuth2Bitbucket", + "bitly": "#\/definitions\/oAuth2Bitly", + "box": "#\/definitions\/oAuth2Box", + "autodesk": "#\/definitions\/oAuth2Autodesk", + "google": "#\/definitions\/oAuth2Google", + "zoom": "#\/definitions\/oAuth2Zoom", + "zoho": "#\/definitions\/oAuth2Zoho", + "yandex": "#\/definitions\/oAuth2Yandex", + "x": "#\/definitions\/oAuth2X", + "wordpress": "#\/definitions\/oAuth2WordPress", + "twitch": "#\/definitions\/oAuth2Twitch", + "stripe": "#\/definitions\/oAuth2Stripe", + "spotify": "#\/definitions\/oAuth2Spotify", + "slack": "#\/definitions\/oAuth2Slack", + "podio": "#\/definitions\/oAuth2Podio", + "notion": "#\/definitions\/oAuth2Notion", + "salesforce": "#\/definitions\/oAuth2Salesforce", + "yahoo": "#\/definitions\/oAuth2Yahoo", + "linkedin": "#\/definitions\/oAuth2Linkedin", + "disqus": "#\/definitions\/oAuth2Disqus", + "amazon": "#\/definitions\/oAuth2Amazon", + "etsy": "#\/definitions\/oAuth2Etsy", + "facebook": "#\/definitions\/oAuth2Facebook", + "tradeshift": "#\/definitions\/oAuth2Tradeshift", + "tradeshiftBox": "#\/definitions\/oAuth2Tradeshift", + "paypal": "#\/definitions\/oAuth2Paypal", + "paypalSandbox": "#\/definitions\/oAuth2Paypal", + "gitlab": "#\/definitions\/oAuth2Gitlab", + "authentik": "#\/definitions\/oAuth2Authentik", + "auth0": "#\/definitions\/oAuth2Auth0", + "fusionauth": "#\/definitions\/oAuth2FusionAuth", + "keycloak": "#\/definitions\/oAuth2Keycloak", + "oidc": "#\/definitions\/oAuth2Oidc", + "apple": "#\/definitions\/oAuth2Apple", + "okta": "#\/definitions\/oAuth2Okta", + "kick": "#\/definitions\/oAuth2Kick", + "microsoft": "#\/definitions\/oAuth2Microsoft" + } + } }, - "x-example": "users.read" - }, - "secret": { - "type": "string", - "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" - }, - "accessedAt": { + "x-example": "" + } + }, + "required": [ + "total", + "providers" + ], + "example": { + "total": 5, + "providers": "" + } + }, + "policyPasswordDictionary": { + "description": "Policy Password Dictionary", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "sdks": { - "type": "array", - "description": "List of SDK user agents that used this key.", - "items": { - "type": "string" - }, - "x-example": "appwrite:flutter" + "enabled": { + "type": "boolean", + "description": "Whether password dictionary policy is enabled.", + "x-example": true } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "expire", - "scopes", - "secret", - "accessedAt", - "sdks" + "enabled" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My API Key", - "expire": "2020-10-15T06:38:00.000+00:00", - "scopes": "users.read", - "secret": "919c2d18fb5d4...a2ae413da83346ad2", - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "sdks": "appwrite:flutter" + "$id": "password-dictionary", + "enabled": true } }, - "devKey": { - "description": "DevKey", + "policyPasswordHistory": { + "description": "Policy Password History", "type": "object", "properties": { "$id": { "type": "string", - "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "$createdAt": { + "total": { + "type": "integer", + "description": "Password history length. A value of 0 means the policy is disabled.", + "x-example": 5, + "format": "int32" + } + }, + "required": [ + "$id", + "total" + ], + "example": { + "$id": "password-dictionary", + "total": 5 + } + }, + "policyPasswordPersonalData": { + "description": "Policy Password Personal Data", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "$updatedAt": { + "enabled": { + "type": "boolean", + "description": "Whether password personal data policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionAlert": { + "description": "Policy Session Alert", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "name": { + "enabled": { + "type": "boolean", + "description": "Whether session alert policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionDuration": { + "description": "Policy Session Duration", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key name.", - "x-example": "Dev API Key" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "expire": { + "duration": { + "type": "integer", + "description": "Session duration in seconds.", + "x-example": 3600, + "format": "int32" + } + }, + "required": [ + "$id", + "duration" + ], + "example": { + "$id": "password-dictionary", + "duration": 3600 + } + }, + "policySessionInvalidation": { + "description": "Policy Session Invalidation", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "secret": { + "enabled": { + "type": "boolean", + "description": "Whether session invalidation policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionLimit": { + "description": "Policy Session Limit", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "accessedAt": { + "total": { + "type": "integer", + "description": "Maximum number of sessions allowed per user. A value of 0 means the policy is disabled.", + "x-example": 10, + "format": "int32" + } + }, + "required": [ + "$id", + "total" + ], + "example": { + "$id": "password-dictionary", + "total": 10 + } + }, + "policyUserLimit": { + "description": "Policy User Limit", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "sdks": { - "type": "array", - "description": "List of SDK user agents that used this key.", - "items": { - "type": "string" - }, - "x-example": "appwrite:flutter" + "total": { + "type": "integer", + "description": "Maximum number of users allowed in the project. A value of 0 means the policy is disabled.", + "x-example": 100, + "format": "int32" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "expire", - "secret", - "accessedAt", - "sdks" + "total" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "Dev API Key", - "expire": "2020-10-15T06:38:00.000+00:00", - "secret": "919c2d18fb5d4...a2ae413da83346ad2", - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "sdks": "appwrite:flutter" + "$id": "password-dictionary", + "total": 100 } }, - "mockNumber": { - "description": "Mock Number", + "policyMembershipPrivacy": { + "description": "Policy Membership Privacy", "type": "object", "properties": { - "phone": { + "$id": { "type": "string", - "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", - "x-example": "+1612842323" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "otp": { - "type": "string", - "description": "Mock OTP for the number. ", - "x-example": "123456" + "userId": { + "type": "boolean", + "description": "Whether user ID is visible in memberships.", + "x-example": true + }, + "userEmail": { + "type": "boolean", + "description": "Whether user email is visible in memberships.", + "x-example": true + }, + "userPhone": { + "type": "boolean", + "description": "Whether user phone is visible in memberships.", + "x-example": true + }, + "userName": { + "type": "boolean", + "description": "Whether user name is visible in memberships.", + "x-example": true + }, + "userMFA": { + "type": "boolean", + "description": "Whether user MFA status is visible in memberships.", + "x-example": true } }, "required": [ - "phone", - "otp" + "$id", + "userId", + "userEmail", + "userPhone", + "userName", + "userMFA" ], "example": { - "phone": "+1612842323", - "otp": "123456" + "$id": "password-dictionary", + "userId": true, + "userEmail": true, + "userPhone": true, + "userName": true, + "userMFA": true } }, "authProvider": { @@ -80295,8 +87518,8 @@ }, "secret": { "type": "string", - "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.", - "x-example": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ" + "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.", + "x-example": "" }, "enabled": { "type": "boolean", @@ -80315,7 +87538,7 @@ "key": "github", "name": "GitHub", "appId": "259125845563242502", - "secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ", + "secret": "", "enabled": "" } }, @@ -84091,6 +91314,168 @@ "_APP_CONSOLE_EMAIL_VERIFICATION": "true" } }, + "consoleOAuth2ProviderParameter": { + "description": "Console OAuth2 Provider Parameter", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Parameter ID. Maps to the request body field used by the project OAuth2 update endpoint (e.g. `clientId`, `appKey`, `tenant`).", + "x-example": "clientId" + }, + "name": { + "type": "string", + "description": "Verbose, user-facing parameter name as shown in the provider's own dashboard. Includes alternate names when the provider exposes more than one.", + "x-example": "Client ID or App ID" + }, + "example": { + "type": "string", + "description": "Example value for this parameter.", + "x-example": "e4d87900000000540733" + }, + "hint": { + "type": "string", + "description": "Optional hint for this parameter, typically calling out a common wrong value. Empty string when no hint is set.", + "x-example": "Example of wrong value: 370006" + } + }, + "required": [ + "$id", + "name", + "example", + "hint" + ], + "example": { + "$id": "clientId", + "name": "Client ID or App ID", + "example": "e4d87900000000540733", + "hint": "Example of wrong value: 370006" + } + }, + "consoleOAuth2Provider": { + "description": "Console OAuth2 Provider", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" + }, + "parameters": { + "type": "array", + "description": "List of parameters required to configure this OAuth2 provider.", + "items": { + "type": "object", + "$ref": "#\/definitions\/consoleOAuth2ProviderParameter" + }, + "x-example": "" + } + }, + "required": [ + "$id", + "parameters" + ], + "example": { + "$id": "github", + "parameters": "" + } + }, + "consoleOAuth2ProviderList": { + "description": "Console OAuth2 Providers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of OAuth2 providers exposed by the server.", + "x-example": 5, + "format": "int32" + }, + "oAuth2Providers": { + "type": "array", + "description": "List of OAuth2 providers, each with the parameters required to configure it.", + "items": { + "type": "object", + "$ref": "#\/definitions\/consoleOAuth2Provider" + }, + "x-example": "" + } + }, + "required": [ + "total", + "oAuth2Providers" + ], + "example": { + "total": 5, + "oAuth2Providers": "" + } + }, + "consoleKeyScope": { + "description": "Console Key Scope", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Scope ID.", + "x-example": "users.read" + }, + "description": { + "type": "string", + "description": "Scope description.", + "x-example": "Access to read your project's users" + }, + "category": { + "type": "string", + "description": "Scope category.", + "x-example": "Auth" + }, + "deprecated": { + "type": "boolean", + "description": "Scope is deprecated.", + "x-example": true + } + }, + "required": [ + "$id", + "description", + "category", + "deprecated" + ], + "example": { + "$id": "users.read", + "description": "Access to read your project's users", + "category": "Auth", + "deprecated": true + } + }, + "consoleKeyScopeList": { + "description": "Console Key Scopes List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of key scopes exposed by the server.", + "x-example": 5, + "format": "int32" + }, + "scopes": { + "type": "array", + "description": "List of key scopes, each with its ID and description.", + "items": { + "type": "object", + "$ref": "#\/definitions\/consoleKeyScope" + }, + "x-example": "" + } + }, + "required": [ + "total", + "scopes" + ], + "example": { + "total": 5, + "scopes": "" + } + }, "mfaChallenge": { "description": "MFA Challenge", "type": "object", @@ -86483,19 +93868,83 @@ "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", "x-example": "2020-10-15T06:38:00.000+00:00", "x-nullable": true + }, + "projectName": { + "type": "string", + "description": "Name of the project this block applies to.", + "x-example": "My Project" + }, + "region": { + "type": "string", + "description": "Region of the project this block applies to.", + "x-example": "fra" + }, + "organizationName": { + "type": "string", + "description": "Name of the organization that owns the project.", + "x-example": "Acme Inc." + }, + "organizationId": { + "type": "string", + "description": "ID of the organization that owns the project.", + "x-example": "5e5ea5c16897e" + }, + "billingPlan": { + "type": "string", + "description": "Billing plan of the organization that owns the project.", + "x-example": "pro" } }, "required": [ "$createdAt", "resourceType", - "resourceId" + "resourceId", + "projectName", + "region", + "organizationName", + "organizationId", + "billingPlan" ], "example": { "$createdAt": "2020-10-15T06:38:00.000+00:00", "resourceType": "project", "resourceId": "5e5ea5c16897e", "reason": "Payment overdue", - "expiredAt": "2020-10-15T06:38:00.000+00:00" + "expiredAt": "2020-10-15T06:38:00.000+00:00", + "projectName": "My Project", + "region": "fra", + "organizationName": "Acme Inc.", + "organizationId": "5e5ea5c16897e", + "billingPlan": "pro" + } + }, + "blockDelete": { + "description": "BlockDelete", + "type": "object", + "properties": { + "deleted": { + "type": "integer", + "description": "Number of blocks deleted", + "x-example": 1, + "format": "int32" + }, + "blocks": { + "type": "array", + "description": "List of deleted blocks", + "items": { + "type": "object", + "$ref": "#\/definitions\/block" + }, + "x-example": [] + } + }, + "required": [ + "deleted", + "blocks" + ], + "example": { + "deleted": 1, + "blocks": [] } }, "campaign": { @@ -87078,6 +94527,11 @@ "description": "Invoice status", "x-example": "succeeded" }, + "type": { + "type": "string", + "description": "Invoice type. Can be one of `subscription`, `domain_purchase`, `domain_renewal`, `domain_transfer`, or `addon_*`.", + "x-example": "subscription" + }, "lastError": { "type": "string", "description": "Last payment error associated with the invoice", @@ -87118,6 +94572,7 @@ "currency", "clientSecret", "status", + "type", "lastError", "dueAt", "from", @@ -87144,6 +94599,7 @@ "currency": "USD", "clientSecret": "pi_daslfasdfkla_asdkfl", "status": "succeeded", + "type": "subscription", "lastError": "Your card has insufficient balance.", "dueAt": "2020-10-15T06:38:00.000+00:00", "from": "2020-10-15T06:38:00.000+00:00", @@ -89102,6 +96558,329 @@ "organizationCredits": 0 } }, + "estimationPlanChange": { + "description": "EstimationPlanChange", + "type": "object", + "properties": { + "currentBillingPlanId": { + "type": "string", + "description": "Current billing plan ID", + "x-example": "tier-2" + }, + "targetBillingPlanId": { + "type": "string", + "description": "Target billing plan ID", + "x-example": "tier-0" + }, + "direction": { + "type": "string", + "description": "Direction of plan change: upgrade, downgrade, or same", + "x-example": "downgrade" + }, + "estimation": { + "type": "object", + "description": "Cost estimation details", + "x-example": null, + "items": { + "type": "object", + "$ref": "#\/definitions\/planChangeEstimationDetails" + } + }, + "limits": { + "type": "object", + "description": "Plan limits and compliance information", + "x-example": null, + "items": { + "type": "object", + "$ref": "#\/definitions\/planChangeLimits" + } + } + }, + "required": [ + "currentBillingPlanId", + "targetBillingPlanId", + "direction", + "estimation", + "limits" + ], + "example": { + "currentBillingPlanId": "tier-2", + "targetBillingPlanId": "tier-0", + "direction": "downgrade", + "estimation": null, + "limits": null + } + }, + "planChangeEstimationDetails": { + "description": "PlanChangeEstimationDetails", + "type": "object", + "properties": { + "currency": { + "type": "string", + "description": "Currency code", + "x-example": "USD" + }, + "grossAmount": { + "type": "number", + "description": "Gross amount after all discounts and credits", + "x-example": 15, + "format": "double" + }, + "credits": { + "type": "number", + "description": "Credits applied from coupon", + "x-example": 0, + "format": "double" + }, + "organizationCredits": { + "type": "number", + "description": "Organization's existing credits applied", + "x-example": 5, + "format": "double" + }, + "discount": { + "type": "number", + "description": "Discount amount from prorated invoices", + "x-example": 0, + "format": "double" + }, + "amount": { + "type": "number", + "description": "Total amount before discounts and credits", + "x-example": 20, + "format": "double" + }, + "nextInvoiceDate": { + "type": "string", + "description": "Next invoice date", + "x-example": "2025-12-01T00:00:00.000Z" + }, + "items": { + "type": "object", + "additionalProperties": true, + "description": "Line items breakdown", + "x-example": [ + { + "label": "Starter plan", + "value": 0 + }, + { + "label": "Additional seats", + "value": 10 + } + ] + }, + "discounts": { + "type": "object", + "additionalProperties": true, + "description": "Applied discounts breakdown", + "x-example": [ + { + "label": "Organization credits", + "value": 5 + } + ] + } + }, + "required": [ + "currency", + "grossAmount", + "credits", + "organizationCredits", + "discount", + "amount", + "nextInvoiceDate", + "items", + "discounts" + ], + "example": { + "currency": "USD", + "grossAmount": 15, + "credits": 0, + "organizationCredits": 5, + "discount": 0, + "amount": 20, + "nextInvoiceDate": "2025-12-01T00:00:00.000Z", + "items": [ + { + "label": "Starter plan", + "value": 0 + }, + { + "label": "Additional seats", + "value": 10 + } + ], + "discounts": [ + { + "label": "Organization credits", + "value": 5 + } + ] + } + }, + "planChangeLimits": { + "description": "PlanChangeLimits", + "type": "object", + "properties": { + "totalProjects": { + "type": "integer", + "description": "Total number of projects in the organization", + "x-example": 5, + "format": "int32" + }, + "nonCompliantProjects": { + "type": "integer", + "description": "Number of projects exceeding target plan limits", + "x-example": 2, + "format": "int32" + }, + "canChangePlan": { + "type": "boolean", + "description": "Whether the plan change is allowed", + "x-example": false + }, + "projects": { + "type": "array", + "description": "Project compliance details", + "items": { + "type": "object", + "$ref": "#\/definitions\/planChangeProjectCompliance" + }, + "x-example": [] + }, + "unsupportedAddons": { + "type": "array", + "description": "Active addon keys that the target plan does not support. When non-empty, `canChangePlan` is false.", + "items": { + "type": "string" + }, + "x-example": [ + "baa" + ] + } + }, + "required": [ + "totalProjects", + "nonCompliantProjects", + "canChangePlan", + "projects", + "unsupportedAddons" + ], + "example": { + "totalProjects": 5, + "nonCompliantProjects": 2, + "canChangePlan": false, + "projects": [], + "unsupportedAddons": [ + "baa" + ] + } + }, + "planChangeProjectCompliance": { + "description": "PlanChangeProjectCompliance", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Project ID", + "x-example": "proj_a" + }, + "name": { + "type": "string", + "description": "Project name", + "x-example": "Marketing Site" + }, + "isCompliant": { + "type": "boolean", + "description": "Whether the project complies with target plan limits", + "x-example": false + }, + "resources": { + "type": "array", + "description": "Resource compliance details", + "items": { + "type": "object", + "$ref": "#\/definitions\/planChangeResourceCompliance" + }, + "x-example": [] + }, + "error": { + "type": "string", + "description": "Failure reason when compliance could not be evaluated. Present only when the project DB or Regions API was unreachable; in that case `isCompliant` is false (fail closed) and `resources` is empty.", + "x-example": "Failed to get project compliance from Regions API. Status: 500", + "x-nullable": true + } + }, + "required": [ + "$id", + "name", + "isCompliant", + "resources" + ], + "example": { + "$id": "proj_a", + "name": "Marketing Site", + "isCompliant": false, + "resources": [], + "error": "Failed to get project compliance from Regions API. Status: 500" + } + }, + "planChangeResourceCompliance": { + "description": "PlanChangeResourceCompliance", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Resource type", + "x-example": "databases" + }, + "currentUsage": { + "type": "integer", + "description": "Current usage count", + "x-example": 3, + "format": "int32" + }, + "limit": { + "type": "integer", + "description": "Allowed limit in target plan", + "x-example": 1, + "format": "int32" + }, + "status": { + "type": "string", + "description": "Compliance status", + "x-example": "over_limit" + }, + "excess": { + "type": "integer", + "description": "Number of resources exceeding the limit", + "x-example": 2, + "format": "int32" + }, + "resolutionHint": { + "type": "string", + "description": "Suggestion for resolving the compliance issue", + "x-example": "Delete or migrate 2 databases." + } + }, + "required": [ + "type", + "currentUsage", + "limit", + "status", + "excess", + "resolutionHint" + ], + "example": { + "type": "databases", + "currentUsage": 3, + "limit": 1, + "status": "over_limit", + "excess": 2, + "resolutionHint": "Delete or migrate 2 databases." + } + }, "estimationDeleteOrganization": { "description": "EstimationDeleteOrganization", "type": "object", @@ -89778,6 +97557,35 @@ "paymentMethods": "" } }, + "blockList": { + "description": "Blocks list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of blocks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "blocks": { + "type": "array", + "description": "List of blocks.", + "items": { + "type": "object", + "$ref": "#\/definitions\/block" + }, + "x-example": "" + } + }, + "required": [ + "total", + "blocks" + ], + "example": { + "total": 5, + "blocks": "" + } + }, "consoleRegionList": { "description": "Regions list", "type": "object", diff --git a/specs/1.9.x/swagger2-1.9.x-server.json b/specs/1.9.x/swagger2-1.9.x-server.json index b92695368..24c93ef0b 100644 --- a/specs/1.9.x/swagger2-1.9.x-server.json +++ b/specs/1.9.x/swagger2-1.9.x-server.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.9.2", + "version": "1.9.3", "title": "Appwrite", "description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)", "termsOfService": "https:\/\/appwrite.io\/policy\/terms", @@ -646,7 +646,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 187, + "weight": 166, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -722,7 +722,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 189, + "weight": 168, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -849,7 +849,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 190, + "weight": 169, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -993,7 +993,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 191, + "weight": 170, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1120,7 +1120,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 195, + "weight": 174, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1260,7 +1260,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 196, + "weight": 175, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1403,7 +1403,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 188, + "weight": 167, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1507,7 +1507,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 194, + "weight": 173, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1611,7 +1611,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 192, + "weight": 171, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1715,7 +1715,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 193, + "weight": 172, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -3332,7 +3332,7 @@ "parameters": [ { "name": "provider", - "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", + "description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.", "required": true, "type": "string", "x-example": "amazon", @@ -3352,9 +3352,12 @@ "etsy", "facebook", "figma", + "fusionauth", "github", "gitlab", "google", + "keycloak", + "kick", "linkedin", "microsoft", "notion", @@ -3938,7 +3941,7 @@ "x-appwrite": { "method": "listEvents", "group": null, - "weight": 1071, + "weight": 1184, "cookies": false, "type": "", "demo": "activities\/list-events.md", @@ -4000,7 +4003,7 @@ "x-appwrite": { "method": "getEvent", "group": "events", - "weight": 1072, + "weight": 1185, "cookies": false, "type": "", "demo": "activities\/get-event.md", @@ -4062,7 +4065,7 @@ "x-appwrite": { "method": "getBrowser", "group": null, - "weight": 198, + "weight": 177, "cookies": false, "type": "location", "demo": "avatars\/get-browser.md", @@ -4190,7 +4193,7 @@ "x-appwrite": { "method": "getCreditCard", "group": null, - "weight": 197, + "weight": 176, "cookies": false, "type": "location", "demo": "avatars\/get-credit-card.md", @@ -4324,7 +4327,7 @@ "x-appwrite": { "method": "getFavicon", "group": null, - "weight": 201, + "weight": 180, "cookies": false, "type": "location", "demo": "avatars\/get-favicon.md", @@ -4390,7 +4393,7 @@ "x-appwrite": { "method": "getFlag", "group": null, - "weight": 199, + "weight": 178, "cookies": false, "type": "location", "demo": "avatars\/get-flag.md", @@ -4880,7 +4883,7 @@ "x-appwrite": { "method": "getImage", "group": null, - "weight": 200, + "weight": 179, "cookies": false, "type": "location", "demo": "avatars\/get-image.md", @@ -4966,7 +4969,7 @@ "x-appwrite": { "method": "getInitials", "group": null, - "weight": 203, + "weight": 182, "cookies": false, "type": "location", "demo": "avatars\/get-initials.md", @@ -5060,7 +5063,7 @@ "x-appwrite": { "method": "getQR", "group": null, - "weight": 202, + "weight": 181, "cookies": false, "type": "location", "demo": "avatars\/get-qr.md", @@ -5154,7 +5157,7 @@ "x-appwrite": { "method": "getScreenshot", "group": null, - "weight": 204, + "weight": 183, "cookies": false, "type": "location", "demo": "avatars\/get-screenshot.md", @@ -5869,7 +5872,7 @@ "x-appwrite": { "method": "listArchives", "group": null, - "weight": 997, + "weight": 1055, "cookies": false, "type": "", "demo": "backups\/list-archives.md", @@ -5935,7 +5938,7 @@ "x-appwrite": { "method": "createArchive", "group": null, - "weight": 998, + "weight": 1056, "cookies": false, "type": "", "demo": "backups\/create-archive.md", @@ -6027,7 +6030,7 @@ "x-appwrite": { "method": "getArchive", "group": null, - "weight": 996, + "weight": 1054, "cookies": false, "type": "", "demo": "backups\/get-archive.md", @@ -6086,7 +6089,7 @@ "x-appwrite": { "method": "deleteArchive", "group": null, - "weight": 999, + "weight": 1057, "cookies": false, "type": "", "demo": "backups\/delete-archive.md", @@ -6148,7 +6151,7 @@ "x-appwrite": { "method": "listPolicies", "group": null, - "weight": 992, + "weight": 1050, "cookies": false, "type": "", "demo": "backups\/list-policies.md", @@ -6214,7 +6217,7 @@ "x-appwrite": { "method": "createPolicy", "group": null, - "weight": 993, + "weight": 1051, "cookies": false, "type": "", "demo": "backups\/create-policy.md", @@ -6340,7 +6343,7 @@ "x-appwrite": { "method": "getPolicy", "group": null, - "weight": 991, + "weight": 1049, "cookies": false, "type": "", "demo": "backups\/get-policy.md", @@ -6402,7 +6405,7 @@ "x-appwrite": { "method": "updatePolicy", "group": null, - "weight": 994, + "weight": 1052, "cookies": false, "type": "", "demo": "backups\/update-policy.md", @@ -6498,7 +6501,7 @@ "x-appwrite": { "method": "deletePolicy", "group": null, - "weight": 995, + "weight": 1053, "cookies": false, "type": "", "demo": "backups\/delete-policy.md", @@ -6562,7 +6565,7 @@ "x-appwrite": { "method": "createRestoration", "group": null, - "weight": 1002, + "weight": 1060, "cookies": false, "type": "", "demo": "backups\/create-restoration.md", @@ -6666,7 +6669,7 @@ "x-appwrite": { "method": "listRestorations", "group": null, - "weight": 1001, + "weight": 1059, "cookies": false, "type": "", "demo": "backups\/list-restorations.md", @@ -6732,7 +6735,7 @@ "x-appwrite": { "method": "getRestoration", "group": null, - "weight": 1000, + "weight": 1058, "cookies": false, "type": "", "demo": "backups\/get-restoration.md", @@ -6794,7 +6797,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 635, + "weight": 687, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6912,7 +6915,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 631, + "weight": 683, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -7034,7 +7037,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 703, + "weight": 755, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -7103,7 +7106,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 699, + "weight": 751, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -7176,7 +7179,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 700, + "weight": 752, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -7241,7 +7244,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 701, + "weight": 753, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -7322,7 +7325,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 702, + "weight": 754, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -7389,7 +7392,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 704, + "weight": 756, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -7472,7 +7475,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 632, + "weight": 684, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7568,7 +7571,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 633, + "weight": 685, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7682,7 +7685,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 634, + "weight": 686, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7777,7 +7780,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 643, + "weight": 695, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7873,7 +7876,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 639, + "weight": 691, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -8004,7 +8007,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 640, + "weight": 692, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -8078,7 +8081,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 641, + "weight": 693, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -8190,7 +8193,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 642, + "weight": 694, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -8264,7 +8267,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 660, + "weight": 712, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -8361,7 +8364,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 661, + "weight": 713, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -8475,7 +8478,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 662, + "weight": 714, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -8591,7 +8594,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 663, + "weight": 715, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -8706,7 +8709,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 664, + "weight": 716, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -8823,7 +8826,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 665, + "weight": 717, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -8938,7 +8941,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 666, + "weight": 718, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -9055,7 +9058,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 667, + "weight": 719, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -9179,7 +9182,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 668, + "weight": 720, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -9305,7 +9308,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 669, + "weight": 721, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -9436,7 +9439,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 670, + "weight": 722, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9569,7 +9572,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 671, + "weight": 723, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9700,7 +9703,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 672, + "weight": 724, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9833,7 +9836,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 673, + "weight": 725, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9947,7 +9950,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 674, + "weight": 726, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -10063,7 +10066,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 675, + "weight": 727, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -10171,7 +10174,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 676, + "weight": 728, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -10286,7 +10289,7 @@ "x-appwrite": { "method": "createLongtextAttribute", "group": "attributes", - "weight": 693, + "weight": 745, "cookies": false, "type": "", "demo": "databases\/create-longtext-attribute.md", @@ -10402,7 +10405,7 @@ "x-appwrite": { "method": "updateLongtextAttribute", "group": "attributes", - "weight": 694, + "weight": 746, "cookies": false, "type": "", "demo": "databases\/update-longtext-attribute.md", @@ -10514,7 +10517,7 @@ "x-appwrite": { "method": "createMediumtextAttribute", "group": "attributes", - "weight": 691, + "weight": 743, "cookies": false, "type": "", "demo": "databases\/create-mediumtext-attribute.md", @@ -10630,7 +10633,7 @@ "x-appwrite": { "method": "updateMediumtextAttribute", "group": "attributes", - "weight": 692, + "weight": 744, "cookies": false, "type": "", "demo": "databases\/update-mediumtext-attribute.md", @@ -10742,7 +10745,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 677, + "weight": 729, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -10850,7 +10853,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 678, + "weight": 730, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -10965,7 +10968,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 679, + "weight": 731, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -11073,7 +11076,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 680, + "weight": 732, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -11188,7 +11191,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 681, + "weight": 733, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -11330,7 +11333,7 @@ "x-appwrite": { "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 682, + "weight": 734, "cookies": false, "type": "", "demo": "databases\/update-relationship-attribute.md", @@ -11442,7 +11445,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 683, + "weight": 735, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -11570,7 +11573,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 684, + "weight": 736, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -11694,7 +11697,7 @@ "x-appwrite": { "method": "createTextAttribute", "group": "attributes", - "weight": 689, + "weight": 741, "cookies": false, "type": "", "demo": "databases\/create-text-attribute.md", @@ -11810,7 +11813,7 @@ "x-appwrite": { "method": "updateTextAttribute", "group": "attributes", - "weight": 690, + "weight": 742, "cookies": false, "type": "", "demo": "databases\/update-text-attribute.md", @@ -11922,7 +11925,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 685, + "weight": 737, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -12037,7 +12040,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 686, + "weight": 738, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -12154,7 +12157,7 @@ "x-appwrite": { "method": "createVarcharAttribute", "group": "attributes", - "weight": 687, + "weight": 739, "cookies": false, "type": "", "demo": "databases\/create-varchar-attribute.md", @@ -12278,7 +12281,7 @@ "x-appwrite": { "method": "updateVarcharAttribute", "group": "attributes", - "weight": 688, + "weight": 740, "cookies": false, "type": "", "demo": "databases\/update-varchar-attribute.md", @@ -12478,7 +12481,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 658, + "weight": 710, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -12554,7 +12557,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 659, + "weight": 711, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -12635,7 +12638,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 654, + "weight": 897, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -12751,7 +12754,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 646, + "weight": 698, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -12946,7 +12949,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 651, + "weight": 703, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -13083,7 +13086,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 649, + "weight": 701, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -13188,7 +13191,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 653, + "weight": 705, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -13287,7 +13290,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 647, + "weight": 699, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -13392,7 +13395,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 650, + "weight": 702, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -13546,7 +13549,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 648, + "weight": 700, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -13658,7 +13661,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 652, + "weight": 704, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -13761,7 +13764,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 657, + "weight": 709, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -13886,7 +13889,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 656, + "weight": 708, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -14009,7 +14012,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 698, + "weight": 750, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -14104,7 +14107,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 695, + "weight": 747, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -14245,7 +14248,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 696, + "weight": 748, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -14321,7 +14324,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 697, + "weight": 749, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -14402,7 +14405,7 @@ "x-appwrite": { "method": "list", "group": "documentsdb", - "weight": 782, + "weight": 834, "cookies": false, "type": "", "demo": "documentsdb\/list.md", @@ -14486,7 +14489,7 @@ "x-appwrite": { "method": "create", "group": "documentsdb", - "weight": 778, + "weight": 830, "cookies": false, "type": "", "demo": "documentsdb\/create.md", @@ -14571,7 +14574,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 810, + "weight": 862, "cookies": false, "type": "", "demo": "documentsdb\/list-transactions.md", @@ -14640,7 +14643,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 806, + "weight": 858, "cookies": false, "type": "", "demo": "documentsdb\/create-transaction.md", @@ -14713,7 +14716,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 807, + "weight": 859, "cookies": false, "type": "", "demo": "documentsdb\/get-transaction.md", @@ -14778,7 +14781,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 808, + "weight": 860, "cookies": false, "type": "", "demo": "documentsdb\/update-transaction.md", @@ -14859,7 +14862,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 809, + "weight": 861, "cookies": false, "type": "", "demo": "documentsdb\/delete-transaction.md", @@ -14926,7 +14929,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 811, + "weight": 863, "cookies": false, "type": "", "demo": "documentsdb\/create-operations.md", @@ -15008,7 +15011,7 @@ "x-appwrite": { "method": "get", "group": "documentsdb", - "weight": 779, + "weight": 831, "cookies": false, "type": "", "demo": "documentsdb\/get.md", @@ -15070,7 +15073,7 @@ "x-appwrite": { "method": "update", "group": "documentsdb", - "weight": 780, + "weight": 832, "cookies": false, "type": "", "demo": "documentsdb\/update.md", @@ -15151,7 +15154,7 @@ "x-appwrite": { "method": "delete", "group": "documentsdb", - "weight": 781, + "weight": 833, "cookies": false, "type": "", "demo": "documentsdb\/delete.md", @@ -15213,7 +15216,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 789, + "weight": 841, "cookies": false, "type": "", "demo": "documentsdb\/list-collections.md", @@ -15305,7 +15308,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 785, + "weight": 837, "cookies": false, "type": "", "demo": "documentsdb\/create-collection.md", @@ -15432,7 +15435,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 786, + "weight": 838, "cookies": false, "type": "", "demo": "documentsdb\/get-collection.md", @@ -15502,7 +15505,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 787, + "weight": 839, "cookies": false, "type": "", "demo": "documentsdb\/update-collection.md", @@ -15612,7 +15615,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 788, + "weight": 840, "cookies": false, "type": "", "demo": "documentsdb\/delete-collection.md", @@ -15682,7 +15685,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 803, + "weight": 898, "cookies": false, "type": "", "demo": "documentsdb\/list-documents.md", @@ -15794,7 +15797,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 795, + "weight": 847, "cookies": false, "type": "", "demo": "documentsdb\/create-document.md", @@ -15973,7 +15976,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 800, + "weight": 852, "cookies": false, "type": "", "demo": "documentsdb\/upsert-documents.md", @@ -16101,7 +16104,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 798, + "weight": 850, "cookies": false, "type": "", "demo": "documentsdb\/update-documents.md", @@ -16201,7 +16204,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 802, + "weight": 854, "cookies": false, "type": "", "demo": "documentsdb\/delete-documents.md", @@ -16295,7 +16298,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 796, + "weight": 848, "cookies": false, "type": "", "demo": "documentsdb\/get-document.md", @@ -16396,7 +16399,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 799, + "weight": 851, "cookies": false, "type": "", "demo": "documentsdb\/upsert-document.md", @@ -16540,7 +16543,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 797, + "weight": 849, "cookies": false, "type": "", "demo": "documentsdb\/update-document.md", @@ -16646,7 +16649,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 801, + "weight": 853, "cookies": false, "type": "", "demo": "documentsdb\/delete-document.md", @@ -16744,7 +16747,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 805, + "weight": 857, "cookies": false, "type": "", "demo": "documentsdb\/decrement-document-attribute.md", @@ -16863,7 +16866,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 804, + "weight": 856, "cookies": false, "type": "", "demo": "documentsdb\/increment-document-attribute.md", @@ -16980,7 +16983,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 794, + "weight": 846, "cookies": false, "type": "", "demo": "documentsdb\/list-indexes.md", @@ -17071,7 +17074,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 791, + "weight": 843, "cookies": false, "type": "", "demo": "documentsdb\/create-index.md", @@ -17207,7 +17210,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 792, + "weight": 844, "cookies": false, "type": "", "demo": "documentsdb\/get-index.md", @@ -17279,7 +17282,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 793, + "weight": 845, "cookies": false, "type": "", "demo": "documentsdb\/delete-index.md", @@ -17356,7 +17359,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 437, + "weight": 416, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -17439,7 +17442,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 845, + "weight": 900, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -17572,6 +17575,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -17647,75 +17651,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -17812,7 +17823,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 439, + "weight": 418, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -17863,7 +17874,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 440, + "weight": 419, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -17914,7 +17925,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 435, + "weight": 414, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -17975,7 +17986,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 846, + "weight": 901, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -18110,6 +18121,7 @@ "go-1.24", "go-1.25", "go-1.26", + "rust-1.83", "static-1", "flutter-3.24", "flutter-3.27", @@ -18185,75 +18197,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -18344,7 +18363,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 438, + "weight": 417, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -18407,7 +18426,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 443, + "weight": 422, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -18486,7 +18505,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 444, + "weight": 423, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -18577,7 +18596,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 441, + "weight": 420, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -18671,7 +18690,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 449, + "weight": 428, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -18758,7 +18777,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 446, + "weight": 425, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -18880,7 +18899,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 447, + "weight": 426, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -18978,7 +18997,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 442, + "weight": 421, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -19042,7 +19061,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 445, + "weight": 424, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -19111,7 +19130,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 448, + "weight": 427, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -19198,7 +19217,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 450, + "weight": 429, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -19267,14 +19286,17 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 453, + "weight": 432, "cookies": false, "type": "", "demo": "functions\/list-executions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -19352,14 +19374,17 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 451, + "weight": 430, "cookies": false, "type": "", "demo": "functions\/create-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "client", @@ -19473,14 +19498,17 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 452, + "weight": 431, "cookies": false, "type": "", "demo": "functions\/get-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.read", + "scope": [ + "executions.read", + "execution.read" + ], "platforms": [ "console", "client", @@ -19540,14 +19568,17 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 454, + "weight": 433, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "execution.write", + "scope": [ + "executions.write", + "execution.write" + ], "platforms": [ "console", "server" @@ -19609,7 +19640,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 459, + "weight": 438, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -19670,7 +19701,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 847, + "weight": 902, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -19762,7 +19793,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 458, + "weight": 437, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -19831,7 +19862,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 460, + "weight": 439, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -19927,7 +19958,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 461, + "weight": 440, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -19998,7 +20029,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 122, + "weight": 117, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -20075,7 +20106,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 121, + "weight": 116, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -20150,7 +20181,7 @@ "x-appwrite": { "method": "get", "group": "health", - "weight": 464, + "weight": 443, "cookies": false, "type": "", "demo": "health\/get.md", @@ -20202,7 +20233,7 @@ "x-appwrite": { "method": "getAntivirus", "group": "health", - "weight": 473, + "weight": 452, "cookies": false, "type": "", "demo": "health\/get-antivirus.md", @@ -20254,7 +20285,7 @@ "x-appwrite": { "method": "getCache", "group": "health", - "weight": 467, + "weight": 446, "cookies": false, "type": "", "demo": "health\/get-cache.md", @@ -20306,7 +20337,7 @@ "x-appwrite": { "method": "getCertificate", "group": "health", - "weight": 470, + "weight": 449, "cookies": false, "type": "", "demo": "health\/get-certificate.md", @@ -20367,7 +20398,7 @@ "x-appwrite": { "method": "getConsolePausing", "group": null, - "weight": 985, + "weight": 1043, "cookies": false, "type": "", "demo": "health\/get-console-pausing.md", @@ -20439,7 +20470,7 @@ "x-appwrite": { "method": "getDB", "group": "health", - "weight": 466, + "weight": 445, "cookies": false, "type": "", "demo": "health\/get-db.md", @@ -20491,7 +20522,7 @@ "x-appwrite": { "method": "getPubSub", "group": "health", - "weight": 468, + "weight": 447, "cookies": false, "type": "", "demo": "health\/get-pub-sub.md", @@ -20543,7 +20574,7 @@ "x-appwrite": { "method": "getQueueAudits", "group": "queue", - "weight": 474, + "weight": 453, "cookies": false, "type": "", "demo": "health\/get-queue-audits.md", @@ -20606,7 +20637,7 @@ "x-appwrite": { "method": "getQueueBillingProjectAggregation", "group": null, - "weight": 981, + "weight": 1039, "cookies": false, "type": "", "demo": "health\/get-queue-billing-project-aggregation.md", @@ -20669,7 +20700,7 @@ "x-appwrite": { "method": "getQueueBillingTeamAggregation", "group": null, - "weight": 980, + "weight": 1038, "cookies": false, "type": "", "demo": "health\/get-queue-billing-team-aggregation.md", @@ -20732,7 +20763,7 @@ "x-appwrite": { "method": "getQueueBuilds", "group": "queue", - "weight": 478, + "weight": 457, "cookies": false, "type": "", "demo": "health\/get-queue-builds.md", @@ -20795,7 +20826,7 @@ "x-appwrite": { "method": "getQueuePriorityBuilds", "group": null, - "weight": 982, + "weight": 1040, "cookies": false, "type": "", "demo": "health\/get-queue-priority-builds.md", @@ -20858,7 +20889,7 @@ "x-appwrite": { "method": "getQueueCertificates", "group": "queue", - "weight": 477, + "weight": 456, "cookies": false, "type": "", "demo": "health\/get-queue-certificates.md", @@ -20921,7 +20952,7 @@ "x-appwrite": { "method": "getQueueDatabases", "group": "queue", - "weight": 479, + "weight": 458, "cookies": false, "type": "", "demo": "health\/get-queue-databases.md", @@ -20993,7 +21024,7 @@ "x-appwrite": { "method": "getQueueDeletes", "group": "queue", - "weight": 480, + "weight": 459, "cookies": false, "type": "", "demo": "health\/get-queue-deletes.md", @@ -21056,7 +21087,7 @@ "x-appwrite": { "method": "getFailedJobs", "group": "queue", - "weight": 487, + "weight": 466, "cookies": false, "type": "", "demo": "health\/get-failed-jobs.md", @@ -21144,7 +21175,7 @@ "x-appwrite": { "method": "getQueueFunctions", "group": "queue", - "weight": 484, + "weight": 463, "cookies": false, "type": "", "demo": "health\/get-queue-functions.md", @@ -21207,7 +21238,7 @@ "x-appwrite": { "method": "getQueueLogs", "group": "queue", - "weight": 476, + "weight": 455, "cookies": false, "type": "", "demo": "health\/get-queue-logs.md", @@ -21270,7 +21301,7 @@ "x-appwrite": { "method": "getQueueMails", "group": "queue", - "weight": 481, + "weight": 460, "cookies": false, "type": "", "demo": "health\/get-queue-mails.md", @@ -21333,7 +21364,7 @@ "x-appwrite": { "method": "getQueueMessaging", "group": "queue", - "weight": 482, + "weight": 461, "cookies": false, "type": "", "demo": "health\/get-queue-messaging.md", @@ -21396,7 +21427,7 @@ "x-appwrite": { "method": "getQueueMigrations", "group": "queue", - "weight": 483, + "weight": 462, "cookies": false, "type": "", "demo": "health\/get-queue-migrations.md", @@ -21459,7 +21490,7 @@ "x-appwrite": { "method": "getQueueRegionManager", "group": null, - "weight": 983, + "weight": 1041, "cookies": false, "type": "", "demo": "health\/get-queue-region-manager.md", @@ -21522,7 +21553,7 @@ "x-appwrite": { "method": "getQueueStatsResources", "group": "queue", - "weight": 485, + "weight": 464, "cookies": false, "type": "", "demo": "health\/get-queue-stats-resources.md", @@ -21585,7 +21616,7 @@ "x-appwrite": { "method": "getQueueUsage", "group": "queue", - "weight": 486, + "weight": 465, "cookies": false, "type": "", "demo": "health\/get-queue-usage.md", @@ -21648,7 +21679,7 @@ "x-appwrite": { "method": "getQueueThreats", "group": null, - "weight": 984, + "weight": 1042, "cookies": false, "type": "", "demo": "health\/get-queue-threats.md", @@ -21711,7 +21742,7 @@ "x-appwrite": { "method": "getQueueWebhooks", "group": "queue", - "weight": 475, + "weight": 454, "cookies": false, "type": "", "demo": "health\/get-queue-webhooks.md", @@ -21774,7 +21805,7 @@ "x-appwrite": { "method": "getStorage", "group": "storage", - "weight": 472, + "weight": 451, "cookies": false, "type": "", "demo": "health\/get-storage.md", @@ -21826,7 +21857,7 @@ "x-appwrite": { "method": "getStorageLocal", "group": "storage", - "weight": 471, + "weight": 450, "cookies": false, "type": "", "demo": "health\/get-storage-local.md", @@ -21878,7 +21909,7 @@ "x-appwrite": { "method": "getTime", "group": "health", - "weight": 469, + "weight": 448, "cookies": false, "type": "", "demo": "health\/get-time.md", @@ -22370,7 +22401,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 179, + "weight": 158, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -22456,7 +22487,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 176, + "weight": 155, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -22618,7 +22649,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 183, + "weight": 162, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -22787,7 +22818,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 178, + "weight": 157, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -22988,7 +23019,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 185, + "weight": 164, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -23204,7 +23235,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 177, + "weight": 156, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -23398,7 +23429,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 184, + "weight": 163, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -23591,7 +23622,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 182, + "weight": 161, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -23648,7 +23679,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 186, + "weight": 165, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -23710,7 +23741,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 180, + "weight": 159, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -23793,7 +23824,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 181, + "weight": 160, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -23876,7 +23907,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 150, + "weight": 129, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -23962,7 +23993,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 149, + "weight": 128, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -24154,7 +24185,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 163, + "weight": 142, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -24343,7 +24374,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 148, + "weight": 127, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -24504,7 +24535,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 162, + "weight": 141, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -24661,7 +24692,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 139, + "weight": 118, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -24794,7 +24825,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 153, + "weight": 132, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -24924,7 +24955,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 143, + "weight": 122, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -25030,7 +25061,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 157, + "weight": 136, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -25134,7 +25165,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 141, + "weight": 120, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -25254,7 +25285,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 155, + "weight": 134, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -25371,7 +25402,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 140, + "weight": 119, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -25491,7 +25522,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 154, + "weight": 133, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -25608,7 +25639,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 142, + "weight": 121, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -25861,7 +25892,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 156, + "weight": 135, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -26108,7 +26139,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 144, + "weight": 123, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -26215,7 +26246,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 158, + "weight": 137, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -26319,7 +26350,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 145, + "weight": 124, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -26426,7 +26457,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 159, + "weight": 138, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -26530,7 +26561,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 146, + "weight": 125, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -26637,7 +26668,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 160, + "weight": 139, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -26741,7 +26772,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 147, + "weight": 126, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -26848,7 +26879,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 161, + "weight": 140, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -26950,7 +26981,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 152, + "weight": 131, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -27007,7 +27038,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 164, + "weight": 143, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -27069,7 +27100,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 151, + "weight": 130, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -27152,7 +27183,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 173, + "weight": 152, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -27235,7 +27266,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 166, + "weight": 145, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -27319,7 +27350,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 165, + "weight": 144, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -27409,7 +27440,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 168, + "weight": 147, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -27471,7 +27502,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 169, + "weight": 148, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -27554,7 +27585,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 170, + "weight": 149, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -27616,7 +27647,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 167, + "weight": 146, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -27699,7 +27730,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 172, + "weight": 151, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -27791,7 +27822,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 171, + "weight": 150, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -27881,7 +27912,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 174, + "weight": 153, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -27946,7 +27977,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 175, + "weight": 154, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -27995,6 +28026,146 @@ ] } }, + "\/project": { + "delete": { + "summary": "Delete project", + "operationId": "projectDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "project" + ], + "description": "Delete a project.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 1087, + "cookies": false, + "type": "", + "demo": "project\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, + "\/project\/auth-methods\/{methodId}": { + "patch": { + "summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.", + "operationId": "projectUpdateAuthMethod", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project. ", + "responses": { + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateAuthMethod", + "group": null, + "weight": 1136, + "cookies": false, + "type": "", + "demo": "project\/update-auth-method.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "methodId", + "description": "Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone", + "required": true, + "type": "string", + "x-example": "email-password", + "enum": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ], + "x-enum-name": null, + "x-enum-keys": [], + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Auth method status.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } + } + ] + } + }, "\/project\/auth\/canonical-emails": { "patch": { "summary": "Update project auth canonical emails", @@ -28021,7 +28192,7 @@ "x-appwrite": { "method": "updateCanonicalEmails", "group": "auth", - "weight": 1068, + "weight": 1181, "cookies": false, "type": "", "demo": "project\/update-canonical-emails.md", @@ -28094,7 +28265,7 @@ "x-appwrite": { "method": "updateDisposableEmails", "group": "auth", - "weight": 1069, + "weight": 1182, "cookies": false, "type": "", "demo": "project\/update-disposable-emails.md", @@ -28167,7 +28338,7 @@ "x-appwrite": { "method": "updateFreeEmails", "group": "auth", - "weight": 1070, + "weight": 1183, "cookies": false, "type": "", "demo": "project\/update-free-emails.md", @@ -28238,7 +28409,7 @@ "x-appwrite": { "method": "listKeys", "group": "keys", - "weight": 1042, + "weight": 1103, "cookies": false, "type": "", "demo": "project\/list-keys.md", @@ -28299,7 +28470,7 @@ "tags": [ "project" ], - "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.", + "description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create an ephemeral API key if you need a short-lived key instead.", "responses": { "201": { "description": "Key", @@ -28312,7 +28483,7 @@ "x-appwrite": { "method": "createKey", "group": "keys", - "weight": 1041, + "weight": 1101, "cookies": false, "type": "", "demo": "project\/create-key.md", @@ -28364,75 +28535,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -28464,6 +28642,177 @@ ] } }, + "\/project\/keys\/ephemeral": { + "post": { + "summary": "Create ephemeral project key", + "operationId": "projectCreateEphemeralKey", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Create a new ephemeral API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.\n\nYou can also create a standard API key if you need a longer-lived key instead.", + "responses": { + "201": { + "description": "Ephemeral Key", + "schema": { + "$ref": "#\/definitions\/ephemeralKey" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createEphemeralKey", + "group": "keys", + "weight": 1102, + "cookies": false, + "type": "", + "demo": "project\/create-ephemeral-key.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "keys.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "scopes": { + "type": "array", + "description": "Key scopes list. Maximum of 100 scopes are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string", + "enum": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "rules.read", + "rules.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "domains.read", + "domains.write", + "events.read" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "duration": { + "type": "integer", + "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", + "default": null, + "x-example": 1, + "format": "int32" + } + }, + "required": [ + "scopes", + "duration" + ] + } + } + ] + } + }, "\/project\/keys\/{keyId}": { "get": { "summary": "Get project key", @@ -28488,7 +28837,7 @@ "x-appwrite": { "method": "getKey", "group": "keys", - "weight": 1043, + "weight": 1104, "cookies": false, "type": "", "demo": "project\/get-key.md", @@ -28549,7 +28898,7 @@ "x-appwrite": { "method": "updateKey", "group": "keys", - "weight": 1045, + "weight": 1106, "cookies": false, "type": "", "demo": "project\/update-key.md", @@ -28603,75 +28952,82 @@ "items": { "type": "string", "enum": [ - "sessions.write", + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", "users.read", "users.write", + "sessions.read", + "sessions.write", "teams.read", "teams.write", "databases.read", "databases.write", - "collections.read", - "collections.write", "tables.read", "tables.write", - "attributes.read", - "attributes.write", "columns.read", "columns.write", "indexes.read", "indexes.write", - "documents.read", - "documents.write", "rows.read", "rows.write", - "files.read", - "files.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", "buckets.read", "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", "functions.read", "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", "sites.read", "sites.write", "log.read", "log.write", - "execution.read", - "execution.write", - "locale.read", - "avatars.read", - "health.read", "providers.read", "providers.write", - "messages.read", - "messages.write", "topics.read", "topics.write", "subscribers.read", "subscribers.write", "targets.read", "targets.write", - "rules.read", - "rules.write", - "schedules.read", - "schedules.write", + "messages.read", + "messages.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", "migrations.read", "migrations.write", + "schedules.read", + "schedules.write", "vcs.read", "vcs.write", - "assistant.read", - "tokens.read", - "tokens.write", - "webhooks.read", - "webhooks.write", - "project.read", - "project.write", - "keys.read", - "keys.write", - "platforms.read", - "platforms.write", - "policies.write", - "templates.read", - "templates.write", - "policies.read", + "rules.read", + "rules.write", "archives.read", "archives.write", "restorations.read", @@ -28721,7 +29077,7 @@ "x-appwrite": { "method": "deleteKey", "group": "keys", - "weight": 1044, + "weight": 1105, "cookies": false, "type": "", "demo": "project\/delete-key.md", @@ -28784,7 +29140,7 @@ "x-appwrite": { "method": "updateLabels", "group": null, - "weight": 1029, + "weight": 1088, "cookies": false, "type": "", "demo": "project\/update-labels.md", @@ -28834,10 +29190,10 @@ ] } }, - "\/project\/platforms": { + "\/project\/mock-phones": { "get": { - "summary": "List project platforms", - "operationId": "projectListPlatforms", + "summary": "List project mock phones", + "operationId": "projectListMockPhones", "consumes": [], "produces": [ "application\/json" @@ -28845,27 +29201,27 @@ "tags": [ "project" ], - "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", + "description": "Get a list of all mock phones in the project. This endpoint returns an array of all mock phones and their OTPs.", "responses": { "200": { - "description": "Platforms List", + "description": "Mock Numbers List", "schema": { - "$ref": "#\/definitions\/platformList" + "$ref": "#\/definitions\/mockNumberList" } } }, "deprecated": false, "x-appwrite": { - "method": "listPlatforms", - "group": "platforms", - "weight": 1058, + "method": "listMockPhones", + "group": "mocks", + "weight": 1121, "cookies": false, "type": "", - "demo": "project\/list-platforms.md", + "demo": "project\/list-mock-phones.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "mocks.read", "platforms": [ "console", "server" @@ -28886,7 +29242,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "type": "array", "collectionFormat": "multi", @@ -28906,12 +29262,10 @@ "in": "query" } ] - } - }, - "\/project\/platforms\/android": { + }, "post": { - "summary": "Create project Android platform", - "operationId": "projectCreateAndroidPlatform", + "summary": "Create project mock phone", + "operationId": "projectCreateMockPhone", "consumes": [ "application\/json" ], @@ -28921,27 +29275,27 @@ "tags": [ "project" ], - "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", + "description": "Create a new mock phone for your project. Use this endpoint to register a mock phone number and its sign-in OTP for your testers.", "responses": { "201": { - "description": "Platform Android", + "description": "Mock Number", "schema": { - "$ref": "#\/definitions\/platformAndroid" + "$ref": "#\/definitions\/mockNumber" } } }, "deprecated": false, "x-appwrite": { - "method": "createAndroidPlatform", - "group": "platforms", - "weight": 1054, + "method": "createMockPhone", + "group": "mocks", + "weight": 1120, "cookies": false, "type": "", - "demo": "project\/create-android-platform.md", + "demo": "project\/create-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -28966,69 +29320,61 @@ "schema": { "type": "object", "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { + "number": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.", "default": null, - "x-example": "" + "x-example": "+12065550100", + "format": "phone" }, - "applicationId": { + "otp": { "type": "string", - "description": "Android application ID. Max length: 256 chars.", + "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", "default": null, - "x-example": "" + "x-example": "" } }, "required": [ - "platformId", - "name", - "applicationId" + "number", + "otp" ] } } ] } }, - "\/project\/platforms\/android\/{platformId}": { - "put": { - "summary": "Update project Android platform", - "operationId": "projectUpdateAndroidPlatform", - "consumes": [ - "application\/json" - ], + "\/project\/mock-phones\/{number}": { + "get": { + "summary": "Get project mock phone", + "operationId": "projectGetMockPhone", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", + "description": "Get a mock phone by its unique number. This endpoint returns the mock phone's OTP.", "responses": { "200": { - "description": "Platform Android", + "description": "Mock Number", "schema": { - "$ref": "#\/definitions\/platformAndroid" + "$ref": "#\/definitions\/mockNumber" } } }, "deprecated": false, "x-appwrite": { - "method": "updateAndroidPlatform", - "group": "platforms", - "weight": 1049, + "method": "getMockPhone", + "group": "mocks", + "weight": 1122, "cookies": false, "type": "", - "demo": "project\/update-android-platform.md", + "demo": "project\/get-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.read", "platforms": [ "console", "server" @@ -29048,45 +29394,19 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", "required": true, "type": "string", - "x-example": "", + "format": "phone", + "x-example": "+12065550100", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "applicationId": { - "type": "string", - "description": "Android application ID. Max length: 256 chars.", - "default": null, - "x-example": "" - } - }, - "required": [ - "name", - "applicationId" - ] - } } ] - } - }, - "\/project\/platforms\/apple": { - "post": { - "summary": "Create project Apple platform", - "operationId": "projectCreateApplePlatform", + }, + "put": { + "summary": "Update project mock phone", + "operationId": "projectUpdateMockPhone", "consumes": [ "application\/json" ], @@ -29096,27 +29416,27 @@ "tags": [ "project" ], - "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update a mock phone by its unique number. Use this endpoint to update the mock phone's OTP.", "responses": { - "201": { - "description": "Platform Apple", + "200": { + "description": "Mock Number", "schema": { - "$ref": "#\/definitions\/platformApple" + "$ref": "#\/definitions\/mockNumber" } } }, "deprecated": false, "x-appwrite": { - "method": "createApplePlatform", - "group": "platforms", - "weight": 1053, + "method": "updateMockPhone", + "group": "mocks", + "weight": 1123, "cookies": false, "type": "", - "demo": "project\/create-apple-platform.md", + "demo": "project\/update-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -29135,75 +29455,63 @@ } ], "parameters": [ + { + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", + "required": true, + "type": "string", + "format": "phone", + "x-example": "+12065550100", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "platformId": { - "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "bundleIdentifier": { + "otp": { "type": "string", - "description": "Apple bundle identifier. Max length: 256 chars.", + "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", "default": null, - "x-example": "" + "x-example": "" } }, "required": [ - "platformId", - "name", - "bundleIdentifier" + "otp" ] } } ] - } - }, - "\/project\/platforms\/apple\/{platformId}": { - "put": { - "summary": "Update project Apple platform", - "operationId": "projectUpdateApplePlatform", + }, + "delete": { + "summary": "Delete project mock phone", + "operationId": "projectDeleteMockPhone", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "project" ], - "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", + "description": "Delete a mock phone by its unique number. This endpoint removes the mock phone and its OTP configuration from the project.", "responses": { - "200": { - "description": "Platform Apple", - "schema": { - "$ref": "#\/definitions\/platformApple" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateApplePlatform", - "group": "platforms", - "weight": 1048, + "method": "deleteMockPhone", + "group": "mocks", + "weight": 1124, "cookies": false, "type": "", - "demo": "project\/update-apple-platform.md", + "demo": "project\/delete-mock-phone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "mocks.write", "platforms": [ "console", "server" @@ -29223,45 +29531,72 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", + "name": "number", + "description": "Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.", "required": true, "type": "string", - "x-example": "", + "format": "phone", + "x-example": "+12065550100", "in": "path" - }, - { - "name": "payload", - "in": "body", + } + ] + } + }, + "\/project\/oauth2": { + "get": { + "summary": "List project OAuth2 providers", + "operationId": "projectListOAuth2Providers", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a list of all OAuth2 providers supported by the server, along with the project's configuration for each. Credential fields are write-only and always returned empty.", + "responses": { + "200": { + "description": "OAuth2 Providers List", "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Platform name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "bundleIdentifier": { - "type": "string", - "description": "Apple bundle identifier. Max length: 256 chars.", - "default": null, - "x-example": "" - } - }, - "required": [ - "name", - "bundleIdentifier" - ] + "$ref": "#\/definitions\/oAuth2ProviderList" } } + }, + "deprecated": false, + "x-appwrite": { + "method": "listOAuth2Providers", + "group": "oauth2", + "weight": 1137, + "cookies": false, + "type": "", + "demo": "project\/list-o-auth-2-providers.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } ] } }, - "\/project\/platforms\/linux": { - "post": { - "summary": "Create project Linux platform", - "operationId": "projectCreateLinuxPlatform", + "\/project\/oauth2\/amazon": { + "patch": { + "summary": "Update project OAuth2 Amazon", + "operationId": "projectUpdateOAuth2Amazon", "consumes": [ "application\/json" ], @@ -29271,27 +29606,27 @@ "tags": [ "project" ], - "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Amazon configuration.", "responses": { - "201": { - "description": "Platform Linux", + "200": { + "description": "OAuth2Amazon", "schema": { - "$ref": "#\/definitions\/platformLinux" + "$ref": "#\/definitions\/oAuth2Amazon" } } }, "deprecated": false, "x-appwrite": { - "method": "createLinuxPlatform", - "group": "platforms", - "weight": 1056, + "method": "updateOAuth2Amazon", + "group": "oauth2", + "weight": 1164, "cookies": false, "type": "", - "demo": "project\/create-linux-platform.md", + "demo": "project\/update-o-auth-2-amazon.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29316,39 +29651,37 @@ "schema": { "type": "object", "properties": { - "platformId": { + "clientId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "name": { + "clientSecret": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "packageName": { - "type": "string", - "description": "Linux package name. Max length: 256 chars.", + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": "" + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "packageName" - ] + } } } ] } }, - "\/project\/platforms\/linux\/{platformId}": { - "put": { - "summary": "Update project Linux platform", - "operationId": "projectUpdateLinuxPlatform", + "\/project\/oauth2\/apple": { + "patch": { + "summary": "Update project OAuth2 Apple", + "operationId": "projectUpdateOAuth2Apple", "consumes": [ "application\/json" ], @@ -29358,27 +29691,27 @@ "tags": [ "project" ], - "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", + "description": "Update the project OAuth2 Apple configuration.", "responses": { "200": { - "description": "Platform Linux", + "description": "OAuth2Apple", "schema": { - "$ref": "#\/definitions\/platformLinux" + "$ref": "#\/definitions\/oAuth2Apple" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLinuxPlatform", - "group": "platforms", - "weight": 1051, + "method": "updateOAuth2Apple", + "group": "oauth2", + "weight": 1179, "cookies": false, "type": "", - "demo": "project\/update-linux-platform.md", + "demo": "project\/update-o-auth-2-apple.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29397,46 +29730,57 @@ } ], "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "serviceId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "packageName": { + "keyId": { "type": "string", - "description": "Linux package name. Max length: 256 chars.", + "description": "'Key ID' of Apple OAuth2 app. For example: P4000000N8", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true + }, + "teamId": { + "type": "string", + "description": "'Team ID' of Apple OAuth2 app. For example: D4000000R6", + "default": null, + "x-example": "", + "x-nullable": true + }, + "p8File": { + "type": "string", + "description": "Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "packageName" - ] + } } } ] } }, - "\/project\/platforms\/web": { - "post": { - "summary": "Create project web platform", - "operationId": "projectCreateWebPlatform", + "\/project\/oauth2\/auth0": { + "patch": { + "summary": "Update project OAuth2 Auth0", + "operationId": "projectUpdateOAuth2Auth0", "consumes": [ "application\/json" ], @@ -29446,27 +29790,27 @@ "tags": [ "project" ], - "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Auth0 configuration.", "responses": { - "201": { - "description": "Platform Web", + "200": { + "description": "OAuth2Auth0", "schema": { - "$ref": "#\/definitions\/platformWeb" + "$ref": "#\/definitions\/oAuth2Auth0" } } }, "deprecated": false, "x-appwrite": { - "method": "createWebPlatform", - "group": "platforms", - "weight": 1052, + "method": "updateOAuth2Auth0", + "group": "oauth2", + "weight": 1173, "cookies": false, "type": "", - "demo": "project\/create-web-platform.md", + "demo": "project\/update-o-auth-2-auth-0.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29491,39 +29835,44 @@ "schema": { "type": "object", "properties": { - "platformId": { + "clientId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "name": { + "clientSecret": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "hostname": { + "endpoint": { "type": "string", - "description": "Platform web hostname. Max length: 256 chars.", + "description": "Domain of Auth0 instance. For example: example.us.auth0.com", "default": null, - "x-example": "app.example.com" + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "hostname" - ] + } } } ] } }, - "\/project\/platforms\/web\/{platformId}": { - "put": { - "summary": "Update project web platform", - "operationId": "projectUpdateWebPlatform", + "\/project\/oauth2\/authentik": { + "patch": { + "summary": "Update project OAuth2 Authentik", + "operationId": "projectUpdateOAuth2Authentik", "consumes": [ "application\/json" ], @@ -29533,27 +29882,27 @@ "tags": [ "project" ], - "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", + "description": "Update the project OAuth2 Authentik configuration.", "responses": { "200": { - "description": "Platform Web", + "description": "OAuth2Authentik", "schema": { - "$ref": "#\/definitions\/platformWeb" + "$ref": "#\/definitions\/oAuth2Authentik" } } }, "deprecated": false, "x-appwrite": { - "method": "updateWebPlatform", - "group": "platforms", - "weight": 1047, + "method": "updateOAuth2Authentik", + "group": "oauth2", + "weight": 1172, "cookies": false, "type": "", - "demo": "project\/update-web-platform.md", + "demo": "project\/update-o-auth-2-authentik.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29572,46 +29921,50 @@ } ], "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "hostname": { + "clientSecret": { "type": "string", - "description": "Platform web hostname. Max length: 256 chars.", + "description": "'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", "default": null, - "x-example": "app.example.com" + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of Authentik instance. For example: example.authentik.com", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "hostname" - ] + } } } ] } }, - "\/project\/platforms\/windows": { - "post": { - "summary": "Create project Windows platform", - "operationId": "projectCreateWindowsPlatform", + "\/project\/oauth2\/autodesk": { + "patch": { + "summary": "Update project OAuth2 Autodesk", + "operationId": "projectUpdateOAuth2Autodesk", "consumes": [ "application\/json" ], @@ -29621,27 +29974,27 @@ "tags": [ "project" ], - "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", + "description": "Update the project OAuth2 Autodesk configuration.", "responses": { - "201": { - "description": "Platform Windows", + "200": { + "description": "OAuth2Autodesk", "schema": { - "$ref": "#\/definitions\/platformWindows" + "$ref": "#\/definitions\/oAuth2Autodesk" } } }, "deprecated": false, "x-appwrite": { - "method": "createWindowsPlatform", - "group": "platforms", - "weight": 1055, + "method": "updateOAuth2Autodesk", + "group": "oauth2", + "weight": 1147, "cookies": false, "type": "", - "demo": "project\/create-windows-platform.md", + "demo": "project\/update-o-auth-2-autodesk.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29666,39 +30019,37 @@ "schema": { "type": "object", "properties": { - "platformId": { + "clientId": { "type": "string", - "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "name": { + "clientSecret": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "packageIdentifierName": { - "type": "string", - "description": "Windows package identifier name. Max length: 256 chars.", + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": "" + "x-example": false, + "x-nullable": true } - }, - "required": [ - "platformId", - "name", - "packageIdentifierName" - ] + } } } ] } }, - "\/project\/platforms\/windows\/{platformId}": { - "put": { - "summary": "Update project Windows platform", - "operationId": "projectUpdateWindowsPlatform", + "\/project\/oauth2\/bitbucket": { + "patch": { + "summary": "Update project OAuth2 Bitbucket", + "operationId": "projectUpdateOAuth2Bitbucket", "consumes": [ "application\/json" ], @@ -29708,27 +30059,27 @@ "tags": [ "project" ], - "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", + "description": "Update the project OAuth2 Bitbucket configuration.", "responses": { "200": { - "description": "Platform Windows", + "description": "OAuth2Bitbucket", "schema": { - "$ref": "#\/definitions\/platformWindows" + "$ref": "#\/definitions\/oAuth2Bitbucket" } } }, "deprecated": false, "x-appwrite": { - "method": "updateWindowsPlatform", - "group": "platforms", - "weight": 1050, + "method": "updateOAuth2Bitbucket", + "group": "oauth2", + "weight": 1144, "cookies": false, "type": "", - "demo": "project\/update-windows-platform.md", + "demo": "project\/update-o-auth-2-bitbucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29747,100 +30098,73 @@ } ], "parameters": [ - { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "key": { "type": "string", - "description": "Platform name. Max length: 128 chars.", + "description": "'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "packageIdentifierName": { + "secret": { "type": "string", - "description": "Windows package identifier name. Max length: 256 chars.", + "description": "'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "packageIdentifierName" - ] + } } } ] } }, - "\/project\/platforms\/{platformId}": { - "get": { - "summary": "Get project platform", - "operationId": "projectGetPlatform", - "consumes": [], + "\/project\/oauth2\/bitly": { + "patch": { + "summary": "Update project OAuth2 Bitly", + "operationId": "projectUpdateOAuth2Bitly", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", + "description": "Update the project OAuth2 Bitly configuration.", "responses": { "200": { - "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", + "description": "OAuth2Bitly", "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/platformWeb" - }, - { - "$ref": "#\/definitions\/platformApple" - }, - { - "$ref": "#\/definitions\/platformAndroid" - }, - { - "$ref": "#\/definitions\/platformWindows" - }, - { - "$ref": "#\/definitions\/platformLinux" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/definitions\/platformWeb", - "apple": "#\/definitions\/platformApple", - "android": "#\/definitions\/platformAndroid", - "windows": "#\/definitions\/platformWindows", - "linux": "#\/definitions\/platformLinux" - } - } + "$ref": "#\/definitions\/oAuth2Bitly" } } }, "deprecated": false, "x-appwrite": { - "method": "getPlatform", - "group": "platforms", - "weight": 1057, + "method": "updateOAuth2Bitly", + "group": "oauth2", + "weight": 1145, "cookies": false, "type": "", - "demo": "project\/get-platform.md", + "demo": "project\/update-o-auth-2-bitly.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29860,43 +30184,72 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete project platform", - "operationId": "projectDeletePlatform", - "consumes": [ - "application\/json" - ], - "produces": [], + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } + } + ] + } + }, + "\/project\/oauth2\/box": { + "patch": { + "summary": "Update project OAuth2 Box", + "operationId": "projectUpdateOAuth2Box", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], "tags": [ "project" ], - "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", + "description": "Update the project OAuth2 Box configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Box", + "schema": { + "$ref": "#\/definitions\/oAuth2Box" + } } }, "deprecated": false, "x-appwrite": { - "method": "deletePlatform", - "group": "platforms", - "weight": 1046, + "method": "updateOAuth2Box", + "group": "oauth2", + "weight": 1146, "cookies": false, "type": "", - "demo": "project\/delete-platform.md", + "demo": "project\/update-o-auth-2-box.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "platforms.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29916,20 +30269,42 @@ ], "parameters": [ { - "name": "platformId", - "description": "Platform ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/project\/policies\/membership-privacy": { + "\/project\/oauth2\/dailymotion": { "patch": { - "summary": "Update membership privacy policy", - "operationId": "projectUpdateMembershipPrivacyPolicy", + "summary": "Update project OAuth2 Dailymotion", + "operationId": "projectUpdateOAuth2Dailymotion", "consumes": [ "application\/json" ], @@ -29939,27 +30314,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", + "description": "Update the project OAuth2 Dailymotion configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Dailymotion", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Dailymotion" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipPrivacyPolicy", - "group": "policies", - "weight": 1059, + "method": "updateOAuth2Dailymotion", + "group": "oauth2", + "weight": 1143, "cookies": false, "type": "", - "demo": "project\/update-membership-privacy-policy.md", + "demo": "project\/update-o-auth-2-dailymotion.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -29984,35 +30359,26 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "boolean", - "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "default": null, - "x-example": false - }, - "userEmail": { - "type": "boolean", - "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "default": null, - "x-example": false - }, - "userPhone": { - "type": "boolean", - "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", + "apiKey": { + "type": "string", + "description": "'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f", "default": null, - "x-example": false + "x-example": "", + "x-nullable": true }, - "userName": { - "type": "boolean", - "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "apiSecret": { + "type": "string", + "description": "'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639", "default": null, - "x-example": false + "x-example": "", + "x-nullable": true }, - "userMFA": { + "enabled": { "type": "boolean", - "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } } } @@ -30020,10 +30386,10 @@ ] } }, - "\/project\/policies\/password-dictionary": { + "\/project\/oauth2\/discord": { "patch": { - "summary": "Update password dictionary policy", - "operationId": "projectUpdatePasswordDictionaryPolicy", + "summary": "Update project OAuth2 Discord", + "operationId": "projectUpdateOAuth2Discord", "consumes": [ "application\/json" ], @@ -30033,27 +30399,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", + "description": "Update the project OAuth2 Discord configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Discord", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Discord" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordDictionaryPolicy", - "group": "policies", - "weight": 1060, + "method": "updateOAuth2Discord", + "group": "oauth2", + "weight": 1140, "cookies": false, "type": "", - "demo": "project\/update-password-dictionary-policy.md", + "demo": "project\/update-o-auth-2-discord.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30078,25 +30444,37 @@ "schema": { "type": "object", "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Discord OAuth2 app. For example: 950722000000343754", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/policies\/password-history": { + "\/project\/oauth2\/disqus": { "patch": { - "summary": "Update password history policy", - "operationId": "projectUpdatePasswordHistoryPolicy", + "summary": "Update project OAuth2 Disqus", + "operationId": "projectUpdateOAuth2Disqus", "consumes": [ "application\/json" ], @@ -30106,27 +30484,27 @@ "tags": [ "project" ], - "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", + "description": "Update the project OAuth2 Disqus configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Disqus", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Disqus" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordHistoryPolicy", - "group": "policies", - "weight": 1061, + "method": "updateOAuth2Disqus", + "group": "oauth2", + "weight": 1163, "cookies": false, "type": "", - "demo": "project\/update-password-history-policy.md", + "demo": "project\/update-o-auth-2-disqus.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30151,27 +30529,37 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", + "publicKey": { + "type": "string", + "description": "'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", "default": null, - "x-example": 1, - "format": "int32", + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } ] } }, - "\/project\/policies\/password-personal-data": { + "\/project\/oauth2\/dropbox": { "patch": { - "summary": "Update password personal data policy", - "operationId": "projectUpdatePasswordPersonalDataPolicy", + "summary": "Update project OAuth2 Dropbox", + "operationId": "projectUpdateOAuth2Dropbox", "consumes": [ "application\/json" ], @@ -30181,27 +30569,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", + "description": "Update the project OAuth2 Dropbox configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Dropbox", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Dropbox" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePasswordPersonalDataPolicy", - "group": "policies", - "weight": 1062, + "method": "updateOAuth2Dropbox", + "group": "oauth2", + "weight": 1142, "cookies": false, "type": "", - "demo": "project\/update-password-personal-data-policy.md", + "demo": "project\/update-o-auth-2-dropbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30226,25 +30614,37 @@ "schema": { "type": "object", "properties": { + "appKey": { + "type": "string", + "description": "'App Key' of Dropbox OAuth2 app. For example: jl000000000009t", + "default": null, + "x-example": "", + "x-nullable": true + }, + "appSecret": { + "type": "string", + "description": "'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/policies\/session-alert": { + "\/project\/oauth2\/etsy": { "patch": { - "summary": "Update session alert policy", - "operationId": "projectUpdateSessionAlertPolicy", + "summary": "Update project OAuth2 Etsy", + "operationId": "projectUpdateOAuth2Etsy", "consumes": [ "application\/json" ], @@ -30254,27 +30654,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.", + "description": "Update the project OAuth2 Etsy configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Etsy", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Etsy" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionAlertPolicy", - "group": "policies", - "weight": 1063, + "method": "updateOAuth2Etsy", + "group": "oauth2", + "weight": 1165, "cookies": false, "type": "", - "demo": "project\/update-session-alert-policy.md", + "demo": "project\/update-o-auth-2-etsy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30299,25 +30699,37 @@ "schema": { "type": "object", "properties": { + "keyString": { + "type": "string", + "description": "'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2", + "default": null, + "x-example": "", + "x-nullable": true + }, + "sharedSecret": { + "type": "string", + "description": "'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/policies\/session-duration": { + "\/project\/oauth2\/facebook": { "patch": { - "summary": "Update session duration policy", - "operationId": "projectUpdateSessionDurationPolicy", + "summary": "Update project OAuth2 Facebook", + "operationId": "projectUpdateOAuth2Facebook", "consumes": [ "application\/json" ], @@ -30327,27 +30739,27 @@ "tags": [ "project" ], - "description": "Update maximum duration how long sessions created within a project should stay active for.", + "description": "Update the project OAuth2 Facebook configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Facebook", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Facebook" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionDurationPolicy", - "group": "policies", - "weight": 1064, + "method": "updateOAuth2Facebook", + "group": "oauth2", + "weight": 1166, "cookies": false, "type": "", - "demo": "project\/update-session-duration-policy.md", + "demo": "project\/update-o-auth-2-facebook.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30372,26 +30784,37 @@ "schema": { "type": "object", "properties": { - "duration": { - "type": "integer", - "description": "Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.", + "appId": { + "type": "string", + "description": "'App ID' of Facebook OAuth2 app. For example: 260600000007694", "default": null, - "x-example": 5, - "format": "int32" + "x-example": "", + "x-nullable": true + }, + "appSecret": { + "type": "string", + "description": "'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "duration" - ] + } } } ] } }, - "\/project\/policies\/session-invalidation": { + "\/project\/oauth2\/figma": { "patch": { - "summary": "Update session invalidation policy", - "operationId": "projectUpdateSessionInvalidationPolicy", + "summary": "Update project OAuth2 Figma", + "operationId": "projectUpdateOAuth2Figma", "consumes": [ "application\/json" ], @@ -30401,27 +30824,27 @@ "tags": [ "project" ], - "description": "Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.", + "description": "Update the project OAuth2 Figma configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Figma", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Figma" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionInvalidationPolicy", - "group": "policies", - "weight": 1065, + "method": "updateOAuth2Figma", + "group": "oauth2", + "weight": 1141, "cookies": false, "type": "", - "demo": "project\/update-session-invalidation-policy.md", + "demo": "project\/update-o-auth-2-figma.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30446,25 +30869,37 @@ "schema": { "type": "object", "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/policies\/session-limit": { + "\/project\/oauth2\/fusionauth": { "patch": { - "summary": "Update session limit policy", - "operationId": "projectUpdateSessionLimitPolicy", + "summary": "Update project OAuth2 FusionAuth", + "operationId": "projectUpdateOAuth2FusionAuth", "consumes": [ "application\/json" ], @@ -30474,27 +30909,27 @@ "tags": [ "project" ], - "description": "Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.", + "description": "Update the project OAuth2 FusionAuth configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2FusionAuth", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2FusionAuth" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSessionLimitPolicy", - "group": "policies", - "weight": 1066, + "method": "updateOAuth2FusionAuth", + "group": "oauth2", + "weight": 1174, "cookies": false, "type": "", - "demo": "project\/update-session-limit-policy.md", + "demo": "project\/update-o-auth-2-fusion-auth.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30519,27 +30954,44 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.", + "clientId": { + "type": "string", + "description": "'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097", "default": null, - "x-example": 1, - "format": "int32", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc", + "default": null, + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Domain of FusionAuth instance. For example: example.fusionauth.io", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } ] } }, - "\/project\/policies\/user-limit": { + "\/project\/oauth2\/github": { "patch": { - "summary": "Update user limit policy", - "operationId": "projectUpdateUserLimitPolicy", + "summary": "Update project OAuth2 GitHub", + "operationId": "projectUpdateOAuth2GitHub", "consumes": [ "application\/json" ], @@ -30549,27 +31001,27 @@ "tags": [ "project" ], - "description": "Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.", + "description": "Update the project OAuth2 GitHub configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2GitHub", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Github" } } }, "deprecated": false, "x-appwrite": { - "method": "updateUserLimitPolicy", - "group": "policies", - "weight": 1067, + "method": "updateOAuth2GitHub", + "group": "oauth2", + "weight": 1139, "cookies": false, "type": "", - "demo": "project\/update-user-limit-policy.md", + "demo": "project\/update-o-auth-2-git-hub.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "policies.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30594,27 +31046,37 @@ "schema": { "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.", + "clientId": { + "type": "string", + "description": "'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006", "default": null, - "x-example": 1, - "format": "int32", + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, "x-nullable": true } - }, - "required": [ - "total" - ] + } } } ] } }, - "\/project\/protocols\/{protocolId}": { + "\/project\/oauth2\/gitlab": { "patch": { - "summary": "Update project protocol", - "operationId": "projectUpdateProtocol", + "summary": "Update project OAuth2 Gitlab", + "operationId": "projectUpdateOAuth2Gitlab", "consumes": [ "application\/json" ], @@ -30624,27 +31086,27 @@ "tags": [ "project" ], - "description": "Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project. ", + "description": "Update the project OAuth2 Gitlab configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Gitlab", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Gitlab" } } }, "deprecated": false, "x-appwrite": { - "method": "updateProtocol", - "group": null, - "weight": 1030, + "method": "updateOAuth2Gitlab", + "group": "oauth2", + "weight": 1171, "cookies": false, "type": "", - "demo": "project\/update-protocol.md", + "demo": "project\/update-o-auth-2-gitlab.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30663,46 +31125,51 @@ } ], "parameters": [ - { - "name": "protocolId", - "description": "Protocol name. Can be one of: rest, graphql, websocket", - "required": true, - "type": "string", - "x-example": "rest", - "enum": [ - "rest", - "graphql", - "websocket" - ], - "x-enum-name": null, - "x-enum-keys": [], - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "applicationId": { + "type": "string", + "description": "'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "string", + "description": "'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "default": null, + "x-example": "", + "x-nullable": true + }, + "endpoint": { + "type": "string", + "description": "Endpoint URL of self-hosted GitLab instance. For example: https:\/\/gitlab.com", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Protocol status.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/services\/{serviceId}": { + "\/project\/oauth2\/google": { "patch": { - "summary": "Update project service", - "operationId": "projectUpdateService", + "summary": "Update project OAuth2 Google", + "operationId": "projectUpdateOAuth2Google", "consumes": [ "application\/json" ], @@ -30712,27 +31179,27 @@ "tags": [ "project" ], - "description": "Update properties of a specific service. Use this endpoint to enable or disable a service in your project. ", + "description": "Update the project OAuth2 Google configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Google", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Google" } } }, "deprecated": false, "x-appwrite": { - "method": "updateService", - "group": null, - "weight": 1031, + "method": "updateOAuth2Google", + "group": "oauth2", + "weight": 1148, "cookies": false, "type": "", - "demo": "project\/update-service.md", + "demo": "project\/update-o-auth-2-google.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30751,60 +31218,43 @@ } ], "parameters": [ - { - "name": "serviceId", - "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", - "required": true, - "type": "string", - "x-example": "account", - "enum": [ - "account", - "avatars", - "databases", - "tablesdb", - "locale", - "health", - "project", - "storage", - "teams", - "users", - "vcs", - "sites", - "functions", - "proxy", - "graphql", - "migrations", - "messaging" - ], - "x-enum-name": null, - "x-enum-keys": [], - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj", + "default": null, + "x-example": "", + "x-nullable": true + }, "enabled": { "type": "boolean", - "description": "Service status.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": false + "x-example": false, + "x-nullable": true } - }, - "required": [ - "enabled" - ] + } } } ] } }, - "\/project\/smtp": { + "\/project\/oauth2\/keycloak": { "patch": { - "summary": "Update project SMTP configuration", - "operationId": "projectUpdateSMTP", + "summary": "Update project OAuth2 Keycloak", + "operationId": "projectUpdateOAuth2Keycloak", "consumes": [ "application\/json" ], @@ -30814,27 +31264,27 @@ "tags": [ "project" ], - "description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.", + "description": "Update the project OAuth2 Keycloak configuration.", "responses": { "200": { - "description": "Project", + "description": "OAuth2Keycloak", "schema": { - "$ref": "#\/definitions\/project" + "$ref": "#\/definitions\/oAuth2Keycloak" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSMTP", - "group": "smtp", - "weight": 1032, + "method": "updateOAuth2Keycloak", + "group": "oauth2", + "weight": 1175, "cookies": false, "type": "", - "demo": "project\/update-smtp.md", + "demo": "project\/update-o-auth-2-keycloak.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30859,81 +31309,299 @@ "schema": { "type": "object", "properties": { - "host": { + "clientId": { "type": "string", - "description": "SMTP server hostname (domain)", + "description": "'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app", "default": null, - "x-example": null, + "x-example": "", "x-nullable": true }, - "port": { - "type": "integer", - "description": "SMTP server port", + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO", "default": null, - "x-example": null, - "format": "int32", + "x-example": "", "x-nullable": true }, - "username": { + "endpoint": { "type": "string", - "description": "SMTP server username. Leave empty for no authorization.", + "description": "Domain of Keycloak instance. For example: keycloak.example.com", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "password": { + "realmName": { "type": "string", - "description": "SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).", + "description": "Keycloak realm name. For example: appwrite-realm", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "senderEmail": { + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } + } + ] + } + }, + "\/project\/oauth2\/kick": { + "patch": { + "summary": "Update project OAuth2 Kick", + "operationId": "projectUpdateOAuth2Kick", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Kick configuration.", + "responses": { + "200": { + "description": "OAuth2Kick", + "schema": { + "$ref": "#\/definitions\/oAuth2Kick" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Kick", + "group": "oauth2", + "weight": 1178, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-kick.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { "type": "string", - "description": "Email address shown in inbox as the sender of the email.", + "description": "'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "", "x-nullable": true }, - "senderName": { + "clientSecret": { "type": "string", - "description": "Name shown in inbox as the sender of the email.", + "description": "'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "replyToEmail": { + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } + } + ] + } + }, + "\/project\/oauth2\/linkedin": { + "patch": { + "summary": "Update project OAuth2 Linkedin", + "operationId": "projectUpdateOAuth2Linkedin", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Linkedin configuration.", + "responses": { + "200": { + "description": "OAuth2Linkedin", + "schema": { + "$ref": "#\/definitions\/oAuth2Linkedin" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Linkedin", + "group": "oauth2", + "weight": 1162, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-linkedin.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { "type": "string", - "description": "Email used when user replies to the email.", + "description": "'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "", "x-nullable": true }, - "replyToName": { + "primaryClientSecret": { "type": "string", - "description": "Name used when user replies to the email.", + "description": "'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000.\/HtlYw==", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "secure": { + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } + } + ] + } + }, + "\/project\/oauth2\/microsoft": { + "patch": { + "summary": "Update project OAuth2 Microsoft", + "operationId": "projectUpdateOAuth2Microsoft", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Update the project OAuth2 Microsoft configuration.", + "responses": { + "200": { + "description": "OAuth2Microsoft", + "schema": { + "$ref": "#\/definitions\/oAuth2Microsoft" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateOAuth2Microsoft", + "group": "oauth2", + "weight": 1180, + "cookies": false, + "type": "", + "demo": "project\/update-o-auth-2-microsoft.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "oauth2.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "applicationId": { "type": "string", - "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", + "description": "'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444", "default": null, - "x-example": "tls", - "enum": [ - "tls", - "ssl" - ], - "x-enum-name": null, - "x-enum-keys": [], + "x-example": "", + "x-nullable": true + }, + "applicationSecret": { + "type": "string", + "description": "'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", + "default": null, + "x-example": "", + "x-nullable": true + }, + "tenant": { + "type": "string", + "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common", + "default": null, + "x-example": "", "x-nullable": true }, "enabled": { "type": "boolean", - "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, "x-example": false, "x-nullable": true @@ -30944,35 +31612,40 @@ ] } }, - "\/project\/smtp\/tests": { - "post": { - "summary": "Create project SMTP test", - "operationId": "projectCreateSMTPTest", + "\/project\/oauth2\/notion": { + "patch": { + "summary": "Update project OAuth2 Notion", + "operationId": "projectUpdateOAuth2Notion", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "project" ], - "description": "Send a test email to verify SMTP configuration. ", + "description": "Update the project OAuth2 Notion configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Notion", + "schema": { + "$ref": "#\/definitions\/oAuth2Notion" + } } }, "deprecated": false, "x-appwrite": { - "method": "createSMTPTest", - "group": "smtp", - "weight": 1033, + "method": "updateOAuth2Notion", + "group": "oauth2", + "weight": 1159, "cookies": false, "type": "", - "demo": "project\/create-smtp-test.md", + "demo": "project\/update-o-auth-2-notion.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -30997,28 +31670,37 @@ "schema": { "type": "object", "properties": { - "emails": { - "type": "array", - "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", + "oauthClientId": { + "type": "string", + "description": "'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3", "default": null, - "x-example": null, - "items": { - "type": "string" - } + "x-example": "", + "x-nullable": true + }, + "oauthClientSecret": { + "type": "string", + "description": "'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "emails" - ] + } } } ] } }, - "\/project\/templates\/email": { + "\/project\/oauth2\/oidc": { "patch": { - "summary": "Update project email template", - "operationId": "projectUpdateEmailTemplate", + "summary": "Update project OAuth2 Oidc", + "operationId": "projectUpdateOAuth2Oidc", "consumes": [ "application\/json" ], @@ -31028,27 +31710,27 @@ "tags": [ "project" ], - "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", + "description": "Update the project OAuth2 Oidc configuration.", "responses": { "200": { - "description": "EmailTemplate", + "description": "OAuth2Oidc", "schema": { - "$ref": "#\/definitions\/emailTemplate" + "$ref": "#\/definitions\/oAuth2Oidc" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmailTemplate", - "group": "templates", - "weight": 1035, + "method": "updateOAuth2Oidc", + "group": "oauth2", + "weight": 1176, "cookies": false, "type": "", - "demo": "project\/update-email-template.md", + "demo": "project\/update-o-auth-2-oidc.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "templates.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31073,249 +31755,99 @@ "schema": { "type": "object", "properties": { - "templateId": { + "clientId": { "type": "string", - "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", + "description": "'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG", "default": null, - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [] + "x-example": "", + "x-nullable": true }, - "locale": { + "clientSecret": { "type": "string", - "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "default": "", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [] - }, - "subject": { - "type": "string", - "description": "Subject of the email template. Can be up to 255 characters.", + "description": "'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "message": { + "wellKnownURL": { "type": "string", - "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", + "description": "OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https:\/\/myoauth.com\/.well-known\/openid-configuration", "default": null, - "x-example": "", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, - "senderName": { + "authorizationURL": { "type": "string", - "description": "Name of the email sender.", + "description": "OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/authorize", "default": null, - "x-example": "", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, - "senderEmail": { + "tokenUrl": { "type": "string", - "description": "Email of the sender.", + "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, - "replyToEmail": { + "userInfoUrl": { "type": "string", - "description": "Reply to email.", + "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", "default": null, - "x-example": "email@example.com", - "format": "email", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, - "replyToName": { - "type": "string", - "description": "Reply to name.", + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": "", + "x-example": false, "x-nullable": true } - }, - "required": [ - "templateId" - ] + } } } ] } }, - "\/project\/templates\/email\/{templateId}": { - "get": { - "summary": "Get project email template", - "operationId": "projectGetEmailTemplate", - "consumes": [], + "\/project\/oauth2\/okta": { + "patch": { + "summary": "Update project OAuth2 Okta", + "operationId": "projectUpdateOAuth2Okta", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.", + "description": "Update the project OAuth2 Okta configuration.", "responses": { "200": { - "description": "EmailTemplate", + "description": "OAuth2Okta", "schema": { - "$ref": "#\/definitions\/emailTemplate" + "$ref": "#\/definitions\/oAuth2Okta" } } }, "deprecated": false, "x-appwrite": { - "method": "getEmailTemplate", - "group": "templates", - "weight": 1034, + "method": "updateOAuth2Okta", + "group": "oauth2", + "weight": 1177, "cookies": false, "type": "", - "demo": "project\/get-email-template.md", + "demo": "project\/update-o-auth-2-okta.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "templates.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31335,203 +31867,86 @@ ], "parameters": [ { - "name": "templateId", - "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", - "required": true, - "type": "string", - "x-example": "verification", - "enum": [ - "verification", - "magicSession", - "recovery", - "invitation", - "mfaChallenge", - "sessionAlert", - "otpSession" - ], - "x-enum-name": "EmailTemplateType", - "x-enum-keys": [], - "in": "path" - }, - { - "name": "locale", - "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "required": false, - "type": "string", - "x-example": "af", - "enum": [ - "af", - "ar-ae", - "ar-bh", - "ar-dz", - "ar-eg", - "ar-iq", - "ar-jo", - "ar-kw", - "ar-lb", - "ar-ly", - "ar-ma", - "ar-om", - "ar-qa", - "ar-sa", - "ar-sy", - "ar-tn", - "ar-ye", - "as", - "az", - "be", - "bg", - "bh", - "bn", - "bs", - "ca", - "cs", - "cy", - "da", - "de", - "de-at", - "de-ch", - "de-li", - "de-lu", - "el", - "en", - "en-au", - "en-bz", - "en-ca", - "en-gb", - "en-ie", - "en-jm", - "en-nz", - "en-tt", - "en-us", - "en-za", - "eo", - "es", - "es-ar", - "es-bo", - "es-cl", - "es-co", - "es-cr", - "es-do", - "es-ec", - "es-gt", - "es-hn", - "es-mx", - "es-ni", - "es-pa", - "es-pe", - "es-pr", - "es-py", - "es-sv", - "es-uy", - "es-ve", - "et", - "eu", - "fa", - "fi", - "fo", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "fr-lu", - "ga", - "gd", - "he", - "hi", - "hr", - "hu", - "id", - "is", - "it", - "it-ch", - "ja", - "ji", - "ko", - "ku", - "lt", - "lv", - "mk", - "ml", - "ms", - "mt", - "nb", - "ne", - "nl", - "nl-be", - "nn", - "no", - "pa", - "pl", - "pt", - "pt-br", - "rm", - "ro", - "ro-md", - "ru", - "ru-md", - "sb", - "sk", - "sl", - "sq", - "sr", - "sv", - "sv-fi", - "th", - "tn", - "tr", - "ts", - "ua", - "ur", - "ve", - "vi", - "xh", - "zh-cn", - "zh-hk", - "zh-sg", - "zh-tw", - "zu" - ], - "x-enum-name": "EmailTemplateLocale", - "x-enum-keys": [], - "default": "", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "default": null, + "x-example": "", + "x-nullable": true + }, + "domain": { + "type": "string", + "description": "Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https:\/\/trial-6400025.okta.com\/", + "default": null, + "x-example": null, + "x-nullable": true + }, + "authorizationServerId": { + "type": "string", + "description": "Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/project\/variables": { - "get": { - "summary": "List project variables", - "operationId": "projectListVariables", - "consumes": [], + "\/project\/oauth2\/paypal": { + "patch": { + "summary": "Update project OAuth2 Paypal", + "operationId": "projectUpdateOAuth2Paypal", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a list of all project environment variables.", + "description": "Update the project OAuth2 Paypal configuration.", "responses": { "200": { - "description": "Variables List", + "description": "OAuth2Paypal", "schema": { - "$ref": "#\/definitions\/variableList" + "$ref": "#\/definitions\/oAuth2Paypal" } } }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 1037, + "method": "updateOAuth2Paypal", + "group": "oauth2", + "weight": 1169, "cookies": false, "type": "", - "demo": "project\/list-variables.md", + "demo": "project\/update-o-auth-2-paypal.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31551,31 +31966,42 @@ ], "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: key, resourceType, resourceId, secret", - "required": false, - "type": "array", - "collectionFormat": "multi", - "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, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "post": { - "summary": "Create project variable", - "operationId": "projectCreateVariable", + } + }, + "\/project\/oauth2\/paypalSandbox": { + "patch": { + "summary": "Update project OAuth2 PaypalSandbox", + "operationId": "projectUpdateOAuth2PaypalSandbox", "consumes": [ "application\/json" ], @@ -31585,27 +32011,27 @@ "tags": [ "project" ], - "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", + "description": "Update the project OAuth2 PaypalSandbox configuration.", "responses": { - "201": { - "description": "Variable", + "200": { + "description": "OAuth2Paypal", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/oAuth2Paypal" } } }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 1036, + "method": "updateOAuth2PaypalSandbox", + "group": "oauth2", + "weight": 1170, "cookies": false, "type": "", - "demo": "project\/create-variable.md", + "demo": "project\/update-o-auth-2-paypal-sandbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31630,73 +32056,67 @@ "schema": { "type": "object", "properties": { - "variableId": { + "clientId": { "type": "string", - "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "key": { - "type": "string", - "description": "Variable key. Max length: 255 chars.", + "description": "'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "value": { + "secretKey": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", + "description": "'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "secret": { + "enabled": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "default": true, - "x-example": false + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "variableId", - "key", - "value" - ] + } } } ] } }, - "\/project\/variables\/{variableId}": { - "get": { - "summary": "Get project variable", - "operationId": "projectGetVariable", - "consumes": [], + "\/project\/oauth2\/podio": { + "patch": { + "summary": "Update project OAuth2 Podio", + "operationId": "projectUpdateOAuth2Podio", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "project" ], - "description": "Get a variable by its unique ID. ", + "description": "Update the project OAuth2 Podio configuration.", "responses": { "200": { - "description": "Variable", + "description": "OAuth2Podio", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/oAuth2Podio" } } }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 1038, + "method": "updateOAuth2Podio", + "group": "oauth2", + "weight": 1158, "cookies": false, "type": "", - "demo": "project\/get-variable.md", + "demo": "project\/update-o-auth-2-podio.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31716,18 +32136,42 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "put": { - "summary": "Update project variable", - "operationId": "projectUpdateVariable", + } + }, + "\/project\/oauth2\/salesforce": { + "patch": { + "summary": "Update project OAuth2 Salesforce", + "operationId": "projectUpdateOAuth2Salesforce", "consumes": [ "application\/json" ], @@ -31737,27 +32181,27 @@ "tags": [ "project" ], - "description": "Update variable by its unique ID.", + "description": "Update the project OAuth2 Salesforce configuration.", "responses": { "200": { - "description": "Variable", + "description": "OAuth2Salesforce", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/oAuth2Salesforce" } } }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 1040, + "method": "updateOAuth2Salesforce", + "group": "oauth2", + "weight": 1160, "cookies": false, "type": "", - "demo": "project\/update-variable.md", + "demo": "project\/update-o-auth-2-salesforce.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31776,37 +32220,29 @@ } ], "parameters": [ - { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { + "customerKey": { "type": "string", - "description": "Variable key. Max length: 255 chars.", + "description": "'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "value": { + "customerSecret": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", + "description": "'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "secret": { + "enabled": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, "x-example": false, "x-nullable": true @@ -31815,35 +32251,42 @@ } } ] - }, - "delete": { - "summary": "Delete project variable", - "operationId": "projectDeleteVariable", + } + }, + "\/project\/oauth2\/slack": { + "patch": { + "summary": "Update project OAuth2 Slack", + "operationId": "projectUpdateOAuth2Slack", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "project" ], - "description": "Delete a variable by its unique ID. ", + "description": "Update the project OAuth2 Slack configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2Slack", + "schema": { + "$ref": "#\/definitions\/oAuth2Slack" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 1039, + "method": "updateOAuth2Slack", + "group": "oauth2", + "weight": 1157, "cookies": false, "type": "", - "demo": "project\/delete-variable.md", + "demo": "project\/update-o-auth-2-slack.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "project.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31863,48 +32306,72 @@ ], "parameters": [ { - "name": "variableId", - "description": "Variable ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/sites": { - "get": { - "summary": "List sites", - "operationId": "sitesList", - "consumes": [], + "\/project\/oauth2\/spotify": { + "patch": { + "summary": "Update project OAuth2 Spotify", + "operationId": "projectUpdateOAuth2Spotify", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a list of all the project's sites. You can use the query params to filter your results.", + "description": "Update the project OAuth2 Spotify configuration.", "responses": { "200": { - "description": "Sites List", + "description": "OAuth2Spotify", "schema": { - "$ref": "#\/definitions\/siteList" + "$ref": "#\/definitions\/oAuth2Spotify" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "sites", - "weight": 491, + "method": "updateOAuth2Spotify", + "group": "oauth2", + "weight": 1156, "cookies": false, "type": "", - "demo": "sites\/list.md", + "demo": "project\/update-o-auth-2-spotify.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -31924,40 +32391,42 @@ ], "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: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "post": { - "summary": "Create site", - "operationId": "sitesCreate", + } + }, + "\/project\/oauth2\/stripe": { + "patch": { + "summary": "Update project OAuth2 Stripe", + "operationId": "projectUpdateOAuth2Stripe", "consumes": [ "application\/json" ], @@ -31965,29 +32434,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a new site.", + "description": "Update the project OAuth2 Stripe configuration.", "responses": { - "201": { - "description": "Site", + "200": { + "description": "OAuth2Stripe", "schema": { - "$ref": "#\/definitions\/site" + "$ref": "#\/definitions\/oAuth2Stripe" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "sites", - "weight": 848, + "method": "updateOAuth2Stripe", + "group": "oauth2", + "weight": 1155, "cookies": false, "type": "", - "demo": "sites\/create.md", + "demo": "project\/update-o-auth-2-stripe.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32012,298 +32481,67 @@ "schema": { "type": "object", "properties": { - "siteId": { - "type": "string", - "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { + "clientId": { "type": "string", - "description": "Site name. Max length: 128 chars.", + "description": "'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "framework": { + "apiSecretKey": { "type": "string", - "description": "Sites framework.", + "description": "'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp", "default": null, - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] + "x-example": "", + "x-nullable": true }, "enabled": { "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "default": true, - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "default": true, - "x-example": false - }, - "timeout": { - "type": "integer", - "description": "Maximum request time in seconds.", - "default": 30, - "x-example": 1, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "Install Command.", - "default": "", - "x-example": "" - }, - "buildCommand": { - "type": "string", - "description": "Build Command.", - "default": "", - "x-example": "" - }, - "startCommand": { - "type": "string", - "description": "Custom start command. Leave empty to use default.", - "default": "", - "x-example": "" - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory for site.", - "default": "", - "x-example": "" - }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", "default": null, - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dart-3.11", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "flutter-3.41" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "default": "", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "default": "", - "x-example": "" - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "default": "", - "x-example": "" - }, - "providerRepositoryId": { - "type": "string", - "description": "Repository ID of the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerBranch": { - "type": "string", - "description": "Production branch for the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", - "default": false, - "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "default": "", - "x-example": "" - }, - "buildSpecification": { - "type": "string", - "description": "Build specification for the site deployments.", - "default": {}, - "x-example": null - }, - "runtimeSpecification": { - "type": "string", - "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null - }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "default": 0, - "x-example": 0, - "format": "int32" + "x-example": false, + "x-nullable": true } - }, - "required": [ - "siteId", - "name", - "framework", - "buildRuntime" - ] + } } } ] } }, - "\/sites\/frameworks": { - "get": { - "summary": "List frameworks", - "operationId": "sitesListFrameworks", - "consumes": [], + "\/project\/oauth2\/tradeshift": { + "patch": { + "summary": "Update project OAuth2 Tradeshift", + "operationId": "projectUpdateOAuth2Tradeshift", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a list of all frameworks that are currently available on the server instance.", + "description": "Update the project OAuth2 Tradeshift configuration.", "responses": { "200": { - "description": "Frameworks List", + "description": "OAuth2Tradeshift", "schema": { - "$ref": "#\/definitions\/frameworkList" + "$ref": "#\/definitions\/oAuth2Tradeshift" } } }, "deprecated": false, "x-appwrite": { - "method": "listFrameworks", - "group": "frameworks", - "weight": 494, + "method": "updateOAuth2Tradeshift", + "group": "oauth2", + "weight": 1167, "cookies": false, "type": "", - "demo": "sites\/list-frameworks.md", + "demo": "project\/update-o-auth-2-tradeshift.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32320,44 +32558,78 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "oauth2ClientId": { + "type": "string", + "description": "'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app", + "default": null, + "x-example": "", + "x-nullable": true + }, + "oauth2ClientSecret": { + "type": "string", + "description": "'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } + } ] } }, - "\/sites\/specifications": { - "get": { - "summary": "List specifications", - "operationId": "sitesListSpecifications", - "consumes": [], + "\/project\/oauth2\/tradeshiftBox": { + "patch": { + "summary": "Update project OAuth2 Tradeshift Sandbox", + "operationId": "projectUpdateOAuth2TradeshiftSandbox", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "List allowed site specifications for this instance.", + "description": "Update the project OAuth2 Tradeshift Sandbox configuration.", "responses": { "200": { - "description": "Specifications List", + "description": "OAuth2Tradeshift", "schema": { - "$ref": "#\/definitions\/specificationList" + "$ref": "#\/definitions\/oAuth2Tradeshift" } } }, "deprecated": false, "x-appwrite": { - "method": "listSpecifications", - "group": "frameworks", - "weight": 517, + "method": "updateOAuth2TradeshiftSandbox", + "group": "oauth2", + "weight": 1168, "cookies": false, "type": "", - "demo": "sites\/list-specifications.md", + "demo": "project\/update-o-auth-2-tradeshift-sandbox.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "oauth2.write", "platforms": [ - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -32371,41 +32643,75 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "oauth2ClientId": { + "type": "string", + "description": "'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app", + "default": null, + "x-example": "", + "x-nullable": true + }, + "oauth2ClientSecret": { + "type": "string", + "description": "'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } + } ] } }, - "\/sites\/{siteId}": { - "get": { - "summary": "Get site", - "operationId": "sitesGet", - "consumes": [], + "\/project\/oauth2\/twitch": { + "patch": { + "summary": "Update project OAuth2 Twitch", + "operationId": "projectUpdateOAuth2Twitch", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a site by its unique ID.", + "description": "Update the project OAuth2 Twitch configuration.", "responses": { "200": { - "description": "Site", + "description": "OAuth2Twitch", "schema": { - "$ref": "#\/definitions\/site" + "$ref": "#\/definitions\/oAuth2Twitch" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "sites", - "weight": 490, + "method": "updateOAuth2Twitch", + "group": "oauth2", + "weight": 1154, "cookies": false, "type": "", - "demo": "sites\/get.md", + "demo": "project\/update-o-auth-2-twitch.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32425,18 +32731,42 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "put": { - "summary": "Update site", - "operationId": "sitesUpdate", + } + }, + "\/project\/oauth2\/wordpress": { + "patch": { + "summary": "Update project OAuth2 WordPress", + "operationId": "projectUpdateOAuth2WordPress", "consumes": [ "application\/json" ], @@ -32444,29 +32774,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Update site by its unique ID.", + "description": "Update the project OAuth2 WordPress configuration.", "responses": { "200": { - "description": "Site", + "description": "OAuth2WordPress", "schema": { - "$ref": "#\/definitions\/site" + "$ref": "#\/definitions\/oAuth2WordPress" } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "sites", - "weight": 849, + "method": "updateOAuth2WordPress", + "group": "oauth2", + "weight": 1153, "cookies": false, "type": "", - "demo": "sites\/update.md", + "demo": "project\/update-o-auth-2-word-press.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32485,299 +32815,73 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "clientId": { "type": "string", - "description": "Site name. Max length: 128 chars.", + "description": "'Client ID' of WordPress OAuth2 app. For example: 130005", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "framework": { + "clientSecret": { "type": "string", - "description": "Sites framework.", + "description": "'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk", "default": null, - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] + "x-example": "", + "x-nullable": true }, "enabled": { "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "default": true, - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "default": true, - "x-example": false - }, - "timeout": { - "type": "integer", - "description": "Maximum request time in seconds.", - "default": 30, - "x-example": 1, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "Install Command.", - "default": "", - "x-example": "" - }, - "buildCommand": { - "type": "string", - "description": "Build Command.", - "default": "", - "x-example": "" - }, - "startCommand": { - "type": "string", - "description": "Custom start command. Leave empty to use default.", - "default": "", - "x-example": "" - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory for site.", - "default": "", - "x-example": "" - }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", - "default": "", - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.21", - "deno-1.24", - "deno-1.35", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dart-3.11", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "flutter-3.41" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "default": "", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "default": "", - "x-example": "" - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "default": "", - "x-example": "" - }, - "providerRepositoryId": { - "type": "string", - "description": "Repository ID of the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerBranch": { - "type": "string", - "description": "Production branch for the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", - "default": false, - "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "default": "", - "x-example": "" - }, - "buildSpecification": { - "type": "string", - "description": "Build specification for the site deployments.", - "default": {}, - "x-example": null - }, - "runtimeSpecification": { - "type": "string", - "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null - }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "default": 0, - "x-example": 0, - "format": "int32" + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "name", - "framework" - ] + } } } ] - }, - "delete": { - "summary": "Delete site", - "operationId": "sitesDelete", + } + }, + "\/project\/oauth2\/x": { + "patch": { + "summary": "Update project OAuth2 X", + "operationId": "projectUpdateOAuth2X", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "sites" + "project" ], - "description": "Delete a site by its unique ID.", + "description": "Update the project OAuth2 X configuration.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "OAuth2X", + "schema": { + "$ref": "#\/definitions\/oAuth2X" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "sites", - "weight": 493, + "method": "updateOAuth2X", + "group": "oauth2", + "weight": 1152, "cookies": false, "type": "", - "demo": "sites\/delete.md", + "demo": "project\/update-o-auth-2x.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32797,20 +32901,42 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "customerKey": { + "type": "string", + "description": "'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secretKey": { + "type": "string", + "description": "'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/sites\/{siteId}\/deployment": { + "\/project\/oauth2\/yahoo": { "patch": { - "summary": "Update site's deployment", - "operationId": "sitesUpdateSiteDeployment", + "summary": "Update project OAuth2 Yahoo", + "operationId": "projectUpdateOAuth2Yahoo", "consumes": [ "application\/json" ], @@ -32818,29 +32944,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "description": "Update the project OAuth2 Yahoo configuration.", "responses": { "200": { - "description": "Site", + "description": "OAuth2Yahoo", "schema": { - "$ref": "#\/definitions\/site" + "$ref": "#\/definitions\/oAuth2Yahoo" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSiteDeployment", - "group": "sites", - "weight": 500, + "method": "updateOAuth2Yahoo", + "group": "oauth2", + "weight": 1161, "cookies": false, "type": "", - "demo": "sites\/update-site-deployment.md", + "demo": "project\/update-o-auth-2-yahoo.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32859,67 +32985,73 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "deploymentId": { + "clientId": { "type": "string", - "description": "Deployment ID.", + "description": "'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "deploymentId" - ] + } } } ] } }, - "\/sites\/{siteId}\/deployments": { - "get": { - "summary": "List deployments", - "operationId": "sitesListDeployments", - "consumes": [], + "\/project\/oauth2\/yandex": { + "patch": { + "summary": "Update project OAuth2 Yandex", + "operationId": "projectUpdateOAuth2Yandex", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", + "description": "Update the project OAuth2 Yandex configuration.", "responses": { "200": { - "description": "Deployments List", + "description": "OAuth2Yandex", "schema": { - "$ref": "#\/definitions\/deploymentList" + "$ref": "#\/definitions\/oAuth2Yandex" } } }, "deprecated": false, "x-appwrite": { - "method": "listDeployments", - "group": "deployments", - "weight": 499, + "method": "updateOAuth2Yandex", + "group": "oauth2", + "weight": 1151, "cookies": false, "type": "", - "demo": "sites\/list-deployments.md", + "demo": "project\/update-o-auth-2-yandex.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -32939,83 +33071,77 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, - "post": { - "summary": "Create deployment", - "operationId": "sitesCreateDeployment", + } + }, + "\/project\/oauth2\/zoho": { + "patch": { + "summary": "Update project OAuth2 Zoho", + "operationId": "projectUpdateOAuth2Zoho", "consumes": [ - "multipart\/form-data" + "application\/json" ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.", + "description": "Update the project OAuth2 Zoho configuration.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "OAuth2Zoho", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/oAuth2Zoho" } } }, "deprecated": false, "x-appwrite": { - "method": "createDeployment", - "group": "deployments", - "weight": 495, + "method": "updateOAuth2Zoho", + "group": "oauth2", + "weight": 1150, "cookies": false, - "type": "upload", - "demo": "sites\/create-deployment.md", + "type": "", + "demo": "project\/update-o-auth-2-zoho.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" ], - "packaging": true, + "packaging": false, "public": true, "auth": { "Project": [], @@ -33030,60 +33156,42 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "installCommand", - "description": "Install Commands.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "buildCommand", - "description": "Build Commands.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "outputDirectory", - "description": "Output Directory.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "code", - "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "required": true, - "type": "file", - "in": "formData" - }, - { - "name": "activate", - "description": "Automatically activate the deployment when it is finished building.", - "required": false, - "type": "boolean", - "x-example": false, - "default": false, - "in": "formData" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B", + "default": null, + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] } }, - "\/sites\/{siteId}\/deployments\/duplicate": { - "post": { - "summary": "Create duplicate deployment", - "operationId": "sitesCreateDuplicateDeployment", + "\/project\/oauth2\/zoom": { + "patch": { + "summary": "Update project OAuth2 Zoom", + "operationId": "projectUpdateOAuth2Zoom", "consumes": [ "application\/json" ], @@ -33091,29 +33199,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.", + "description": "Update the project OAuth2 Zoom configuration.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "OAuth2Zoom", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/oAuth2Zoom" } } }, "deprecated": false, "x-appwrite": { - "method": "createDuplicateDeployment", - "group": "deployments", - "weight": 503, + "method": "updateOAuth2Zoom", + "group": "oauth2", + "weight": 1149, "cookies": false, "type": "", - "demo": "sites\/create-duplicate-deployment.md", + "demo": "project\/update-o-auth-2-zoom.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.write", "platforms": [ "console", "server" @@ -33132,69 +33240,239 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "deploymentId": { + "clientId": { "type": "string", - "description": "Deployment ID.", + "description": "'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true + }, + "clientSecret": { + "type": "string", + "description": "'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON", + "default": null, + "x-example": "", + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", + "default": null, + "x-example": false, + "x-nullable": true } - }, - "required": [ - "deploymentId" - ] + } } } ] } }, - "\/sites\/{siteId}\/deployments\/template": { - "post": { - "summary": "Create template deployment", - "operationId": "sitesCreateTemplateDeployment", - "consumes": [ - "application\/json" - ], + "\/project\/oauth2\/{provider}": { + "get": { + "summary": "Get project OAuth2 provider", + "operationId": "projectGetOAuth2Provider", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", + "description": "Get a single OAuth2 provider configuration. Credential fields (client secret, p8 file, key\/team IDs) are write-only and always returned empty.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "OAuth2GitHub, or OAuth2Discord, or OAuth2Figma, or OAuth2Dropbox, or OAuth2Dailymotion, or OAuth2Bitbucket, or OAuth2Bitly, or OAuth2Box, or OAuth2Autodesk, or OAuth2Google, or OAuth2Zoom, or OAuth2Zoho, or OAuth2Yandex, or OAuth2X, or OAuth2WordPress, or OAuth2Twitch, or OAuth2Stripe, or OAuth2Spotify, or OAuth2Slack, or OAuth2Podio, or OAuth2Notion, or OAuth2Salesforce, or OAuth2Yahoo, or OAuth2Linkedin, or OAuth2Disqus, or OAuth2Amazon, or OAuth2Etsy, or OAuth2Facebook, or OAuth2Tradeshift, or OAuth2Paypal, or OAuth2Gitlab, or OAuth2Authentik, or OAuth2Auth0, or OAuth2FusionAuth, or OAuth2Keycloak, or OAuth2Oidc, or OAuth2Apple, or OAuth2Okta, or OAuth2Kick, or OAuth2Microsoft", "schema": { - "$ref": "#\/definitions\/deployment" + "x-oneOf": [ + { + "$ref": "#\/definitions\/oAuth2Github" + }, + { + "$ref": "#\/definitions\/oAuth2Discord" + }, + { + "$ref": "#\/definitions\/oAuth2Figma" + }, + { + "$ref": "#\/definitions\/oAuth2Dropbox" + }, + { + "$ref": "#\/definitions\/oAuth2Dailymotion" + }, + { + "$ref": "#\/definitions\/oAuth2Bitbucket" + }, + { + "$ref": "#\/definitions\/oAuth2Bitly" + }, + { + "$ref": "#\/definitions\/oAuth2Box" + }, + { + "$ref": "#\/definitions\/oAuth2Autodesk" + }, + { + "$ref": "#\/definitions\/oAuth2Google" + }, + { + "$ref": "#\/definitions\/oAuth2Zoom" + }, + { + "$ref": "#\/definitions\/oAuth2Zoho" + }, + { + "$ref": "#\/definitions\/oAuth2Yandex" + }, + { + "$ref": "#\/definitions\/oAuth2X" + }, + { + "$ref": "#\/definitions\/oAuth2WordPress" + }, + { + "$ref": "#\/definitions\/oAuth2Twitch" + }, + { + "$ref": "#\/definitions\/oAuth2Stripe" + }, + { + "$ref": "#\/definitions\/oAuth2Spotify" + }, + { + "$ref": "#\/definitions\/oAuth2Slack" + }, + { + "$ref": "#\/definitions\/oAuth2Podio" + }, + { + "$ref": "#\/definitions\/oAuth2Notion" + }, + { + "$ref": "#\/definitions\/oAuth2Salesforce" + }, + { + "$ref": "#\/definitions\/oAuth2Yahoo" + }, + { + "$ref": "#\/definitions\/oAuth2Linkedin" + }, + { + "$ref": "#\/definitions\/oAuth2Disqus" + }, + { + "$ref": "#\/definitions\/oAuth2Amazon" + }, + { + "$ref": "#\/definitions\/oAuth2Etsy" + }, + { + "$ref": "#\/definitions\/oAuth2Facebook" + }, + { + "$ref": "#\/definitions\/oAuth2Tradeshift" + }, + { + "$ref": "#\/definitions\/oAuth2Paypal" + }, + { + "$ref": "#\/definitions\/oAuth2Gitlab" + }, + { + "$ref": "#\/definitions\/oAuth2Authentik" + }, + { + "$ref": "#\/definitions\/oAuth2Auth0" + }, + { + "$ref": "#\/definitions\/oAuth2FusionAuth" + }, + { + "$ref": "#\/definitions\/oAuth2Keycloak" + }, + { + "$ref": "#\/definitions\/oAuth2Oidc" + }, + { + "$ref": "#\/definitions\/oAuth2Apple" + }, + { + "$ref": "#\/definitions\/oAuth2Okta" + }, + { + "$ref": "#\/definitions\/oAuth2Kick" + }, + { + "$ref": "#\/definitions\/oAuth2Microsoft" + } + ], + "x-discriminator": { + "propertyName": "$id", + "mapping": { + "github": "#\/definitions\/oAuth2Github", + "discord": "#\/definitions\/oAuth2Discord", + "figma": "#\/definitions\/oAuth2Figma", + "dropbox": "#\/definitions\/oAuth2Dropbox", + "dailymotion": "#\/definitions\/oAuth2Dailymotion", + "bitbucket": "#\/definitions\/oAuth2Bitbucket", + "bitly": "#\/definitions\/oAuth2Bitly", + "box": "#\/definitions\/oAuth2Box", + "autodesk": "#\/definitions\/oAuth2Autodesk", + "google": "#\/definitions\/oAuth2Google", + "zoom": "#\/definitions\/oAuth2Zoom", + "zoho": "#\/definitions\/oAuth2Zoho", + "yandex": "#\/definitions\/oAuth2Yandex", + "x": "#\/definitions\/oAuth2X", + "wordpress": "#\/definitions\/oAuth2WordPress", + "twitch": "#\/definitions\/oAuth2Twitch", + "stripe": "#\/definitions\/oAuth2Stripe", + "spotify": "#\/definitions\/oAuth2Spotify", + "slack": "#\/definitions\/oAuth2Slack", + "podio": "#\/definitions\/oAuth2Podio", + "notion": "#\/definitions\/oAuth2Notion", + "salesforce": "#\/definitions\/oAuth2Salesforce", + "yahoo": "#\/definitions\/oAuth2Yahoo", + "linkedin": "#\/definitions\/oAuth2Linkedin", + "disqus": "#\/definitions\/oAuth2Disqus", + "amazon": "#\/definitions\/oAuth2Amazon", + "etsy": "#\/definitions\/oAuth2Etsy", + "facebook": "#\/definitions\/oAuth2Facebook", + "tradeshift": "#\/definitions\/oAuth2Tradeshift", + "tradeshiftBox": "#\/definitions\/oAuth2Tradeshift", + "paypal": "#\/definitions\/oAuth2Paypal", + "paypalSandbox": "#\/definitions\/oAuth2Paypal", + "gitlab": "#\/definitions\/oAuth2Gitlab", + "authentik": "#\/definitions\/oAuth2Authentik", + "auth0": "#\/definitions\/oAuth2Auth0", + "fusionauth": "#\/definitions\/oAuth2FusionAuth", + "keycloak": "#\/definitions\/oAuth2Keycloak", + "oidc": "#\/definitions\/oAuth2Oidc", + "apple": "#\/definitions\/oAuth2Apple", + "okta": "#\/definitions\/oAuth2Okta", + "kick": "#\/definitions\/oAuth2Kick", + "microsoft": "#\/definitions\/oAuth2Microsoft" + } + } } } }, "deprecated": false, "x-appwrite": { - "method": "createTemplateDeployment", - "group": "deployments", - "weight": 496, + "method": "getOAuth2Provider", + "group": "oauth2", + "weight": 1138, "cookies": false, "type": "", - "demo": "sites\/create-template-deployment.md", + "demo": "project\/get-o-auth-2-provider.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "oauth2.read", "platforms": [ "console", "server" @@ -33214,79 +33492,94 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "provider", + "description": "OAuth2 provider key. For example: github, google, apple.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", + } + ] + } + }, + "\/project\/platforms": { + "get": { + "summary": "List project platforms", + "operationId": "projectListPlatforms", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.", + "responses": { + "200": { + "description": "Platforms List", "schema": { - "type": "object", - "properties": { - "repository": { - "type": "string", - "description": "Repository name of the template.", - "default": null, - "x-example": "" - }, - "owner": { - "type": "string", - "description": "The name of the owner of the template.", - "default": null, - "x-example": "" - }, - "rootDirectory": { - "type": "string", - "description": "Path to site code in the template repo.", - "default": null, - "x-example": "" - }, - "type": { - "type": "string", - "description": "Type for the reference provided. Can be commit, branch, or tag", - "default": null, - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "TemplateReferenceType", - "x-enum-keys": [] - }, - "reference": { - "type": "string", - "description": "Reference value, can be a commit hash, branch name, or release tag", - "default": null, - "x-example": "" - }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "default": false, - "x-example": false - } - }, - "required": [ - "repository", - "owner", - "rootDirectory", - "type", - "reference" - ] + "$ref": "#\/definitions\/platformList" } } + }, + "deprecated": false, + "x-appwrite": { + "method": "listPlatforms", + "group": "platforms", + "weight": 1119, + "cookies": false, + "type": "", + "demo": "project\/list-platforms.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "platforms.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } ] } }, - "\/sites\/{siteId}\/deployments\/vcs": { + "\/project\/platforms\/android": { "post": { - "summary": "Create VCS deployment", - "operationId": "sitesCreateVcsDeployment", + "summary": "Create project Android platform", + "operationId": "projectCreateAndroidPlatform", "consumes": [ "application\/json" ], @@ -33294,29 +33587,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", + "description": "Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "202": { - "description": "Deployment", + "201": { + "description": "Platform Android", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/platformAndroid" } } }, "deprecated": false, "x-appwrite": { - "method": "createVcsDeployment", - "group": "deployments", - "weight": 497, + "method": "createAndroidPlatform", + "group": "platforms", + "weight": 1115, "cookies": false, "type": "", - "demo": "sites\/create-vcs-deployment.md", + "demo": "project\/create-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33335,87 +33628,75 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "type": { + "platformId": { "type": "string", - "description": "Type of reference passed. Allowed values are: branch, commit", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "VCSReferenceType", - "x-enum-keys": [] + "x-example": "" }, - "reference": { + "name": { "type": "string", - "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "default": false, - "x-example": false + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "default": null, + "x-example": "" } }, "required": [ - "type", - "reference" + "platformId", + "name", + "applicationId" ] } } ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}": { - "get": { - "summary": "Get deployment", - "operationId": "sitesGetDeployment", - "consumes": [], + "\/project\/platforms\/android\/{platformId}": { + "put": { + "summary": "Update project Android platform", + "operationId": "projectUpdateAndroidPlatform", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a site deployment by its unique ID.", + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", "responses": { "200": { - "description": "Deployment", + "description": "Platform Android", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/platformAndroid" } } }, "deprecated": false, "x-appwrite": { - "method": "getDeployment", - "group": "deployments", - "weight": 498, + "method": "updateAndroidPlatform", + "group": "platforms", + "weight": 1110, "cookies": false, "type": "", - "demo": "sites\/get-deployment.md", + "demo": "project\/update-android-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33435,51 +33716,75 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "applicationId": { + "type": "string", + "description": "Android application ID. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "applicationId" + ] + } } ] - }, - "delete": { - "summary": "Delete deployment", - "operationId": "sitesDeleteDeployment", + } + }, + "\/project\/platforms\/apple": { + "post": { + "summary": "Create project Apple platform", + "operationId": "projectCreateApplePlatform", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "sites" + "project" ], - "description": "Delete a site deployment by its unique ID.", + "description": "Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Platform Apple", + "schema": { + "$ref": "#\/definitions\/platformApple" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDeployment", - "group": "deployments", - "weight": 501, + "method": "createApplePlatform", + "group": "platforms", + "weight": 1114, "cookies": false, "type": "", - "demo": "sites\/delete-deployment.md", + "demo": "project\/create-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33499,56 +33804,74 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "bundleIdentifier" + ] + } } ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { - "get": { - "summary": "Get deployment download", - "operationId": "sitesGetDeploymentDownload", - "consumes": [], + "\/project\/platforms\/apple\/{platformId}": { + "put": { + "summary": "Update project Apple platform", + "operationId": "projectUpdateApplePlatform", + "consumes": [ + "application\/json" + ], "produces": [ - "*\/*" + "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "description": "Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.", "responses": { "200": { - "description": "File", + "description": "Platform Apple", "schema": { - "type": "file" + "$ref": "#\/definitions\/platformApple" } } }, "deprecated": false, "x-appwrite": { - "method": "getDeploymentDownload", - "group": "deployments", - "weight": 502, + "method": "updateApplePlatform", + "group": "platforms", + "weight": 1109, "cookies": false, - "type": "location", - "demo": "sites\/get-deployment-download.md", + "type": "", + "demo": "project\/update-apple-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33563,49 +33886,50 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "type", - "description": "Deployment file to download. Can be: \"source\", \"output\".", - "required": false, - "type": "string", - "x-example": "source", - "enum": [ - "source", - "output" - ], - "x-enum-name": "DeploymentDownloadType", - "x-enum-keys": [], - "default": "source", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "bundleIdentifier": { + "type": "string", + "description": "Apple bundle identifier. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "bundleIdentifier" + ] + } } ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { - "patch": { - "summary": "Update deployment status", - "operationId": "sitesUpdateDeploymentStatus", + "\/project\/platforms\/linux": { + "post": { + "summary": "Create project Linux platform", + "operationId": "projectCreateLinuxPlatform", "consumes": [ "application\/json" ], @@ -33613,29 +33937,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", + "description": "Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Deployment", + "201": { + "description": "Platform Linux", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/platformLinux" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDeploymentStatus", - "group": "deployments", - "weight": 504, + "method": "createLinuxPlatform", + "group": "platforms", + "weight": 1117, "cookies": false, "type": "", - "demo": "sites\/update-deployment-status.md", + "demo": "project\/create-linux-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33655,56 +33979,74 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageName" + ] + } } ] } }, - "\/sites\/{siteId}\/logs": { - "get": { - "summary": "List logs", - "operationId": "sitesListLogs", - "consumes": [], + "\/project\/platforms\/linux\/{platformId}": { + "put": { + "summary": "Update project Linux platform", + "operationId": "projectUpdateLinuxPlatform", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a list of all site logs. You can use the query params to filter your results.", + "description": "Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.", "responses": { "200": { - "description": "Executions List", + "description": "Platform Linux", "schema": { - "$ref": "#\/definitions\/executionList" + "$ref": "#\/definitions\/platformLinux" } } }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 506, + "method": "updateLinuxPlatform", + "group": "platforms", + "weight": 1112, "cookies": false, "type": "", - "demo": "sites\/list-logs.md", + "demo": "project\/update-linux-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33724,69 +34066,75 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", - "required": false, - "type": "array", - "collectionFormat": "multi", - "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, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageName": { + "type": "string", + "description": "Linux package name. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name", + "packageName" + ] + } } ] } }, - "\/sites\/{siteId}\/logs\/{logId}": { - "get": { - "summary": "Get log", - "operationId": "sitesGetLog", - "consumes": [], + "\/project\/platforms\/web": { + "post": { + "summary": "Create project web platform", + "operationId": "projectCreateWebPlatform", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a site request log by its unique ID.", + "description": "Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Execution", + "201": { + "description": "Platform Web", "schema": { - "$ref": "#\/definitions\/execution" + "$ref": "#\/definitions\/platformWeb" } } }, "deprecated": false, "x-appwrite": { - "method": "getLog", - "group": "logs", - "weight": 505, + "method": "createWebPlatform", + "group": "platforms", + "weight": 1113, "cookies": false, "type": "", - "demo": "sites\/get-log.md", + "demo": "project\/create-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33806,26 +34154,44 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "default": null, + "x-example": "app.example.com" + } + }, + "required": [ + "platformId", + "name", + "hostname" + ] + } } ] - }, - "delete": { - "summary": "Delete log", - "operationId": "sitesDeleteLog", + } + }, + "\/project\/platforms\/web\/{platformId}": { + "put": { + "summary": "Update project web platform", + "operationId": "projectUpdateWebPlatform", "consumes": [ "application\/json" ], @@ -33833,26 +34199,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Delete a site log by its unique ID.", + "description": "Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Platform Web", + "schema": { + "$ref": "#\/definitions\/platformWeb" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteLog", - "group": "logs", - "weight": 507, + "method": "updateWebPlatform", + "group": "platforms", + "weight": 1108, "cookies": false, "type": "", - "demo": "sites\/delete-log.md", + "demo": "project\/update-web-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33872,56 +34241,75 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "logId", - "description": "Log ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "hostname": { + "type": "string", + "description": "Platform web hostname. Max length: 256 chars.", + "default": null, + "x-example": "app.example.com" + } + }, + "required": [ + "name", + "hostname" + ] + } } ] } }, - "\/sites\/{siteId}\/variables": { - "get": { - "summary": "List variables", - "operationId": "sitesListVariables", - "consumes": [], + "\/project\/platforms\/windows": { + "post": { + "summary": "Create project Windows platform", + "operationId": "projectCreateWindowsPlatform", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Get a list of all variables of a specific site.", + "description": "Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.", "responses": { - "200": { - "description": "Variables List", + "201": { + "description": "Platform Windows", "schema": { - "$ref": "#\/definitions\/variableList" + "$ref": "#\/definitions\/platformWindows" } } }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 510, + "method": "createWindowsPlatform", + "group": "platforms", + "weight": 1116, "cookies": false, "type": "", - "demo": "sites\/list-variables.md", + "demo": "project\/create-windows-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -33941,18 +34329,44 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "platformId": { + "type": "string", + "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Platform name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "packageIdentifierName": { + "type": "string", + "description": "Windows package identifier name. Max length: 256 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "platformId", + "name", + "packageIdentifierName" + ] + } } ] - }, - "post": { - "summary": "Create variable", - "operationId": "sitesCreateVariable", + } + }, + "\/project\/platforms\/windows\/{platformId}": { + "put": { + "summary": "Update project Windows platform", + "operationId": "projectUpdateWindowsPlatform", "consumes": [ "application\/json" ], @@ -33960,29 +34374,29 @@ "application\/json" ], "tags": [ - "sites" + "project" ], - "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", + "description": "Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.", "responses": { - "201": { - "description": "Variable", + "200": { + "description": "Platform Windows", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/platformWindows" } } }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 850, + "method": "updateWindowsPlatform", + "group": "platforms", + "weight": 1111, "cookies": false, "type": "", - "demo": "sites\/create-variable.md", + "demo": "project\/update-windows-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -34002,11 +34416,11 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -34015,135 +34429,86 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Variable key. Max length: 255 chars.", + "description": "Platform name. Max length: 128 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "value": { + "packageIdentifierName": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", + "description": "Windows package identifier name. Max length: 256 chars.", "default": null, - "x-example": "" - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "default": true, - "x-example": false + "x-example": "" } }, "required": [ - "key", - "value" + "name", + "packageIdentifierName" ] } } ] } }, - "\/sites\/{siteId}\/variables\/{variableId}": { + "\/project\/platforms\/{platformId}": { "get": { - "summary": "Get variable", - "operationId": "sitesGetVariable", + "summary": "Get project platform", + "operationId": "projectGetPlatform", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "sites" - ], - "description": "Get a variable by its unique ID.", - "responses": { - "200": { - "description": "Variable", - "schema": { - "$ref": "#\/definitions\/variable" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 509, - "cookies": false, - "type": "", - "demo": "sites\/get-variable.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "variableId", - "description": "Variable unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "put": { - "summary": "Update variable", - "operationId": "sitesUpdateVariable", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" + "project" ], - "description": "Update variable by its unique ID.", + "description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.", "responses": { "200": { - "description": "Variable", + "description": "Platform Web, or Platform Apple, or Platform Android, or Platform Windows, or Platform Linux", "schema": { - "$ref": "#\/definitions\/variable" + "x-oneOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "web": "#\/definitions\/platformWeb", + "apple": "#\/definitions\/platformApple", + "android": "#\/definitions\/platformAndroid", + "windows": "#\/definitions\/platformWindows", + "linux": "#\/definitions\/platformLinux" + } + } } } }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 511, + "method": "getPlatform", + "group": "platforms", + "weight": 1118, "cookies": false, "type": "", - "demo": "sites\/update-variable.md", + "demo": "project\/get-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.read", "platforms": [ "console", "server" @@ -34163,66 +34528,26 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "variableId", - "description": "Variable unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Variable key. Max length: 255 chars.", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "default": null, - "x-example": false, - "x-nullable": true - } - }, - "required": [ - "key" - ] - } } ] }, "delete": { - "summary": "Delete variable", - "operationId": "sitesDeleteVariable", + "summary": "Delete project platform", + "operationId": "projectDeletePlatform", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "sites" + "project" ], - "description": "Delete a variable by its unique ID.", + "description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.", "responses": { "204": { "description": "No content" @@ -34230,16 +34555,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 512, + "method": "deletePlatform", + "group": "platforms", + "weight": 1107, "cookies": false, "type": "", - "demo": "sites\/delete-variable.md", + "demo": "project\/delete-platform.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "platforms.write", "platforms": [ "console", "server" @@ -34259,63 +34584,54 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "variableId", - "description": "Variable unique ID.", + "name": "platformId", + "description": "Platform ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/storage\/buckets": { + "\/project\/policies": { "get": { - "summary": "List buckets", - "operationId": "storageListBuckets", + "summary": "List project policies", + "operationId": "projectListPolicies", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", + "description": "Get a list of all project policies and their current configuration.", "responses": { "200": { - "description": "Buckets List", + "description": "Policies List", "schema": { - "$ref": "#\/definitions\/bucketList" + "$ref": "#\/definitions\/policyList" } } }, "deprecated": false, "x-appwrite": { - "method": "listBuckets", - "group": "buckets", - "weight": 558, + "method": "listPolicies", + "group": "policies", + "weight": 1125, "cookies": false, "type": "", - "demo": "storage\/list-buckets.md", + "demo": "project\/list-policies.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "policies.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [], "Key": [] @@ -34330,7 +34646,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "type": "array", "collectionFormat": "multi", @@ -34340,15 +34656,6 @@ "default": [], "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -34359,10 +34666,12 @@ "in": "query" } ] - }, - "post": { - "summary": "Create bucket", - "operationId": "storageCreateBucket", + } + }, + "\/project\/policies\/membership-privacy": { + "patch": { + "summary": "Update membership privacy policy", + "operationId": "projectUpdateMembershipPrivacyPolicy", "consumes": [ "application\/json" ], @@ -34370,36 +34679,35 @@ "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Create a new storage bucket.", + "description": "Updating this policy allows you to control if team members can see other members information. When enabled, all team members can see ID, name, email, phone number, and MFA status of other members..", "responses": { - "201": { - "description": "Bucket", + "200": { + "description": "Project", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "createBucket", - "group": "buckets", - "weight": 556, + "method": "updateMembershipPrivacyPolicy", + "group": "policies", + "weight": 1127, "cookies": false, "type": "", - "demo": "storage\/create-bucket.md", + "demo": "project\/update-membership-privacy-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "policies.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", "auth": { "Project": [], "Key": [] @@ -34418,136 +34726,82 @@ "schema": { "type": "object", "properties": { - "bucketId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Bucket name", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "fileSecurity": { + "userId": { "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, + "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", + "default": null, "x-example": false }, - "enabled": { + "userEmail": { "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, + "description": "Set to true if you want make user email visible to all team members, or false to hide it.", + "default": null, "x-example": false }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "default": {}, - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "encryption": { + "userPhone": { "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, + "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", + "default": null, "x-example": false }, - "antivirus": { + "userName": { "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, + "description": "Set to true if you want make user name visible to all team members, or false to hide it.", + "default": null, "x-example": false }, - "transformations": { + "userMFA": { "type": "boolean", - "description": "Are image transformations enabled?", - "default": true, + "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", + "default": null, "x-example": false } - }, - "required": [ - "bucketId", - "name" - ] + } } } ] } }, - "\/storage\/buckets\/{bucketId}": { - "get": { - "summary": "Get bucket", - "operationId": "storageGetBucket", - "consumes": [], + "\/project\/policies\/password-dictionary": { + "patch": { + "summary": "Update password dictionary policy", + "operationId": "projectUpdatePasswordDictionaryPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", + "description": "Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.", "responses": { "200": { - "description": "Bucket", + "description": "Project", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getBucket", - "group": "buckets", - "weight": 557, + "method": "updatePasswordDictionaryPolicy", + "group": "policies", + "weight": 1128, "cookies": false, "type": "", - "demo": "storage\/get-bucket.md", + "demo": "project\/update-password-dictionary-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "policies.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [], "Key": [] @@ -34561,18 +34815,30 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] - }, - "put": { - "summary": "Update bucket", - "operationId": "storageUpdateBucket", + } + }, + "\/project\/policies\/password-history": { + "patch": { + "summary": "Update password history policy", + "operationId": "projectUpdatePasswordHistoryPolicy", "consumes": [ "application\/json" ], @@ -34580,36 +34846,35 @@ "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Update a storage bucket by its unique ID.", + "description": "Updates one of password strength policies. Based on total length configured, previous password hashes are stored, and users cannot choose a new password that is already stored in the passwird history list, when updating an user password, or setting new one through password recovery.\n\nKeep in mind, while password history policy is disabled, the history is not being stored. Enabling the policy will not have any history on existing users, and it will only start to collect and enforce the policy on password changes since the policy is enabled.", "responses": { "200": { - "description": "Bucket", + "description": "Project", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "updateBucket", - "group": "buckets", - "weight": 559, + "method": "updatePasswordHistoryPolicy", + "group": "policies", + "weight": 1129, "cookies": false, "type": "", - "demo": "storage\/update-bucket.md", + "demo": "project\/update-password-history-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "policies.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [], "Key": [] @@ -34622,138 +34887,69 @@ } ], "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Bucket name", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, - "x-example": false - }, - "maximumFileSize": { + "total": { "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "default": {}, + "description": "Set the password history length per user. Value can be between 1 and 5000, or null to disable the limit.", + "default": null, "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "default": true, - "x-example": false + "format": "int32", + "x-nullable": true } }, "required": [ - "name" + "total" ] } } ] - }, - "delete": { - "summary": "Delete bucket", - "operationId": "storageDeleteBucket", + } + }, + "\/project\/policies\/password-personal-data": { + "patch": { + "summary": "Update password personal data policy", + "operationId": "projectUpdatePasswordPersonalDataPolicy", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "storage" + "project" ], - "description": "Delete a storage bucket by its unique ID.", + "description": "Updating this policy allows you to control if password strength is checked against personal data. When enabled, and user sets or changes their password, the password must not contain user ID, name, email or phone number.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteBucket", - "group": "buckets", - "weight": 560, + "method": "updatePasswordPersonalDataPolicy", + "group": "policies", + "weight": 1130, "cookies": false, "type": "", - "demo": "storage\/delete-bucket.md", + "demo": "project\/update-password-personal-data-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "policies.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [], "Key": [] @@ -34767,279 +34963,250 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] } }, - "\/storage\/buckets\/{bucketId}\/files": { - "get": { - "summary": "List files", - "operationId": "storageListFiles", - "consumes": [], + "\/project\/policies\/session-alert": { + "patch": { + "summary": "Update session alert policy", + "operationId": "projectUpdateSessionAlertPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Get a list of all the user files. You can use the query params to filter your results.", + "description": "Updating this policy allows you to control if email alert is sent upon session creation. When enabled, and user signs into their account, they will be sent an email notification. There is an exception, the first session after a new sign up does not trigger an alert, even if the policy is enabled.", "responses": { "200": { - "description": "Files List", + "description": "Project", "schema": { - "$ref": "#\/definitions\/fileList" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "listFiles", - "group": "files", - "weight": 563, + "method": "updateSessionAlertPolicy", + "group": "policies", + "weight": 1131, "cookies": false, "type": "", - "demo": "storage\/list-files.md", + "demo": "project\/update-session-alert-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "policies.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] - }, - "post": { - "summary": "Create file", - "operationId": "storageCreateFile", + } + }, + "\/project\/policies\/session-duration": { + "patch": { + "summary": "Update session duration policy", + "operationId": "projectUpdateSessionDurationPolicy", "consumes": [ - "multipart\/form-data" + "application\/json" ], "produces": [ "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "description": "Update maximum duration how long sessions created within a project should stay active for.", "responses": { - "201": { - "description": "File", + "200": { + "description": "Project", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "createFile", - "group": "files", - "weight": 1073, + "method": "updateSessionDurationPolicy", + "group": "policies", + "weight": 1132, "cookies": false, - "type": "upload", - "demo": "storage\/create-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", - "scope": "files.write", + "type": "", + "demo": "project\/update-session-duration-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "policies.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "required": true, - "x-upload-id": true, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "file", - "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "required": true, - "type": "file", - "in": "formData" - }, - { - "name": "permissions", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "x-example": "[\"read(\"any\")\"]", - "in": "formData" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "duration": { + "type": "integer", + "description": "Maximum session length in seconds. Minium allowed value is 5 second, and maximum is 1 year, which is 31536000 seconds.", + "default": null, + "x-example": 5, + "format": "int32" + } + }, + "required": [ + "duration" + ] + } } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "Get file", - "operationId": "storageGetFile", - "consumes": [], + "\/project\/policies\/session-invalidation": { + "patch": { + "summary": "Update session invalidation policy", + "operationId": "projectUpdateSessionInvalidationPolicy", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "description": "Updating this policy allows you to control if existing sessions should be invalidated when a password of a user is changed. When enabled, and user changes their password, they will be logged out of all their devices.", "responses": { "200": { - "description": "File", + "description": "Project", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getFile", - "group": "files", - "weight": 562, + "method": "updateSessionInvalidationPolicy", + "group": "policies", + "weight": 1133, "cookies": false, "type": "", - "demo": "storage\/get-file.md", + "demo": "project\/update-session-invalidation-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "policies.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] - }, - "put": { - "summary": "Update file", - "operationId": "storageUpdateFile", + } + }, + "\/project\/policies\/session-limit": { + "patch": { + "summary": "Update session limit policy", + "operationId": "projectUpdateSessionLimitPolicy", "consumes": [ "application\/json" ], @@ -35047,576 +35214,491 @@ "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", + "description": "Update the maximum number of sessions allowed per user. When the limit is hit, the oldest session will be deleted to make room for new one.", "responses": { "200": { - "description": "File", + "description": "Project", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "updateFile", - "group": "files", - "weight": 564, + "method": "updateSessionLimitPolicy", + "group": "policies", + "weight": 1134, "cookies": false, "type": "", - "demo": "storage\/update-file.md", + "demo": "project\/update-session-limit-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.write", + "scope": "policies.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "File name.", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "total": { + "type": "integer", + "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 5000, or null to disable the limit.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": 1, + "format": "int32", + "x-nullable": true } - } + }, + "required": [ + "total" + ] } } ] - }, - "delete": { - "summary": "Delete file", - "operationId": "storageDeleteFile", + } + }, + "\/project\/policies\/user-limit": { + "patch": { + "summary": "Update user limit policy", + "operationId": "projectUpdateUserLimitPolicy", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "storage" + "project" ], - "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Update the maximum number of users in the project. When the limit is hit or amount of existing users already exceeded the limit, all users remain active, but new user sign up will be prohibited.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Project", + "schema": { + "$ref": "#\/definitions\/project" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteFile", - "group": "files", - "weight": 565, + "method": "updateUserLimitPolicy", + "group": "policies", + "weight": 1135, "cookies": false, "type": "", - "demo": "storage\/delete-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "files.write", + "demo": "project\/update-user-limit-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "policies.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Set the maximum number of users allowed in the project. Value can be between 1 and 5000, or null to disable the limit.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + } + }, + "required": [ + "total" + ] + } } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "\/project\/policies\/{policyId}": { "get": { - "summary": "Get file for download", - "operationId": "storageGetFileDownload", + "summary": "Get project policy", + "operationId": "projectGetPolicy", "consumes": [], "produces": [ - "*\/*" + "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", + "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { "200": { - "description": "File", + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Personal Data, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy", "schema": { - "type": "file" + "x-oneOf": [ + { + "$ref": "#\/definitions\/policyPasswordDictionary" + }, + { + "$ref": "#\/definitions\/policyPasswordHistory" + }, + { + "$ref": "#\/definitions\/policyPasswordPersonalData" + }, + { + "$ref": "#\/definitions\/policySessionAlert" + }, + { + "$ref": "#\/definitions\/policySessionDuration" + }, + { + "$ref": "#\/definitions\/policySessionInvalidation" + }, + { + "$ref": "#\/definitions\/policySessionLimit" + }, + { + "$ref": "#\/definitions\/policyUserLimit" + }, + { + "$ref": "#\/definitions\/policyMembershipPrivacy" + } + ], + "x-discriminator": { + "propertyName": "$id", + "mapping": { + "password-dictionary": "#\/definitions\/policyPasswordDictionary", + "password-history": "#\/definitions\/policyPasswordHistory", + "password-personal-data": "#\/definitions\/policyPasswordPersonalData", + "session-alert": "#\/definitions\/policySessionAlert", + "session-duration": "#\/definitions\/policySessionDuration", + "session-invalidation": "#\/definitions\/policySessionInvalidation", + "session-limit": "#\/definitions\/policySessionLimit", + "user-limit": "#\/definitions\/policyUserLimit", + "membership-privacy": "#\/definitions\/policyMembershipPrivacy" + } + } } } }, "deprecated": false, "x-appwrite": { - "method": "getFileDownload", - "group": "files", - "weight": 567, + "method": "getPolicy", + "group": "policies", + "weight": 1126, "cookies": false, - "type": "location", - "demo": "storage\/get-file-download.md", + "type": "", + "demo": "project\/get-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "policies.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", + "name": "policyId", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy.", "required": true, "type": "string", - "x-example": "", + "x-example": "password-dictionary", + "enum": [ + "password-dictionary", + "password-history", + "password-personal-data", + "session-alert", + "session-duration", + "session-invalidation", + "session-limit", + "user-limit", + "membership-privacy" + ], + "x-enum-name": null, + "x-enum-keys": [], "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { - "get": { - "summary": "Get file preview", - "operationId": "storageGetFilePreview", - "consumes": [], + "\/project\/protocols\/{protocolId}": { + "patch": { + "summary": "Update project protocol", + "operationId": "projectUpdateProtocol", + "consumes": [ + "application\/json" + ], "produces": [ - "image\/*" + "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", + "description": "Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project. ", "responses": { "200": { - "description": "Image", + "description": "Project", "schema": { - "type": "file" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getFilePreview", - "group": "files", - "weight": 566, + "method": "updateProtocol", + "group": null, + "weight": 1089, "cookies": false, - "type": "location", - "demo": "storage\/get-file-preview.md", + "type": "", + "demo": "project\/update-protocol.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "project.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID", + "name": "protocolId", + "description": "Protocol name. Can be one of: rest, graphql, websocket", "required": true, "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "width", - "description": "Resize preview image width, Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "height", - "description": "Resize preview image height, Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "gravity", - "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", - "required": false, - "type": "string", - "x-example": "center", - "enum": [ - "center", - "top-left", - "top", - "top-right", - "left", - "right", - "bottom-left", - "bottom", - "bottom-right" - ], - "x-enum-name": "ImageGravity", - "x-enum-keys": [], - "default": "center", - "in": "query" - }, - { - "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1, - "in": "query" - }, - { - "name": "borderWidth", - "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "borderColor", - "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", - "required": false, - "type": "string", - "default": "", - "in": "query" - }, - { - "name": "borderRadius", - "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "opacity", - "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", - "required": false, - "type": "number", - "format": "float", - "x-example": 0, - "default": 1, - "in": "query" - }, - { - "name": "rotation", - "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -360, - "default": 0, - "in": "query" - }, - { - "name": "background", - "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", - "required": false, - "type": "string", - "default": "", - "in": "query" - }, - { - "name": "output", - "description": "Output format type (jpeg, jpg, png, gif and webp).", - "required": false, - "type": "string", - "x-example": "jpg", + "x-example": "rest", "enum": [ - "jpg", - "jpeg", - "png", - "webp", - "heic", - "avif", - "gif" + "rest", + "graphql", + "websocket" ], - "x-enum-name": "ImageFormat", + "x-enum-name": null, "x-enum-keys": [], - "default": "", - "in": "query" + "in": "path" }, { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Protocol status.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { - "get": { - "summary": "Get file for view", - "operationId": "storageGetFileView", - "consumes": [], + "\/project\/services\/{serviceId}": { + "patch": { + "summary": "Update project service", + "operationId": "projectUpdateService", + "consumes": [ + "application\/json" + ], "produces": [ - "*\/*" + "application\/json" ], "tags": [ - "storage" + "project" ], - "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", + "description": "Update properties of a specific service. Use this endpoint to enable or disable a service in your project. ", "responses": { "200": { - "description": "File", + "description": "Project", "schema": { - "type": "file" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "getFileView", - "group": "files", - "weight": 568, + "method": "updateService", + "group": null, + "weight": 1090, "cookies": false, - "type": "location", - "demo": "storage\/get-file-view.md", + "type": "", + "demo": "project\/update-service.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "project.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", + "name": "serviceId", + "description": "Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging", "required": true, "type": "string", - "x-example": "", + "x-example": "account", + "enum": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging" + ], + "x-enum-name": null, + "x-enum-keys": [], "in": "path" }, { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Service status.", + "default": null, + "x-example": false + } + }, + "required": [ + "enabled" + ] + } } ] } }, - "\/tablesdb": { - "get": { - "summary": "List databases", - "operationId": "tablesDBList", - "consumes": [], + "\/project\/smtp": { + "patch": { + "summary": "Update project SMTP configuration", + "operationId": "projectUpdateSMTP", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "project" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.", "responses": { "200": { - "description": "Databases List", + "description": "Project", "schema": { - "$ref": "#\/definitions\/databaseList" + "$ref": "#\/definitions\/project" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "tablesdb", - "weight": 709, + "method": "updateSMTP", + "group": "smtp", + "weight": 1091, "cookies": false, "type": "", - "demo": "tablesdb\/list.md", + "demo": "project\/update-smtp.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "project.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [], "Key": [] @@ -35630,77 +35712,131 @@ ], "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 columns: name", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "host": { + "type": "string", + "description": "SMTP server hostname (domain)", + "default": null, + "x-example": null, + "x-nullable": true + }, + "port": { + "type": "integer", + "description": "SMTP server port", + "default": null, + "x-example": null, + "format": "int32", + "x-nullable": true + }, + "username": { + "type": "string", + "description": "SMTP server username. Leave empty for no authorization.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "password": { + "type": "string", + "description": "SMTP server password. Leave empty for no authorization. This property is stored securely and cannot be read in future (write-only).", + "default": null, + "x-example": "", + "x-nullable": true + }, + "senderEmail": { + "type": "string", + "description": "Email address shown in inbox as the sender of the email.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "senderName": { + "type": "string", + "description": "Name shown in inbox as the sender of the email.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "replyToEmail": { + "type": "string", + "description": "Email used when user replies to the email.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToName": { + "type": "string", + "description": "Name used when user replies to the email.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secure": { + "type": "string", + "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", + "default": null, + "x-example": "tls", + "enum": [ + "tls", + "ssl" + ], + "x-enum-name": null, + "x-enum-keys": [], + "x-nullable": true + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", + "default": null, + "x-example": false, + "x-nullable": true + } + } + } } ] - }, + } + }, + "\/project\/smtp\/tests": { "post": { - "summary": "Create database", - "operationId": "tablesDBCreate", + "summary": "Create project SMTP test", + "operationId": "projectCreateSMTPTest", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "project" ], - "description": "Create a new Database.\n", + "description": "Send a test email to verify SMTP configuration. ", "responses": { - "201": { - "description": "Database", - "schema": { - "$ref": "#\/definitions\/database" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "tablesdb", - "weight": 705, + "method": "createSMTPTest", + "group": "smtp", + "weight": 1092, "cookies": false, "type": "", - "demo": "tablesdb\/create.md", + "demo": "project\/create-smtp-test.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "project.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [], "Key": [] @@ -35719,77 +35855,62 @@ "schema": { "type": "object", "properties": { - "databaseId": { - "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", + "emails": { + "type": "array", + "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", "default": null, - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "default": true, - "x-example": false + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "databaseId", - "name" + "emails" ] } } ] } }, - "\/tablesdb\/transactions": { + "\/project\/templates\/email": { "get": { - "summary": "List transactions", - "operationId": "tablesDBListTransactions", + "summary": "List project email templates", + "operationId": "projectListEmailTemplates", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "project" ], - "description": "List transactions across all databases.", + "description": "Get a list of all custom email templates configured for the project. This endpoint returns an array of all configured email templates and their locales.", "responses": { "200": { - "description": "Transaction List", + "description": "Email Templates List", "schema": { - "$ref": "#\/definitions\/transactionList" + "$ref": "#\/definitions\/emailTemplateList" } } }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 776, + "method": "listEmailTemplates", + "group": "templates", + "weight": 1093, "cookies": false, "type": "", - "demo": "tablesdb\/list-transactions.md", + "demo": "project\/list-email-templates.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "scope": "templates.read", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [], "Key": [] @@ -35798,15 +35919,13 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "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).", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "type": "array", "collectionFormat": "multi", @@ -35815,12 +35934,21 @@ }, "default": [], "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "post": { - "summary": "Create transaction", - "operationId": "tablesDBCreateTransaction", + "patch": { + "summary": "Update project email template", + "operationId": "projectUpdateEmailTemplate", "consumes": [ "application\/json" ], @@ -35828,40 +35956,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "project" ], - "description": "Create a new transaction.", + "description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "EmailTemplate", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/emailTemplate" } } }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 772, + "method": "updateEmailTemplate", + "group": "templates", + "weight": 1095, "cookies": false, "type": "", - "demo": "tablesdb\/create-transaction.md", + "demo": "project\/update-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "templates.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [], "Key": [] @@ -35870,9 +35993,7 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -35882,62 +36003,255 @@ "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "default": 300, - "x-example": 60, - "format": "int32" + "templateId": { + "type": "string", + "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", + "default": null, + "x-example": "verification", + "enum": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ], + "x-enum-name": "EmailTemplateType", + "x-enum-keys": [] + }, + "locale": { + "type": "string", + "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", + "default": "", + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "EmailTemplateLocale", + "x-enum-keys": [] + }, + "subject": { + "type": "string", + "description": "Subject of the email template. Can be up to 255 characters.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "message": { + "type": "string", + "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "senderName": { + "type": "string", + "description": "Name of the email sender.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "senderEmail": { + "type": "string", + "description": "Email of the sender.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToEmail": { + "type": "string", + "description": "Reply to email.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "replyToName": { + "type": "string", + "description": "Reply to name.", + "default": null, + "x-example": "", + "x-nullable": true } - } + }, + "required": [ + "templateId" + ] } } ] } }, - "\/tablesdb\/transactions\/{transactionId}": { + "\/project\/templates\/email\/{templateId}": { "get": { - "summary": "Get transaction", - "operationId": "tablesDBGetTransaction", + "summary": "Get project email template", + "operationId": "projectGetEmailTemplate", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "project" ], - "description": "Get a transaction by its unique ID.", + "description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.", "responses": { "200": { - "description": "Transaction", + "description": "EmailTemplate", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/emailTemplate" } } }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 773, + "method": "getEmailTemplate", + "group": "templates", + "weight": 1094, "cookies": false, "type": "", - "demo": "tablesdb\/get-transaction.md", + "demo": "project\/get-email-template.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "scope": "templates.read", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [], "Key": [] @@ -35945,180 +36259,253 @@ }, "security": [ { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "tablesDBUpdateTransaction", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tablesDB" - ], - "description": "Update a transaction, to either commit or roll back its operations.", - "responses": { - "200": { - "description": "Transaction", - "schema": { - "$ref": "#\/definitions\/transaction" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 774, - "cookies": false, - "type": "", - "demo": "tablesdb\/update-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", - "auth": { "Project": [], "Key": [] } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "templateId", + "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", "required": true, "type": "string", - "x-example": "", + "x-example": "verification", + "enum": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ], + "x-enum-name": "EmailTemplateType", + "x-enum-keys": [], "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false - } - } - } - } - ] - }, - "delete": { - "summary": "Delete transaction", - "operationId": "tablesDBDeleteTransaction", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "tablesDB" - ], - "description": "Delete a transaction by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 775, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, + "name": "locale", + "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", + "required": false, "type": "string", - "x-example": "", - "in": "path" - } - ] + "x-example": "af", + "enum": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ], + "x-enum-name": "EmailTemplateLocale", + "x-enum-keys": [], + "default": "", + "in": "query" + } + ] } }, - "\/tablesdb\/transactions\/{transactionId}\/operations": { + "\/project\/variables": { + "get": { + "summary": "List project variables", + "operationId": "projectListVariables", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "project" + ], + "description": "Get a list of all project environment variables.", + "responses": { + "200": { + "description": "Variables List", + "schema": { + "$ref": "#\/definitions\/variableList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listVariables", + "group": "variables", + "weight": 1097, + "cookies": false, + "type": "", + "demo": "project\/list-variables.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "project.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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: key, resourceType, resourceId, secret", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, "post": { - "summary": "Create operations", - "operationId": "tablesDBCreateOperations", + "summary": "Create project variable", + "operationId": "projectCreateVariable", "consumes": [ "application\/json" ], @@ -36126,40 +36513,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "project" ], - "description": "Create multiple operations in a single transaction.", + "description": "Create a new project environment variable. These variables can be accessed by all functions and sites in the project.", "responses": { "201": { - "description": "Transaction", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 777, + "method": "createVariable", + "group": "variables", + "weight": 1096, "cookies": false, "type": "", - "demo": "tablesdb\/create-operations.md", + "demo": "project\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "project.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [], "Key": [] @@ -36168,80 +36550,89 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } + "variableId": { + "type": "string", + "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "default": null, + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "default": true, + "x-example": false } - } + }, + "required": [ + "variableId", + "key", + "value" + ] } } ] } }, - "\/tablesdb\/{databaseId}": { + "\/project\/variables\/{variableId}": { "get": { - "summary": "Get database", - "operationId": "tablesDBGet", + "summary": "Get project variable", + "operationId": "projectGetVariable", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "project" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "description": "Get a variable by its unique ID. ", "responses": { "200": { - "description": "Database", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "tablesdb", - "weight": 706, + "method": "getVariable", + "group": "variables", + "weight": 1098, "cookies": false, "type": "", - "demo": "tablesdb\/get.md", + "demo": "project\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "project.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [], "Key": [] @@ -36255,18 +36646,18 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, "put": { - "summary": "Update database", - "operationId": "tablesDBUpdate", + "summary": "Update project variable", + "operationId": "projectUpdateVariable", "consumes": [ "application\/json" ], @@ -36274,36 +36665,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "project" ], - "description": "Update a database by its unique ID.", + "description": "Update variable by its unique ID.", "responses": { "200": { - "description": "Database", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "tablesdb", - "weight": 707, + "method": "updateVariable", + "group": "variables", + "weight": 1100, "cookies": false, "type": "", - "demo": "tablesdb\/update.md", + "demo": "project\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "project.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [], "Key": [] @@ -36317,11 +36707,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -36330,17 +36720,26 @@ "schema": { "type": "object", "properties": { - "name": { + "key": { "type": "string", - "description": "Database name. Max length: 128 chars.", + "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": "" + "x-example": "", + "x-nullable": true }, - "enabled": { + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secret": { "type": "boolean", - "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "default": true, - "x-example": false + "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", + "default": null, + "x-example": false, + "x-nullable": true } } } @@ -36348,16 +36747,16 @@ ] }, "delete": { - "summary": "Delete database", - "operationId": "tablesDBDelete", + "summary": "Delete project variable", + "operationId": "projectDeleteVariable", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "tablesDB" + "project" ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "description": "Delete a variable by its unique ID. ", "responses": { "204": { "description": "No content" @@ -36365,23 +36764,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "tablesdb", - "weight": 708, + "method": "deleteVariable", + "group": "variables", + "weight": 1099, "cookies": false, "type": "", - "demo": "tablesdb\/delete.md", + "demo": "project\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "project.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [], "Key": [] @@ -36395,58 +36793,54 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "variableId", + "description": "Variable ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/tablesdb\/{databaseId}\/tables": { + "\/sites": { "get": { - "summary": "List tables", - "operationId": "tablesDBListTables", + "summary": "List sites", + "operationId": "sitesList", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", + "description": "Get a list of all the project's sites. You can use the query params to filter your results.", "responses": { "200": { - "description": "Tables List", + "description": "Sites List", "schema": { - "$ref": "#\/definitions\/tableList" + "$ref": "#\/definitions\/siteList" } } }, "deprecated": false, "x-appwrite": { - "method": "listTables", - "group": "tables", - "weight": 716, + "method": "list", + "group": "sites", + "weight": 470, "cookies": false, "type": "", - "demo": "tablesdb\/list-tables.md", + "demo": "sites\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [], "Key": [] @@ -36459,17 +36853,9 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name, enabled, rowSecurity", + "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: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", "required": false, "type": "array", "collectionFormat": "multi", @@ -36500,8 +36886,8 @@ ] }, "post": { - "summary": "Create table", - "operationId": "tablesDBCreateTable", + "summary": "Create site", + "operationId": "sitesCreate", "consumes": [ "application\/json" ], @@ -36509,39 +36895,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new site.", "responses": { "201": { - "description": "Table", + "description": "Site", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "createTable", - "group": "tables", - "weight": 712, + "method": "create", + "group": "sites", + "weight": 903, "cookies": false, "type": "", - "demo": "tablesdb\/create-table.md", + "demo": "sites\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [], "Key": [] @@ -36554,124 +36936,311 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "tableId": { + "siteId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "" + "x-example": "" }, "name": { "type": "string", - "description": "Table name. Max length: 128 chars.", + "description": "Site name. Max length: 128 chars.", "default": null, "x-example": "" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "framework": { + "type": "string", + "description": "Sites framework.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "rowSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] }, "enabled": { "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", "default": true, "x-example": false }, - "columns": { - "type": "array", - "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } + "logging": { + "type": "boolean", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "default": true, + "x-example": false }, - "indexes": { - "type": "array", - "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", - "default": [], - "x-example": null, - "items": { - "type": "object" - } + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "default": 30, + "x-example": 1, + "format": "int32" + }, + "installCommand": { + "type": "string", + "description": "Install Command.", + "default": "", + "x-example": "" + }, + "buildCommand": { + "type": "string", + "description": "Build Command.", + "default": "", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "default": "", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "default": null, + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { + "type": "string", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "default": "", + "x-example": "static", + "enum": [ + "static", + "ssr" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "default": "", + "x-example": "" + }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "default": "", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerSilentMode": { + "type": "boolean", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", + "default": false, + "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "default": "", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "default": {}, + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ - "tableId", - "name" + "siteId", + "name", + "framework", + "buildRuntime" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "\/sites\/frameworks": { "get": { - "summary": "Get table", - "operationId": "tablesDBGetTable", + "summary": "List frameworks", + "operationId": "sitesListFrameworks", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "description": "Get a list of all frameworks that are currently available on the server instance.", "responses": { "200": { - "description": "Table", + "description": "Frameworks List", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/frameworkList" } } }, "deprecated": false, "x-appwrite": { - "method": "getTable", - "group": "tables", - "weight": 713, + "method": "listFrameworks", + "group": "frameworks", + "weight": 473, "cookies": false, "type": "", - "demo": "tablesdb\/get-table.md", + "demo": "sites\/list-frameworks.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "public", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [], "Key": [] @@ -36682,69 +37251,47 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } ] - }, - "put": { - "summary": "Update table", - "operationId": "tablesDBUpdateTable", - "consumes": [ - "application\/json" - ], + } + }, + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a table by its unique ID.", + "description": "List allowed site specifications for this instance.", "responses": { "200": { - "description": "Table", + "description": "Specifications List", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/specificationList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTable", - "group": "tables", - "weight": 714, + "method": "listSpecifications", + "group": "frameworks", + "weight": 496, "cookies": false, "type": "", - "demo": "tablesdb\/update-table.md", + "demo": "sites\/list-specifications.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [], "Key": [] @@ -36755,107 +37302,47 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "rowSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", - "default": true, - "x-example": false - }, - "purge": { - "type": "boolean", - "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", - "default": false, - "x-example": false - } - } - } - } ] - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", - "consumes": [ + } + }, + "\/sites\/{siteId}": { + "get": { + "summary": "Get site", + "operationId": "sitesGet", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "tablesDB" + "sites" ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Get a site by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Site", + "schema": { + "$ref": "#\/definitions\/site" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 715, + "method": "get", + "group": "sites", + "weight": 469, "cookies": false, "type": "", - "demo": "tablesdb\/delete-table.md", + "demo": "sites\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [], "Key": [] @@ -36869,66 +37356,54 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", - "consumes": [], + }, + "put": { + "summary": "Update site", + "operationId": "sitesUpdate", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "List columns in the table.", + "description": "Update site by its unique ID.", "responses": { "200": { - "description": "Columns List", + "description": "Site", "schema": { - "$ref": "#\/definitions\/columnList" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "listColumns", - "group": "columns", - "weight": 721, + "method": "update", + "group": "sites", + "weight": 904, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "sites\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [], "Key": [] @@ -36942,115 +37417,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", - "required": false, - "type": "array", - "collectionFormat": "multi", - "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, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } - ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { - "post": { - "summary": "Create boolean column", - "operationId": "tablesDBCreateBooleanColumn", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tablesDB" - ], - "description": "Create a boolean column.\n", - "responses": { - "202": { - "description": "ColumnBoolean", - "schema": { - "$ref": "#\/definitions\/columnBoolean" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createBooleanColumn", - "group": "columns", - "weight": 722, - "cookies": false, - "type": "", - "demo": "tablesdb\/create-boolean-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -37059,85 +37430,292 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Column Key.", + "description": "Site name. Max length: 128 chars.", "default": null, - "x-example": null + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", + "framework": { + "type": "string", + "description": "Sites framework.", "default": null, + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "enabled": { + "type": "boolean", + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", + "default": true, "x-example": false }, - "default": { + "logging": { "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": false, - "x-nullable": true + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "default": true, + "x-example": false }, - "array": { + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "default": 30, + "x-example": 1, + "format": "int32" + }, + "installCommand": { + "type": "string", + "description": "Install Command.", + "default": "", + "x-example": "" + }, + "buildCommand": { + "type": "string", + "description": "Build Command.", + "default": "", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "default": "", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "default": "", + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { + "type": "string", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "default": "", + "x-example": "static", + "enum": [ + "static", + "ssr" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "default": "", + "x-example": "" + }, + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "default": "", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerSilentMode": { "type": "boolean", - "description": "Is column an array?", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", "default": false, "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "default": "", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "default": {}, + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ - "key", - "required" + "name", + "framework" ] } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { - "patch": { - "summary": "Update boolean column", - "operationId": "tablesDBUpdateBooleanColumn", + }, + "delete": { + "summary": "Delete site", + "operationId": "sitesDelete", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "description": "Delete a site by its unique ID.", "responses": { - "200": { - "description": "ColumnBoolean", - "schema": { - "$ref": "#\/definitions\/columnBoolean" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateBooleanColumn", - "group": "columns", - "weight": 723, + "method": "delete", + "group": "sites", + "weight": 472, "cookies": false, "type": "", - "demo": "tablesdb\/update-boolean-column.md", + "demo": "sites\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [], "Key": [] @@ -37151,68 +37729,20 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": false, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { - "post": { - "summary": "Create datetime column", - "operationId": "tablesDBCreateDatetimeColumn", + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", "consumes": [ "application\/json" ], @@ -37220,39 +37750,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a date time column according to the ISO 8601 standard.", + "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", "responses": { - "202": { - "description": "ColumnDatetime", + "200": { + "description": "Site", "schema": { - "$ref": "#\/definitions\/columnDatetime" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "createDatetimeColumn", - "group": "columns", - "weight": 724, + "method": "updateSiteDeployment", + "group": "sites", + "weight": 479, "cookies": false, "type": "", - "demo": "tablesdb\/create-datetime-column.md", + "demo": "sites\/update-site-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [], "Key": [] @@ -37266,19 +37792,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -37287,86 +37805,59 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { + "deploymentId": { "type": "string", - "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "description": "Deployment ID.", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false + "x-example": "" } }, "required": [ - "key", - "required" + "deploymentId" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { - "patch": { - "summary": "Update dateTime column", - "operationId": "tablesDBUpdateDatetimeColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/deployments": { + "get": { + "summary": "List deployments", + "operationId": "sitesListDeployments", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", "responses": { "200": { - "description": "ColumnDatetime", + "description": "Deployments List", "schema": { - "$ref": "#\/definitions\/columnDatetime" + "$ref": "#\/definitions\/deploymentList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDatetimeColumn", - "group": "columns", - "weight": 725, + "method": "listDeployments", + "group": "deployments", + "weight": 478, "cookies": false, "type": "", - "demo": "tablesdb\/update-datetime-column.md", + "demo": "sites\/list-deployments.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [], "Key": [] @@ -37380,109 +37871,84 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { + }, "post": { - "summary": "Create email column", - "operationId": "tablesDBCreateEmailColumn", + "summary": "Create deployment", + "operationId": "sitesCreateDeployment", "consumes": [ - "application\/json" + "multipart\/form-data" ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create an email column.\n", + "description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.", "responses": { "202": { - "description": "ColumnEmail", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnEmail" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "createEmailColumn", - "group": "columns", - "weight": 726, + "method": "createDeployment", + "group": "deployments", + "weight": 474, "cookies": false, - "type": "", - "demo": "tablesdb\/create-email-column.md", + "type": "upload", + "demo": "sites\/create-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], - "packaging": false, + "packaging": true, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [], "Key": [] @@ -37496,67 +37962,60 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "installCommand", + "description": "Install Commands.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "in": "formData" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } + "name": "buildCommand", + "description": "Build Commands.", + "required": false, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "outputDirectory", + "description": "Output Directory.", + "required": false, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "code", + "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", + "required": true, + "type": "file", + "in": "formData" + }, + { + "name": "activate", + "description": "Automatically activate the deployment when it is finished building.", + "required": false, + "type": "boolean", + "x-example": false, + "default": false, + "in": "formData" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { - "patch": { - "summary": "Update email column", - "operationId": "tablesDBUpdateEmailColumn", + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", "consumes": [ "application\/json" ], @@ -37564,39 +38023,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.", "responses": { - "200": { - "description": "ColumnEmail", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnEmail" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmailColumn", - "group": "columns", - "weight": 727, + "method": "createDuplicateDeployment", + "group": "deployments", + "weight": 482, "cookies": false, "type": "", - "demo": "tablesdb\/update-email-column.md", + "demo": "sites\/create-duplicate-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [], "Key": [] @@ -37610,26 +38065,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -37638,41 +38078,25 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "newKey": { + "deploymentId": { "type": "string", - "description": "New Column Key.", + "description": "Deployment ID.", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "" } }, "required": [ - "required", - "default" + "deploymentId" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { + "\/sites\/{siteId}\/deployments\/template": { "post": { - "summary": "Create enum column", - "operationId": "tablesDBCreateEnumColumn", + "summary": "Create template deployment", + "operationId": "sitesCreateTemplateDeployment", "consumes": [ "application\/json" ], @@ -37680,39 +38104,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", "responses": { "202": { - "description": "ColumnEnum", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnEnum" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "createEnumColumn", - "group": "columns", - "weight": 728, + "method": "createTemplateDeployment", + "group": "deployments", + "weight": 475, "cookies": false, "type": "", - "demo": "tablesdb\/create-enum-column.md", + "demo": "sites\/create-template-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [], "Key": [] @@ -37726,19 +38146,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -37747,55 +38159,66 @@ "schema": { "type": "object", "properties": { - "key": { + "repository": { "type": "string", - "description": "Column Key.", + "description": "Repository name of the template.", "default": null, - "x-example": null + "x-example": "" }, - "elements": { - "type": "array", - "description": "Array of enum values.", + "owner": { + "type": "string", + "description": "The name of the owner of the template.", "default": null, - "x-example": null, - "items": { - "type": "string" - } + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", + "rootDirectory": { + "type": "string", + "description": "Path to site code in the template repo.", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "type": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Type for the reference provided. Can be commit, branch, or tag", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [] }, - "array": { + "reference": { + "type": "string", + "description": "Reference value, can be a commit hash, branch name, or release tag", + "default": null, + "x-example": "" + }, + "activate": { "type": "boolean", - "description": "Is column an array?", + "description": "Automatically activate the deployment when it is finished building.", "default": false, "x-example": false } }, "required": [ - "key", - "elements", - "required" + "repository", + "owner", + "rootDirectory", + "type", + "reference" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { - "patch": { - "summary": "Update enum column", - "operationId": "tablesDBUpdateEnumColumn", + "\/sites\/{siteId}\/deployments\/vcs": { + "post": { + "summary": "Create VCS deployment", + "operationId": "sitesCreateVcsDeployment", "consumes": [ "application\/json" ], @@ -37803,39 +38226,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", "responses": { - "200": { - "description": "ColumnEnum", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnEnum" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEnumColumn", - "group": "columns", - "weight": 729, + "method": "createVcsDeployment", + "group": "deployments", + "weight": 476, "cookies": false, "type": "", - "demo": "tablesdb\/update-enum-column.md", + "demo": "sites\/create-vcs-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [], "Key": [] @@ -37849,26 +38268,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -37877,90 +38281,79 @@ "schema": { "type": "object", "properties": { - "elements": { - "type": "array", - "description": "Updated list of enum values.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { + "type": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Type of reference passed. Allowed values are: branch, commit", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [] }, - "newKey": { + "reference": { "type": "string", - "description": "New Column Key.", + "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "" + }, + "activate": { + "type": "boolean", + "description": "Automatically activate the deployment when it is finished building.", + "default": false, + "x-example": false } }, "required": [ - "elements", - "required", - "default" + "type", + "reference" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { - "post": { - "summary": "Create float column", - "operationId": "tablesDBCreateFloatColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/deployments\/{deploymentId}": { + "get": { + "summary": "Get deployment", + "operationId": "sitesGetDeployment", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "description": "Get a site deployment by its unique ID.", "responses": { - "202": { - "description": "ColumnFloat", + "200": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnFloat" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "createFloatColumn", - "group": "columns", - "weight": 730, + "method": "getDeployment", + "group": "deployments", + "weight": 477, "cookies": false, "type": "", - "demo": "tablesdb\/create-float-column.md", + "demo": "sites\/get-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [], "Key": [] @@ -37974,123 +38367,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "min": { - "type": "number", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { - "patch": { - "summary": "Update float column", - "operationId": "tablesDBUpdateFloatColumn", + }, + "delete": { + "summary": "Delete deployment", + "operationId": "sitesDeleteDeployment", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "description": "Delete a site deployment by its unique ID.", "responses": { - "200": { - "description": "ColumnFloat", - "schema": { - "$ref": "#\/definitions\/columnFloat" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateFloatColumn", - "group": "columns", - "weight": 731, + "method": "deleteDeployment", + "group": "deployments", + "weight": 480, "cookies": false, "type": "", - "demo": "tablesdb\/update-float-column.md", + "demo": "sites\/delete-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [], "Key": [] @@ -38104,125 +38431,62 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "min": { - "type": "number", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { - "post": { - "summary": "Create integer column", - "operationId": "tablesDBCreateIntegerColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { + "get": { + "summary": "Get deployment download", + "operationId": "sitesGetDeploymentDownload", + "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "responses": { - "202": { - "description": "ColumnInteger", + "200": { + "description": "File", "schema": { - "$ref": "#\/definitions\/columnInteger" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "createIntegerColumn", - "group": "columns", - "weight": 732, + "method": "getDeploymentDownload", + "group": "deployments", + "weight": 481, "cookies": false, - "type": "", - "demo": "tablesdb\/create-integer-column.md", + "type": "location", + "demo": "sites\/get-deployment-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [], "Key": [] @@ -38231,88 +38495,49 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "min": { - "type": "integer", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { "patch": { - "summary": "Update integer column", - "operationId": "tablesDBUpdateIntegerColumn", + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", "consumes": [ "application\/json" ], @@ -38320,39 +38545,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", "responses": { "200": { - "description": "ColumnInteger", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/columnInteger" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "updateIntegerColumn", - "group": "columns", - "weight": 733, + "method": "updateDeploymentStatus", + "group": "deployments", + "weight": 483, "cookies": false, "type": "", - "demo": "tablesdb\/update-integer-column.md", + "demo": "sites\/update-deployment-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [], "Key": [] @@ -38366,125 +38587,62 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "min": { - "type": "integer", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { - "post": { - "summary": "Create IP address column", - "operationId": "tablesDBCreateIpColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/logs": { + "get": { + "summary": "List logs", + "operationId": "sitesListLogs", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create IP address column.\n", + "description": "Get a list of all site logs. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnIP", + "200": { + "description": "Executions List", "schema": { - "$ref": "#\/definitions\/columnIp" + "$ref": "#\/definitions\/executionList" } } }, "deprecated": false, "x-appwrite": { - "method": "createIpColumn", - "group": "columns", - "weight": 734, + "method": "listLogs", + "group": "logs", + "weight": 485, "cookies": false, "type": "", - "demo": "tablesdb\/create-ip-column.md", + "demo": "sites\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [], "Key": [] @@ -38498,106 +38656,75 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value. Cannot be set when column is required.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { - "patch": { - "summary": "Update IP address column", - "operationId": "tablesDBUpdateIpColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/logs\/{logId}": { + "get": { + "summary": "Get log", + "operationId": "sitesGetLog", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a site request log by its unique ID.", "responses": { "200": { - "description": "ColumnIP", + "description": "Execution", "schema": { - "$ref": "#\/definitions\/columnIp" + "$ref": "#\/definitions\/execution" } } }, "deprecated": false, "x-appwrite": { - "method": "updateIpColumn", - "group": "columns", - "weight": 735, + "method": "getLog", + "group": "logs", + "weight": 484, "cookies": false, "type": "", - "demo": "tablesdb\/update-ip-column.md", + "demo": "sites\/get-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [], "Key": [] @@ -38611,68 +38738,26 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "logId", + "description": "Log ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value. Cannot be set when column is required.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { - "post": { - "summary": "Create line column", - "operationId": "tablesDBCreateLineColumn", + }, + "delete": { + "summary": "Delete log", + "operationId": "sitesDeleteLog", "consumes": [ "application\/json" ], @@ -38680,39 +38765,32 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a geometric line column.", + "description": "Delete a site log by its unique ID.", "responses": { - "202": { - "description": "ColumnLine", - "schema": { - "$ref": "#\/definitions\/columnLine" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createLineColumn", - "group": "columns", - "weight": 736, + "method": "deleteLog", + "group": "logs", + "weight": 486, "cookies": false, "type": "", - "demo": "tablesdb\/create-line-column.md", + "demo": "sites\/delete-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "log.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [], "Key": [] @@ -38726,100 +38804,62 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "logId", + "description": "Log ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", - "default": null, - "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true - } - }, - "required": [ - "key", - "required" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { - "patch": { - "summary": "Update line column", - "operationId": "tablesDBUpdateLineColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/variables": { + "get": { + "summary": "List variables", + "operationId": "sitesListVariables", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a line column. Changing the `default` value will not update already existing rows.", + "description": "Get a list of all variables of a specific site.", "responses": { "200": { - "description": "ColumnLine", + "description": "Variables List", "schema": { - "$ref": "#\/definitions\/columnLine" + "$ref": "#\/definitions\/variableList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLineColumn", - "group": "columns", - "weight": 737, + "method": "listVariables", + "group": "variables", + "weight": 489, "cookies": false, "type": "", - "demo": "tablesdb\/update-line-column.md", + "demo": "sites\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [], "Key": [] @@ -38833,67 +38873,18 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", - "default": null, - "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + }, "post": { - "summary": "Create longtext column", - "operationId": "tablesDBCreateLongtextColumn", + "summary": "Create variable", + "operationId": "sitesCreateVariable", "consumes": [ "application\/json" ], @@ -38901,39 +38892,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a longtext column.\n", + "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", "responses": { - "202": { - "description": "ColumnLongtext", + "201": { + "description": "Variable", "schema": { - "$ref": "#\/definitions\/columnLongtext" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "createLongtextColumn", - "group": "columns", - "weight": 754, + "method": "createVariable", + "group": "variables", + "weight": 905, "cookies": false, "type": "", - "demo": "tablesdb\/create-longtext-column.md", + "demo": "sites\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", "auth": { "Project": [], "Key": [] @@ -38947,19 +38934,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -38970,89 +38949,70 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", + "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "value": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Variable value. Max length: 8192 chars.", "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false + "x-example": "" }, - "encrypt": { + "secret": { "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "default": true, "x-example": false } }, "required": [ "key", - "required" + "value" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { - "patch": { - "summary": "Update longtext column", - "operationId": "tablesDBUpdateLongtextColumn", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}\/variables\/{variableId}": { + "get": { + "summary": "Get variable", + "operationId": "sitesGetVariable", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a variable by its unique ID.", "responses": { "200": { - "description": "ColumnLongtext", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/columnLongtext" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextColumn", - "group": "columns", - "weight": 755, + "method": "getVariable", + "group": "variables", + "weight": 488, "cookies": false, "type": "", - "demo": "tablesdb\/update-longtext-column.md", + "demo": "sites\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", "auth": { "Project": [], "Key": [] @@ -39066,68 +39026,26 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { - "post": { - "summary": "Create mediumtext column", - "operationId": "tablesDBCreateMediumtextColumn", + }, + "put": { + "summary": "Update variable", + "operationId": "sitesUpdateVariable", "consumes": [ "application\/json" ], @@ -39135,39 +39053,35 @@ "application\/json" ], "tags": [ - "tablesDB" + "sites" ], - "description": "Create a mediumtext column.\n", + "description": "Update variable by its unique ID.", "responses": { - "202": { - "description": "ColumnMediumtext", + "200": { + "description": "Variable", "schema": { - "$ref": "#\/definitions\/columnMediumtext" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "createMediumtextColumn", - "group": "columns", - "weight": 752, + "method": "updateVariable", + "group": "variables", + "weight": 490, "cookies": false, "type": "", - "demo": "tablesdb\/create-mediumtext-column.md", + "demo": "sites\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", "auth": { "Project": [], "Key": [] @@ -39181,19 +39095,19 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -39204,89 +39118,66 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", + "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "value": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Variable value. Max length: 8192 chars.", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { + "secret": { "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "default": null, + "x-example": false, + "x-nullable": true } }, "required": [ - "key", - "required" + "key" ] } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { - "patch": { - "summary": "Update mediumtext column", - "operationId": "tablesDBUpdateMediumtextColumn", + }, + "delete": { + "summary": "Delete variable", + "operationId": "sitesDeleteVariable", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "sites" ], - "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Delete a variable by its unique ID.", "responses": { - "200": { - "description": "ColumnMediumtext", - "schema": { - "$ref": "#\/definitions\/columnMediumtext" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateMediumtextColumn", - "group": "columns", - "weight": 753, + "method": "deleteVariable", + "group": "variables", + "weight": 491, "cookies": false, "type": "", - "demo": "tablesdb\/update-mediumtext-column.md", + "demo": "sites\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", "auth": { "Project": [], "Key": [] @@ -39300,108 +39191,63 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { - "post": { - "summary": "Create point column", - "operationId": "tablesDBCreatePointColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets": { + "get": { + "summary": "List buckets", + "operationId": "storageListBuckets", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a geometric point column.", + "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnPoint", + "200": { + "description": "Buckets List", "schema": { - "$ref": "#\/definitions\/columnPoint" + "$ref": "#\/definitions\/bucketList" } } }, "deprecated": false, "x-appwrite": { - "method": "createPointColumn", - "group": "columns", - "weight": 738, + "method": "listBuckets", + "group": "buckets", + "weight": 539, "cookies": false, "type": "", - "demo": "tablesdb\/create-point-column.md", + "demo": "storage\/list-buckets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [], "Key": [] @@ -39415,60 +39261,40 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", - "default": null, - "x-example": "[1, 2]", - "x-nullable": true - } - }, - "required": [ - "key", - "required" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { - "patch": { - "summary": "Update point column", - "operationId": "tablesDBUpdatePointColumn", + }, + "post": { + "summary": "Create bucket", + "operationId": "storageCreateBucket", "consumes": [ "application\/json" ], @@ -39476,39 +39302,36 @@ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a point column. Changing the `default` value will not update already existing rows.", + "description": "Create a new storage bucket.", "responses": { - "200": { - "description": "ColumnPoint", + "201": { + "description": "Bucket", "schema": { - "$ref": "#\/definitions\/columnPoint" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePointColumn", - "group": "columns", - "weight": 739, + "method": "createBucket", + "group": "buckets", + "weight": 537, "cookies": false, "type": "", - "demo": "tablesdb\/update-point-column.md", + "demo": "storage\/create-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", "auth": { "Project": [], "Key": [] @@ -39521,108 +39344,142 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", + "bucketId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { - "type": "array", - "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", + "name": { + "type": "string", + "description": "Bucket name", "default": null, - "x-example": "[1, 2]", - "x-nullable": true + "x-example": "" }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], "x-example": null, - "x-nullable": true + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false } }, "required": [ - "required" + "bucketId", + "name" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { - "post": { - "summary": "Create polygon column", - "operationId": "tablesDBCreatePolygonColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}": { + "get": { + "summary": "Get bucket", + "operationId": "storageGetBucket", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a geometric polygon column.", + "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", "responses": { - "202": { - "description": "ColumnPolygon", + "200": { + "description": "Bucket", "schema": { - "$ref": "#\/definitions\/columnPolygon" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "createPolygonColumn", - "group": "columns", - "weight": 740, + "method": "getBucket", + "group": "buckets", + "weight": 538, "cookies": false, "type": "", - "demo": "tablesdb\/create-polygon-column.md", + "demo": "storage\/get-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [], "Key": [] @@ -39636,60 +39493,18 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", - "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true - } - }, - "required": [ - "key", - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { - "patch": { - "summary": "Update polygon column", - "operationId": "tablesDBUpdatePolygonColumn", + }, + "put": { + "summary": "Update bucket", + "operationId": "storageUpdateBucket", "consumes": [ "application\/json" ], @@ -39697,39 +39512,36 @@ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", + "description": "Update a storage bucket by its unique ID.", "responses": { "200": { - "description": "ColumnPolygon", + "description": "Bucket", "schema": { - "$ref": "#\/definitions\/columnPolygon" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePolygonColumn", - "group": "columns", - "weight": 741, + "method": "updateBucket", + "group": "buckets", + "weight": 540, "cookies": false, "type": "", - "demo": "tablesdb\/update-polygon-column.md", + "demo": "storage\/update-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [], "Key": [] @@ -39743,26 +39555,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -39771,79 +39568,124 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", + "name": { + "type": "string", + "description": "Bucket name", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "permissions": { "type": "array", - "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], "x-example": null, - "x-nullable": true + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false } }, "required": [ - "required" + "name" ] } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { - "post": { - "summary": "Create relationship column", - "operationId": "tablesDBCreateRelationshipColumn", + }, + "delete": { + "summary": "Delete bucket", + "operationId": "storageDeleteBucket", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "storage" ], - "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Delete a storage bucket by its unique ID.", "responses": { - "202": { - "description": "ColumnRelationship", - "schema": { - "$ref": "#\/definitions\/columnRelationship" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createRelationshipColumn", - "group": "columns", - "weight": 742, + "method": "deleteBucket", + "group": "buckets", + "weight": 541, "cookies": false, "type": "", - "demo": "tablesdb\/create-relationship-column.md", + "demo": "storage\/delete-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "buckets.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [], "Key": [] @@ -39857,471 +39699,279 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "relatedTableId": { - "type": "string", - "description": "Related Table ID.", - "default": null, - "x-example": "" - }, - "type": { - "type": "string", - "description": "Relation type", - "default": null, - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] - }, - "twoWay": { - "type": "boolean", - "description": "Is Two Way?", - "default": false, - "x-example": false - }, - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "twoWayKey": { - "type": "string", - "description": "Two Way Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": "restrict", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] - } - }, - "required": [ - "relatedTableId", - "type" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { - "post": { - "summary": "Create string column", - "operationId": "tablesDBCreateStringColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files": { + "get": { + "summary": "List files", + "operationId": "storageListFiles", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a string column.\n", + "description": "Get a list of all the user files. You can use the query params to filter your results.", "responses": { - "202": { - "description": "ColumnString", + "200": { + "description": "Files List", "schema": { - "$ref": "#\/definitions\/columnString" + "$ref": "#\/definitions\/fileList" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createStringColumn", - "group": "columns", - "weight": 744, + "method": "listFiles", + "group": "files", + "weight": 544, "cookies": false, "type": "", - "demo": "tablesdb\/create-string-column.md", + "demo": "storage\/list-files.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", - "deprecated": { - "since": "1.9.0", - "replaceWith": "tablesDB.createTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for text columns, in number of characters.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { - "patch": { - "summary": "Update string column", - "operationId": "tablesDBUpdateStringColumn", + }, + "post": { + "summary": "Create file", + "operationId": "storageCreateFile", "consumes": [ - "application\/json" + "multipart\/form-data" ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", "responses": { - "200": { - "description": "ColumnString", + "201": { + "description": "File", "schema": { - "$ref": "#\/definitions\/columnString" + "$ref": "#\/definitions\/file" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateStringColumn", - "group": "columns", - "weight": 745, + "method": "createFile", + "group": "files", + "weight": 1186, "cookies": false, - "type": "", - "demo": "tablesdb\/update-string-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "type": "upload", + "demo": "storage\/create-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", + "scope": "files.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "required": true, + "x-upload-id": true, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "in": "formData" }, { - "name": "key", - "description": "Column Key.", + "name": "file", + "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", "required": true, - "type": "string", - "in": "path" + "type": "file", + "in": "formData" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string column.", - "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "name": "permissions", + "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "x-example": "[\"read(\"any\")\"]", + "in": "formData" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { - "post": { - "summary": "Create text column", - "operationId": "tablesDBCreateTextColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "get": { + "summary": "Get file", + "operationId": "storageGetFile", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a text column.\n", + "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", "responses": { - "202": { - "description": "ColumnText", + "200": { + "description": "File", "schema": { - "$ref": "#\/definitions\/columnText" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "createTextColumn", - "group": "columns", - "weight": 750, + "method": "getFile", + "group": "files", + "weight": 543, "cookies": false, "type": "", - "demo": "tablesdb\/create-text-column.md", + "demo": "storage\/get-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { - "patch": { - "summary": "Update text column", - "operationId": "tablesDBUpdateTextColumn", + }, + "put": { + "summary": "Update file", + "operationId": "storageUpdateFile", "consumes": [ "application\/json" ], @@ -40329,72 +39979,65 @@ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", "responses": { "200": { - "description": "ColumnText", + "description": "File", "schema": { - "$ref": "#\/definitions\/columnText" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTextColumn", - "group": "columns", - "weight": 751, + "method": "updateFile", + "group": "files", + "weight": 545, "cookies": false, "type": "", - "demo": "tablesdb\/update-text-column.md", + "demo": "storage\/update-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "bucketId", + "description": "Bucket unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { @@ -40403,715 +40046,509 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { + "name": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "File name.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } } - }, - "required": [ - "required", - "default" - ] + } } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { - "post": { - "summary": "Create URL column", - "operationId": "tablesDBCreateUrlColumn", + }, + "delete": { + "summary": "Delete file", + "operationId": "storageDeleteFile", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a URL column.\n", + "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "202": { - "description": "ColumnURL", - "schema": { - "$ref": "#\/definitions\/columnUrl" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createUrlColumn", - "group": "columns", - "weight": 746, + "method": "deleteFile", + "group": "files", + "weight": 546, "cookies": false, "type": "", - "demo": "tablesdb\/create-url-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "demo": "storage\/delete-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "files.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { - "patch": { - "summary": "Update URL column", - "operationId": "tablesDBUpdateUrlColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "get": { + "summary": "Get file for download", + "operationId": "storageGetFileDownload", + "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "responses": { "200": { - "description": "ColumnURL", + "description": "File", "schema": { - "$ref": "#\/definitions\/columnUrl" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "updateUrlColumn", - "group": "columns", - "weight": 747, + "method": "getFileDownload", + "group": "files", + "weight": 548, "cookies": false, - "type": "", - "demo": "tablesdb\/update-url-column.md", + "type": "location", + "demo": "storage\/get-file-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "token", + "description": "File token for accessing this file.", + "required": false, "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "x-example": "", + "default": "", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { - "post": { - "summary": "Create varchar column", - "operationId": "tablesDBCreateVarcharColumn", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { + "get": { + "summary": "Get file preview", + "operationId": "storageGetFilePreview", + "consumes": [], "produces": [ - "application\/json" + "image\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a varchar column.\n", + "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { - "202": { - "description": "ColumnVarchar", + "200": { + "description": "Image", "schema": { - "$ref": "#\/definitions\/columnVarchar" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "createVarcharColumn", - "group": "columns", - "weight": 748, + "method": "getFilePreview", + "group": "files", + "weight": 547, "cookies": false, - "type": "", - "demo": "tablesdb\/create-varchar-column.md", + "type": "location", + "demo": "storage\/get-file-preview.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "fileId", + "description": "File ID", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } - } - ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { - "patch": { - "summary": "Update varchar column", - "operationId": "tablesDBUpdateVarcharColumn", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "tablesDB" - ], - "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", - "responses": { - "200": { - "description": "ColumnVarchar", - "schema": { - "$ref": "#\/definitions\/columnVarchar" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateVarcharColumn", - "group": "columns", - "weight": 749, - "cookies": false, - "type": "", - "demo": "tablesdb\/update-varchar-column.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ + "name": "width", + "description": "Resize preview image width, Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, { - "Project": [], - "Key": [] - } - ], - "parameters": [ + "name": "height", + "description": "Resize preview image height, Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "name": "gravity", + "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "center", + "enum": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], + "x-enum-name": "ImageGravity", + "x-enum-keys": [], + "default": "center", + "in": "query" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "quality", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1, + "in": "query" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "borderWidth", + "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "borderColor", + "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", + "required": false, "type": "string", - "in": "path" + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar column.", - "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "name": "borderRadius", + "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "opacity", + "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", + "required": false, + "type": "number", + "format": "float", + "x-example": 0, + "default": 1, + "in": "query" + }, + { + "name": "rotation", + "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -360, + "default": 0, + "in": "query" + }, + { + "name": "background", + "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", + "required": false, + "type": "string", + "default": "", + "in": "query" + }, + { + "name": "output", + "description": "Output format type (jpeg, jpg, png, gif and webp).", + "required": false, + "type": "string", + "x-example": "jpg", + "enum": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ], + "x-enum-name": "ImageFormat", + "x-enum-keys": [], + "default": "", + "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { "get": { - "summary": "Get column", - "operationId": "tablesDBGetColumn", + "summary": "Get file for view", + "operationId": "storageGetFileView", "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Get column by ID.", + "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { "200": { - "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", + "description": "File", "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/columnBoolean" - }, - { - "$ref": "#\/definitions\/columnInteger" - }, - { - "$ref": "#\/definitions\/columnFloat" - }, - { - "$ref": "#\/definitions\/columnEmail" - }, - { - "$ref": "#\/definitions\/columnEnum" - }, - { - "$ref": "#\/definitions\/columnUrl" - }, - { - "$ref": "#\/definitions\/columnIp" - }, - { - "$ref": "#\/definitions\/columnDatetime" - }, - { - "$ref": "#\/definitions\/columnRelationship" - }, - { - "$ref": "#\/definitions\/columnString" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/definitions\/columnBoolean", - "integer": "#\/definitions\/columnInteger", - "double": "#\/definitions\/columnFloat", - "string": "#\/definitions\/columnString", - "datetime": "#\/definitions\/columnDatetime", - "relationship": "#\/definitions\/columnRelationship" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/definitions\/columnBoolean": { - "type": "boolean" - }, - "#\/definitions\/columnInteger": { - "type": "integer" - }, - "#\/definitions\/columnFloat": { - "type": "double" - }, - "#\/definitions\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/definitions\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/definitions\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/definitions\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/definitions\/columnDatetime": { - "type": "datetime" - }, - "#\/definitions\/columnRelationship": { - "type": "relationship" - }, - "#\/definitions\/columnString": { - "type": "string" - } - } - } + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "getColumn", - "group": "columns", - "weight": 719, + "method": "getFileView", + "group": "files", + "weight": 549, "cookies": false, - "type": "", - "demo": "tablesdb\/get-column.md", + "type": "location", + "demo": "storage\/get-file-view.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", + "name": "fileId", + "description": "File ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "token", + "description": "File token for accessing this file.", + "required": false, "type": "string", - "in": "path" + "x-example": "", + "default": "", + "in": "query" } ] - }, - "delete": { - "summary": "Delete column", - "operationId": "tablesDBDeleteColumn", - "consumes": [ + } + }, + "\/tablesdb": { + "get": { + "summary": "List databases", + "operationId": "tablesDBList", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ "tablesDB" ], - "description": "Deletes a column.", + "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Databases List", + "schema": { + "$ref": "#\/definitions\/databaseList" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteColumn", - "group": "columns", - "weight": 720, + "method": "list", + "group": "tablesdb", + "weight": 761, "cookies": false, "type": "", - "demo": "tablesdb\/delete-column.md", + "demo": "tablesdb\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [], "Key": [] @@ -41125,35 +40562,40 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { - "patch": { - "summary": "Update relationship column", - "operationId": "tablesDBUpdateRelationshipColumn", + }, + "post": { + "summary": "Create database", + "operationId": "tablesDBCreate", "consumes": [ "application\/json" ], @@ -41163,37 +40605,34 @@ "tags": [ "tablesDB" ], - "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Create a new Database.\n", "responses": { - "200": { - "description": "ColumnRelationship", + "201": { + "description": "Database", "schema": { - "$ref": "#\/definitions\/columnRelationship" + "$ref": "#\/definitions\/database" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRelationshipColumn", - "group": "columns", - "weight": 743, + "method": "create", + "group": "tablesdb", + "weight": 757, "cookies": false, "type": "", - "demo": "tablesdb\/update-relationship-column.md", + "demo": "tablesdb\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [], "Key": [] @@ -41206,66 +40645,44 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "onDelete": { + "databaseId": { "type": "string", - "description": "Constraints option", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true + "x-example": "" }, - "newKey": { + "name": { "type": "string", - "description": "New Column Key.", + "description": "Database name. Max length: 128 chars.", "default": null, - "x-example": null, - "x-nullable": true + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "default": true, + "x-example": false } - } + }, + "required": [ + "databaseId", + "name" + ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": { + "\/tablesdb\/transactions": { "get": { - "summary": "List indexes", - "operationId": "tablesDBListIndexes", + "summary": "List transactions", + "operationId": "tablesDBListTransactions", "consumes": [], "produces": [ "application\/json" @@ -41273,37 +40690,38 @@ "tags": [ "tablesDB" ], - "description": "List indexes on the table.", + "description": "List transactions across all databases.", "responses": { "200": { - "description": "Column Indexes List", + "description": "Transaction List", "schema": { - "$ref": "#\/definitions\/columnIndexList" + "$ref": "#\/definitions\/transactionList" } } }, "deprecated": false, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 759, + "method": "listTransactions", + "group": "transactions", + "weight": 828, "cookies": false, "type": "", - "demo": "tablesdb\/list-indexes.md", + "demo": "tablesdb\/list-transactions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [], "Key": [] @@ -41312,29 +40730,15 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, status, attributes, error", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", "required": false, "type": "array", "collectionFormat": "multi", @@ -41343,21 +40747,12 @@ }, "default": [], "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" } ] }, "post": { - "summary": "Create index", - "operationId": "tablesDBCreateIndex", + "summary": "Create transaction", + "operationId": "tablesDBCreateTransaction", "consumes": [ "application\/json" ], @@ -41367,37 +40762,38 @@ "tags": [ "tablesDB" ], - "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.", + "description": "Create a new transaction.", "responses": { - "202": { - "description": "Index", + "201": { + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/columnIndex" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 756, + "method": "createTransaction", + "group": "transactions", + "weight": 824, "cookies": false, "type": "", - "demo": "tablesdb\/create-index.md", + "demo": "tablesdb\/create-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [], "Key": [] @@ -41406,100 +40802,35 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Index Key.", - "default": null, - "x-example": null - }, - "type": { - "type": "string", - "description": "Index type.", - "default": null, - "x-example": "key", - "enum": [ - "key", - "fulltext", - "unique", - "spatial" - ], - "x-enum-name": "TablesDBIndexType", - "x-enum-keys": [] - }, - "columns": { - "type": "array", - "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "default": [], - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } - }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "default": [], - "x-example": null, - "items": { - "type": "integer" - } + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60, + "format": "int32" } - }, - "required": [ - "key", - "type", - "columns" - ] + } } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "\/tablesdb\/transactions\/{transactionId}": { "get": { - "summary": "Get index", - "operationId": "tablesDBGetIndex", + "summary": "Get transaction", + "operationId": "tablesDBGetTransaction", "consumes": [], "produces": [ "application\/json" @@ -41507,37 +40838,38 @@ "tags": [ "tablesDB" ], - "description": "Get index by ID.", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "Index", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/columnIndex" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 757, + "method": "getTransaction", + "group": "transactions", + "weight": 825, "cookies": false, "type": "", - "demo": "tablesdb\/get-index.md", + "demo": "tablesdb\/get-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [], "Key": [] @@ -41546,73 +40878,66 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", + "x-example": "", "in": "path" } ] }, - "delete": { - "summary": "Delete index", - "operationId": "tablesDBDeleteIndex", + "patch": { + "summary": "Update transaction", + "operationId": "tablesDBUpdateTransaction", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "tablesDB" ], - "description": "Delete an index.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 758, + "method": "updateTransaction", + "group": "transactions", + "weight": 826, "cookies": false, "type": "", - "demo": "tablesdb\/delete-index.md", + "demo": "tablesdb\/update-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [], "Key": [] @@ -41621,153 +40946,111 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Index Key.", - "required": true, - "type": "string", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "default": false, + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "default": false, + "x-example": false + } + } + } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": { - "get": { - "summary": "List rows", - "operationId": "tablesDBListRows", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete transaction", + "operationId": "tablesDBDeleteTransaction", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ "tablesDB" ], - "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", + "description": "Delete a transaction by its unique ID.", "responses": { - "200": { - "description": "Rows List", - "schema": { - "$ref": "#\/definitions\/rowList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "listRows", - "group": "rows", - "weight": 768, + "method": "deleteTransaction", + "group": "transactions", + "weight": 827, "cookies": false, "type": "", - "demo": "tablesdb\/list-rows.md", + "demo": "tablesdb\/delete-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "documents.write", + "rows.write" ], "platforms": [ "console", - "client", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], "Key": [], + "Session": [], "JWT": [] } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, { "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "description": "Transaction ID.", + "required": true, "type": "string", "x-example": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" + "in": "path" } ] - }, + } + }, + "\/tablesdb\/transactions\/{transactionId}\/operations": { "post": { - "summary": "Create row", - "operationId": "tablesDBCreateRow", + "summary": "Create operations", + "operationId": "tablesDBCreateOperations", "consumes": [ "application\/json" ], @@ -41777,129 +41060,58 @@ "tags": [ "tablesDB" ], - "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create multiple operations in a single transaction.", "responses": { "201": { - "description": "Row", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "createRow", - "group": "rows", - "weight": 760, + "method": "createOperations", + "group": "transactions", + "weight": 829, "cookies": false, "type": "", - "demo": "tablesdb\/create-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "client", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md", - "methods": [ - { - "name": "createRow", - "namespace": "tablesDB", - "desc": "Create row", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rowId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rowId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/row" - } - ], - "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/create-row.md", - "public": true - }, - { - "name": "createRows", - "namespace": "tablesDB", - "desc": "Create rows", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rows", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rows" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/rowList" - } - ], - "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/create-rows.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], "Key": [], + "Session": [], "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -41908,123 +41120,60 @@ "schema": { "type": "object", "properties": { - "rowId": { - "type": "string", - "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": "", - "x-example": "" - }, - "data": { - "type": "object", - "description": "Row data as JSON object.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "rows": { + "operations": { "type": "array", - "description": "Array of rows data as JSON objects.", + "description": "Array of staged operations.", "default": [], - "x-example": null, + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", "items": { "type": "object" } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true } } } } ] - }, - "put": { - "summary": "Upsert rows", - "operationId": "tablesDBUpsertRows", - "consumes": [ - "application\/json" - ], + } + }, + "\/tablesdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "tablesDBGet", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", "responses": { - "201": { - "description": "Rows List", + "200": { + "description": "Database", "schema": { - "$ref": "#\/definitions\/rowList" + "$ref": "#\/definitions\/database" } } }, "deprecated": false, "x-appwrite": { - "method": "upsertRows", - "group": "rows", - "weight": 765, + "method": "get", + "group": "tablesdb", + "weight": 758, "cookies": false, "type": "", - "demo": "tablesdb\/upsert-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": [ - "rows.write", - "documents.write" - ], + "demo": "tablesdb\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md", - "methods": [ - { - "name": "upsertRows", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rows", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rows" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/rowList" - } - ], - "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", - "demo": "tablesdb\/upsert-rows.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [], "Key": [] @@ -42044,48 +41193,12 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "rows": { - "type": "array", - "description": "Array of row data as JSON objects. May contain partial rows.", - "default": null, - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - }, - "required": [ - "rows" - ] - } } ] }, - "patch": { - "summary": "Update rows", - "operationId": "tablesDBUpdateRows", + "put": { + "summary": "Update database", + "operationId": "tablesDBUpdate", "consumes": [ "application\/json" ], @@ -42095,37 +41208,34 @@ "tags": [ "tablesDB" ], - "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "description": "Update a database by its unique ID.", "responses": { "200": { - "description": "Rows List", + "description": "Database", "schema": { - "$ref": "#\/definitions\/rowList" + "$ref": "#\/definitions\/database" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRows", - "group": "rows", - "weight": 763, + "method": "update", + "group": "tablesdb", + "weight": 759, "cookies": false, "type": "", - "demo": "tablesdb\/update-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": [ - "rows.write", - "documents.write" - ], + "demo": "tablesdb\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [], "Key": [] @@ -42146,41 +41256,23 @@ "x-example": "", "in": "path" }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only column and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { + "name": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "Database name. Max length: 128 chars.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "default": true, + "x-example": false } } } @@ -42188,48 +41280,40 @@ ] }, "delete": { - "summary": "Delete rows", - "operationId": "tablesDBDeleteRows", + "summary": "Delete database", + "operationId": "tablesDBDelete", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "tablesDB" ], - "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", "responses": { - "200": { - "description": "Rows List", - "schema": { - "$ref": "#\/definitions\/rowList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "deleteRows", - "group": "rows", - "weight": 767, + "method": "delete", + "group": "tablesdb", + "weight": 760, "cookies": false, "type": "", - "demo": "tablesdb\/delete-rows.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": [ - "rows.write", - "documents.write" - ], + "demo": "tablesdb\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [], "Key": [] @@ -42249,47 +41333,14 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { + "\/tablesdb\/{databaseId}\/tables": { "get": { - "summary": "Get row", - "operationId": "tablesDBGetRow", + "summary": "List tables", + "operationId": "tablesDBListTables", "consumes": [], "produces": [ "application\/json" @@ -42297,49 +41348,46 @@ "tags": [ "tablesDB" ], - "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", "responses": { "200": { - "description": "Row", + "description": "Tables List", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/tableList" } } }, "deprecated": false, "x-appwrite": { - "method": "getRow", - "group": "rows", - "weight": 761, + "method": "listTables", + "group": "tables", + "weight": 768, "cookies": false, "type": "", - "demo": "tablesdb\/get-row.md", + "demo": "tablesdb\/list-tables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.read", - "documents.read" + "tables.read", + "collections.read" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -42351,25 +41399,9 @@ "x-example": "", "in": "path" }, - { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "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 columns: name, enabled, rowSecurity", "required": false, "type": "array", "collectionFormat": "multi", @@ -42380,18 +41412,28 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", "required": false, "type": "string", - "x-example": "", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] }, - "put": { - "summary": "Upsert a row", - "operationId": "tablesDBUpsertRow", + "post": { + "summary": "Create table", + "operationId": "tablesDBCreateTable", "consumes": [ "application\/json" ], @@ -42401,82 +41443,46 @@ "tags": [ "tablesDB" ], - "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { "201": { - "description": "Row", + "description": "Table", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "upsertRow", - "group": "rows", + "method": "createTable", + "group": "tables", "weight": 764, "cookies": false, "type": "", - "demo": "tablesdb\/upsert-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/create-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md", - "methods": [ - { - "name": "upsertRow", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "tableId", - "rowId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "tableId", - "rowId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/row" - } - ], - "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", - "demo": "tablesdb\/upsert-row.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -42488,37 +41494,27 @@ "x-example": "", "in": "path" }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "tableId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", + "default": null, + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, "x-example": "[\"read(\"any\")\"]", "x-nullable": true, @@ -42526,73 +41522,97 @@ "type": "string" } }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "columns": { + "type": "array", + "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "indexes": { + "type": "array", + "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "default": [], + "x-example": null, + "items": { + "type": "object" + } } - } + }, + "required": [ + "tableId", + "name" + ] } } ] - }, - "patch": { - "summary": "Update row", - "operationId": "tablesDBUpdateRow", - "consumes": [ - "application\/json" - ], + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesDBGetTable", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", "responses": { "200": { - "description": "Row", + "description": "Table", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRow", - "group": "rows", - "weight": 762, + "method": "getTable", + "group": "tables", + "weight": 765, "cookies": false, "type": "", - "demo": "tablesdb\/update-row.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/get-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.read", + "collections.read" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -42611,99 +41631,61 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only columns and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } } ] }, - "delete": { - "summary": "Delete row", - "operationId": "tablesDBDeleteRow", + "put": { + "summary": "Update table", + "operationId": "tablesDBUpdateTable", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "tablesDB" ], - "description": "Delete a row by its unique ID.", + "description": "Update a table by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Table", + "schema": { + "$ref": "#\/definitions\/table" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteRow", - "group": "rows", - "weight": 766, + "method": "updateTable", + "group": "tables", + "weight": 766, "cookies": false, "type": "", - "demo": "tablesdb\/delete-row.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/update-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -42717,94 +41699,103 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "transactionId": { + "name": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "Table name. Max length: 128 chars.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "rowSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "purge": { + "type": "boolean", + "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", + "default": false, + "x-example": false } } } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { - "patch": { - "summary": "Decrement row column", - "operationId": "tablesDBDecrementRowColumn", + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "tablesDB" ], - "description": "Decrement a specific column of a row by a given value.", + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "200": { - "description": "Row", - "schema": { - "$ref": "#\/definitions\/row" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "decrementRowColumn", - "group": "rows", - "weight": 771, + "method": "deleteTable", + "group": "tables", + "weight": 767, "cookies": false, "type": "", - "demo": "tablesdb\/decrement-row-column.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.write", + "collections.write" ], "platforms": [ - "client", - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [], "Key": [] } ], @@ -42824,111 +41815,62 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "column", - "description": "Column key.", - "required": true, - "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the column by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { - "patch": { - "summary": "Increment row column", - "operationId": "tablesDBIncrementRowColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Increment a specific column of a row by a given value.", + "description": "List columns in the table.", "responses": { "200": { - "description": "Row", + "description": "Columns List", "schema": { - "$ref": "#\/definitions\/row" + "$ref": "#\/definitions\/columnList" } } }, "deprecated": false, "x-appwrite": { - "method": "incrementRowColumn", - "group": "rows", - "weight": 770, + "method": "listColumns", + "group": "columns", + "weight": 773, "cookies": false, "type": "", - "demo": "tablesdb\/increment-row-column.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "demo": "tablesdb\/list-columns.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": [ - "rows.write", - "documents.write" + "tables.read", + "collections.read", + "columns.read", + "attributes.read" ], "platforms": [ - "client", - "server", - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [], "Key": [] } ], @@ -42950,143 +41892,148 @@ "in": "path" }, { - "name": "rowId", - "description": "Row ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "column", - "description": "Column key.", - "required": true, - "type": "string", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the column by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/teams": { - "get": { - "summary": "List teams", - "operationId": "teamsList", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { + "post": { + "summary": "Create boolean column", + "operationId": "tablesDBCreateBooleanColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.", + "description": "Create a boolean column.\n", "responses": { - "200": { - "description": "Teams List", + "202": { + "description": "ColumnBoolean", "schema": { - "$ref": "#\/definitions\/teamList" + "$ref": "#\/definitions\/columnBoolean" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "teams", - "weight": 539, + "method": "createBooleanColumn", + "group": "columns", + "weight": 774, "cookies": false, "type": "", - "demo": "teams\/list.md", + "demo": "tablesdb\/create-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "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: name, total, billingPlan", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": false, + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, - "post": { - "summary": "Create team", - "operationId": "teamsCreate", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { + "patch": { + "summary": "Update boolean column", + "operationId": "tablesDBUpdateBooleanColumn", "consumes": [ "application\/json" ], @@ -43094,157 +42041,232 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.", + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", "responses": { - "201": { - "description": "Team", + "200": { + "description": "ColumnBoolean", "schema": { - "$ref": "#\/definitions\/team" + "$ref": "#\/definitions\/columnBoolean" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "teams", - "weight": 537, + "method": "updateBooleanColumn", + "group": "columns", + "weight": 775, "cookies": false, "type": "", - "demo": "teams\/create.md", + "demo": "tablesdb\/update-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "teamId": { - "type": "string", - "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "" + "x-example": false }, - "name": { - "type": "string", - "description": "Team name. Max length: 128 chars.", + "default": { + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "" + "x-example": false, + "x-nullable": true }, - "roles": { - "type": "array", - "description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", - "default": [ - "owner" - ], + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, "x-example": null, - "items": { - "type": "string" - } + "x-nullable": true } }, "required": [ - "teamId", - "name" + "required", + "default" ] } } ] } }, - "\/teams\/{teamId}": { - "get": { - "summary": "Get team", - "operationId": "teamsGet", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { + "post": { + "summary": "Create datetime column", + "operationId": "tablesDBCreateDatetimeColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get a team by its ID. All team members have read access for this resource.", + "description": "Create a date time column according to the ISO 8601 standard.", "responses": { - "200": { - "description": "Team", + "202": { + "description": "ColumnDatetime", "schema": { - "$ref": "#\/definitions\/team" + "$ref": "#\/definitions\/columnDatetime" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "teams", - "weight": 538, + "method": "createDatetimeColumn", + "group": "columns", + "weight": 776, "cookies": false, "type": "", - "demo": "teams\/get.md", + "demo": "tablesdb\/create-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] - }, - "put": { - "summary": "Update name", - "operationId": "teamsUpdateName", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { + "patch": { + "summary": "Update dateTime column", + "operationId": "tablesDBUpdateDatetimeColumn", "consumes": [ "application\/json" ], @@ -43252,57 +42274,74 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Update the team's name by its unique ID.", + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Team", + "description": "ColumnDatetime", "schema": { - "$ref": "#\/definitions\/team" + "$ref": "#\/definitions\/columnDatetime" } } }, "deprecated": false, "x-appwrite": { - "method": "updateName", - "group": "teams", - "weight": 541, + "method": "updateDatetimeColumn", + "group": "columns", + "weight": 777, "cookies": false, "type": "", - "demo": "teams\/update-name.md", + "demo": "tablesdb\/update-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -43311,178 +42350,275 @@ "schema": { "type": "object", "properties": { - "name": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { "type": "string", - "description": "New team name. Max length: 128 chars.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "" + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "name" + "required", + "default" ] } } ] - }, - "delete": { - "summary": "Delete team", - "operationId": "teamsDelete", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { + "post": { + "summary": "Create email column", + "operationId": "tablesDBCreateEmailColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "teams" + "tablesDB" ], - "description": "Delete a team using its ID. Only team members with the owner role can delete the team.", + "description": "Create an email column.\n", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnEmail", + "schema": { + "$ref": "#\/definitions\/columnEmail" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "teams", - "weight": 540, + "method": "createEmailColumn", + "group": "columns", + "weight": 778, "cookies": false, "type": "", - "demo": "teams\/delete.md", + "demo": "tablesdb\/create-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] } }, - "\/teams\/{teamId}\/memberships": { - "get": { - "summary": "List team memberships", - "operationId": "teamsListMemberships", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { + "patch": { + "summary": "Update email column", + "operationId": "tablesDBUpdateEmailColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Memberships List", + "description": "ColumnEmail", "schema": { - "$ref": "#\/definitions\/membershipList" + "$ref": "#\/definitions\/columnEmail" } } }, "deprecated": false, "x-appwrite": { - "method": "listMemberships", - "group": "memberships", - "weight": 546, + "method": "updateEmailColumn", + "group": "columns", + "weight": 779, "cookies": false, "type": "", - "demo": "teams\/list-memberships.md", + "demo": "tablesdb\/update-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "key", + "description": "Column Key.", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] - }, + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { "post": { - "summary": "Create team membership", - "operationId": "teamsCreateMembership", + "summary": "Create enum column", + "operationId": "tablesDBCreateEnumColumn", "consumes": [ "application\/json" ], @@ -43490,57 +42626,67 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n", + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", "responses": { - "201": { - "description": "Membership", + "202": { + "description": "ColumnEnum", "schema": { - "$ref": "#\/definitions\/membership" + "$ref": "#\/definitions\/columnEnum" } } }, "deprecated": false, "x-appwrite": { - "method": "createMembership", - "group": "memberships", - "weight": 544, + "method": "createEnumColumn", + "group": "columns", + "weight": 780, "cookies": false, "type": "", - "demo": "teams\/create-membership.md", - "rate-limit": 10, + "demo": "tablesdb\/create-enum-column.md", + "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -43549,198 +42695,130 @@ "schema": { "type": "object", "properties": { - "email": { - "type": "string", - "description": "Email of the new team member.", - "default": "", - "x-example": "email@example.com", - "format": "email" - }, - "userId": { - "type": "string", - "description": "ID of the user to be added to a team.", - "default": "", - "x-example": "" - }, - "phone": { + "key": { "type": "string", - "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "default": "", - "x-example": "+12065550100", - "format": "phone" + "description": "Column Key.", + "default": null, + "x-example": null }, - "roles": { + "elements": { "type": "array", - "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "description": "Array of enum values.", "default": null, "x-example": null, "items": { "type": "string" } }, - "url": { - "type": "string", - "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "default": "", - "x-example": "https:\/\/example.com", - "format": "url" + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false }, - "name": { + "default": { "type": "string", - "description": "Name of the new team member. Max length: 128 chars.", - "default": "", - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } }, "required": [ - "roles" + "key", + "elements", + "required" ] } } ] } }, - "\/teams\/{teamId}\/memberships\/{membershipId}": { - "get": { - "summary": "Get team membership", - "operationId": "teamsGetMembership", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { + "patch": { + "summary": "Update enum column", + "operationId": "tablesDBUpdateEnumColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Membership", + "description": "ColumnEnum", "schema": { - "$ref": "#\/definitions\/membership" + "$ref": "#\/definitions\/columnEnum" } } }, "deprecated": false, "x-appwrite": { - "method": "getMembership", - "group": "memberships", - "weight": 545, + "method": "updateEnumColumn", + "group": "columns", + "weight": 781, "cookies": false, "type": "", - "demo": "teams\/get-membership.md", + "demo": "tablesdb\/update-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "patch": { - "summary": "Update team membership", - "operationId": "teamsUpdateMembership", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "teams" - ], - "description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n", - "responses": { - "200": { - "description": "Membership", - "schema": { - "$ref": "#\/definitions\/membership" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateMembership", - "group": "memberships", - "weight": 547, - "cookies": false, - "type": "", - "demo": "teams\/update-membership.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", - "platforms": [ - "console", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md", - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "teamId", - "description": "Team ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -43749,96 +42827,182 @@ "schema": { "type": "object", "properties": { - "roles": { + "elements": { "type": "array", - "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "description": "Updated list of enum values.", "default": null, "x-example": null, "items": { "type": "string" } + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "roles" + "elements", + "required", + "default" ] } } ] - }, - "delete": { - "summary": "Delete team membership", - "operationId": "teamsDeleteMembership", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "post": { + "summary": "Create float column", + "operationId": "tablesDBCreateFloatColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "teams" + "tablesDB" ], - "description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.", + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnFloat", + "schema": { + "$ref": "#\/definitions\/columnFloat" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteMembership", - "group": "memberships", - "weight": 1074, + "method": "createFloatColumn", + "group": "columns", + "weight": 782, "cookies": false, "type": "", - "demo": "teams\/delete-membership.md", + "demo": "tablesdb\/create-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] } }, - "\/teams\/{teamId}\/memberships\/{membershipId}\/status": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { "patch": { - "summary": "Update team membership status", - "operationId": "teamsUpdateMembershipStatus", + "summary": "Update float column", + "operationId": "tablesDBUpdateFloatColumn", "consumes": [ "application\/json" ], @@ -43846,64 +43010,74 @@ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n", + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Membership", + "description": "ColumnFloat", "schema": { - "$ref": "#\/definitions\/membership" + "$ref": "#\/definitions\/columnFloat" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMembershipStatus", - "group": "memberships", - "weight": 549, + "method": "updateFloatColumn", + "group": "columns", + "weight": 783, "cookies": false, "type": "", - "demo": "teams\/update-membership-status.md", + "demo": "tablesdb\/update-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "membershipId", - "description": "Membership ID.", + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -43912,151 +43086,125 @@ "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "" + "x-example": false }, - "secret": { + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value. Cannot be set when required.", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "newKey": { "type": "string", - "description": "Secret key.", + "description": "New Column Key.", "default": null, - "x-example": "" + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "secret" + "required", + "default" ] } } ] } }, - "\/teams\/{teamId}\/prefs": { - "get": { - "summary": "Get team preferences", - "operationId": "teamsGetPrefs", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "post": { + "summary": "Create integer column", + "operationId": "tablesDBCreateIntegerColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "teams" + "tablesDB" ], - "description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).", + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", "responses": { - "200": { - "description": "Preferences", + "202": { + "description": "ColumnInteger", "schema": { - "$ref": "#\/definitions\/preferences" + "$ref": "#\/definitions\/columnInteger" } } }, "deprecated": false, "x-appwrite": { - "method": "getPrefs", - "group": "teams", - "weight": 542, + "method": "createIntegerColumn", + "group": "columns", + "weight": 784, "cookies": false, "type": "", - "demo": "teams\/get-prefs.md", + "demo": "tablesdb\/create-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "teams.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "teamId", - "description": "Team ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - } - ] - }, - "put": { - "summary": "Update team preferences", - "operationId": "teamsUpdatePrefs", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "teams" - ], - "description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.", - "responses": { - "200": { - "description": "Preferences", - "schema": { - "$ref": "#\/definitions\/preferences" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updatePrefs", - "group": "teams", - "weight": 543, - "cookies": false, - "type": "", - "demo": "teams\/update-prefs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "teams.write", - "platforms": [ - "console", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md", - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ + }, { - "name": "teamId", - "description": "Team ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -44065,59 +43213,104 @@ "schema": { "type": "object", "properties": { - "prefs": { - "type": "object", - "description": "Prefs key-value JSON object.", - "default": {}, - "x-example": "{}" + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } }, "required": [ - "prefs" + "key", + "required" ] } } ] } }, - "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "List tokens", - "operationId": "tokensList", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "patch": { + "summary": "Update integer column", + "operationId": "tablesDBUpdateIntegerColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tokens" + "tablesDB" ], - "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Resource Tokens List", + "description": "ColumnInteger", "schema": { - "$ref": "#\/definitions\/resourceTokenList" + "$ref": "#\/definitions\/columnInteger" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "files", - "weight": 553, + "method": "updateIntegerColumn", + "group": "columns", + "weight": 785, "cookies": false, "type": "", - "demo": "tokens\/list.md", + "demo": "tablesdb\/update-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [], "Key": [] @@ -44131,47 +43324,85 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File unique ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] - }, + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { "post": { - "summary": "Create file token", - "operationId": "tokensCreateFileToken", + "summary": "Create IP address column", + "operationId": "tablesDBCreateIpColumn", "consumes": [ "application\/json" ], @@ -44179,35 +43410,41 @@ "application\/json" ], "tags": [ - "tokens" + "tablesDB" ], - "description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.", + "description": "Create IP address column.\n", "responses": { - "201": { - "description": "ResourceToken", + "202": { + "description": "ColumnIP", "schema": { - "$ref": "#\/definitions\/resourceToken" + "$ref": "#\/definitions\/columnIp" } } }, "deprecated": false, "x-appwrite": { - "method": "createFileToken", - "group": "files", - "weight": 551, + "method": "createIpColumn", + "group": "columns", + "weight": 786, "cookies": false, "type": "", - "demo": "tokens\/create-file-token.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/create-ip-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [], "Key": [] @@ -44221,19 +43458,19 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File unique ID.", + "name": "tableId", + "description": "Table ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -44242,58 +43479,87 @@ "schema": { "type": "object", "properties": { - "expire": { + "key": { "type": "string", - "description": "Token expiry date", + "description": "Column Key.", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } - } + }, + "required": [ + "key", + "required" + ] } } ] } }, - "\/tokens\/{tokenId}": { - "get": { - "summary": "Get token", - "operationId": "tokensGet", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "patch": { + "summary": "Update IP address column", + "operationId": "tablesDBUpdateIpColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tokens" + "tablesDB" ], - "description": "Get a token by its unique ID.", + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ResourceToken", + "description": "ColumnIP", "schema": { - "$ref": "#\/definitions\/resourceToken" + "$ref": "#\/definitions\/columnIp" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "tokens", - "weight": 552, + "method": "updateIpColumn", + "group": "columns", + "weight": 787, "cookies": false, "type": "", - "demo": "tokens\/get.md", + "demo": "tablesdb\/update-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "tokens.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [], "Key": [] @@ -44307,18 +43573,68 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "default": null, + "x-example": null, + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] - }, - "patch": { - "summary": "Update token", - "operationId": "tokensUpdate", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { + "post": { + "summary": "Create line column", + "operationId": "tablesDBCreateLineColumn", "consumes": [ "application\/json" ], @@ -44326,35 +43642,41 @@ "application\/json" ], "tags": [ - "tokens" + "tablesDB" ], - "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", + "description": "Create a geometric line column.", "responses": { - "200": { - "description": "ResourceToken", + "202": { + "description": "ColumnLine", "schema": { - "$ref": "#\/definitions\/resourceToken" + "$ref": "#\/definitions\/columnLine" } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "tokens", - "weight": 554, + "method": "createLineColumn", + "group": "columns", + "weight": 788, "cookies": false, "type": "", - "demo": "tokens\/update.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", + "demo": "tablesdb\/create-line-column.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [], "Key": [] @@ -44368,11 +43690,19 @@ ], "parameters": [ { - "name": "tokenId", - "description": "Token unique ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -44381,115 +43711,81 @@ "schema": { "type": "object", "properties": { - "expire": { + "key": { "type": "string", - "description": "File token expiry date", + "description": "Column Key.", "default": null, - "x-example": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", + "default": null, + "x-example": "[[1, 2], [3, 4], [5, 6]]", "x-nullable": true } - } + }, + "required": [ + "key", + "required" + ] } } ] - }, - "delete": { - "summary": "Delete token", - "operationId": "tokensDelete", + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { + "patch": { + "summary": "Update line column", + "operationId": "tablesDBUpdateLineColumn", "consumes": [ "application\/json" ], - "produces": [], - "tags": [ - "tokens" - ], - "description": "Delete a token by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "delete", - "group": "tokens", - "weight": 555, - "cookies": false, - "type": "", - "demo": "tokens\/delete.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "tokens.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "tokenId", - "description": "Token ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/users": { - "get": { - "summary": "List users", - "operationId": "usersList", - "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get a list of all the project's users. You can use the query params to filter your results.", + "description": "Update a line column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "Users List", + "description": "ColumnLine", "schema": { - "$ref": "#\/definitions\/userList" + "$ref": "#\/definitions\/columnLine" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "users", - "weight": 76, + "method": "updateLineColumn", + "group": "columns", + "weight": 789, "cookies": false, "type": "", - "demo": "users\/list.md", + "demo": "tablesdb\/update-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [], "Key": [] @@ -44503,40 +43799,67 @@ ], "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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", + "default": null, + "x-example": "[[1, 2], [3, 4], [5, 6]]", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required" + ] + } } ] - }, + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { "post": { - "summary": "Create user", - "operationId": "usersCreate", + "summary": "Create longtext column", + "operationId": "tablesDBCreateLongtextColumn", "consumes": [ "application\/json" ], @@ -44544,36 +43867,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user.", + "description": "Create a longtext column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnLongtext", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnLongtext" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "users", - "weight": 67, + "method": "createLongtextColumn", + "group": "columns", + "weight": 806, "cookies": false, "type": "", - "demo": "users\/create.md", + "demo": "tablesdb\/create-longtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", "auth": { "Project": [], "Key": [] @@ -44586,59 +43914,73 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Column Key.", "default": null, - "x-example": "" + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true + "x-example": false }, - "phone": { + "default": { "type": "string", - "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "+12065550100", - "format": "phone", + "x-example": "", "x-nullable": true }, - "password": { - "type": "string", - "description": "Plain text user password. Must be at least 8 chars.", - "default": "", - "x-example": null + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false } }, "required": [ - "userId" + "key", + "required" ] } } ] } }, - "\/users\/argon2": { - "post": { - "summary": "Create user with Argon2 password", - "operationId": "usersCreateArgon2User", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { + "patch": { + "summary": "Update longtext column", + "operationId": "tablesDBUpdateLongtextColumn", "consumes": [ "application\/json" ], @@ -44646,36 +43988,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnLongtext", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnLongtext" } } }, "deprecated": false, "x-appwrite": { - "method": "createArgon2User", - "group": "users", - "weight": 70, + "method": "updateLongtextColumn", + "group": "columns", + "weight": 807, "cookies": false, "type": "", - "demo": "users\/create-argon-2-user.md", + "demo": "tablesdb\/update-longtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", "auth": { "Project": [], "Key": [] @@ -44688,53 +44035,69 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "" + "x-example": false }, - "email": { + "default": { "type": "string", - "description": "User email.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": "", + "x-nullable": true }, - "password": { + "newKey": { "type": "string", - "description": "User password hashed using Argon2.", + "description": "New Column Key.", "default": null, - "x-example": "password", - "format": "password" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "required", + "default" ] } } ] } }, - "\/users\/bcrypt": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { "post": { - "summary": "Create user with bcrypt password", - "operationId": "usersCreateBcryptUser", + "summary": "Create mediumtext column", + "operationId": "tablesDBCreateMediumtextColumn", "consumes": [ "application\/json" ], @@ -44742,36 +44105,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a mediumtext column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnMediumtext", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnMediumtext" } } }, "deprecated": false, "x-appwrite": { - "method": "createBcryptUser", - "group": "users", - "weight": 68, + "method": "createMediumtextColumn", + "group": "columns", + "weight": 804, "cookies": false, "type": "", - "demo": "users\/create-bcrypt-user.md", + "demo": "tablesdb\/create-mediumtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", "auth": { "Project": [], "Key": [] @@ -44784,88 +44152,115 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Column Key.", "default": null, - "x-example": "" + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": false }, - "password": { + "default": { "type": "string", - "description": "User password hashed using Bcrypt.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "password", - "format": "password" + "x-example": "", + "x-nullable": true }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false } }, "required": [ - "userId", - "email", - "password" + "key", + "required" ] } } ] } }, - "\/users\/identities": { - "get": { - "summary": "List identities", - "operationId": "usersListIdentities", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { + "patch": { + "summary": "Update mediumtext column", + "operationId": "tablesDBUpdateMediumtextColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get identities for all users.", + "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Identities List", + "description": "ColumnMediumtext", "schema": { - "$ref": "#\/definitions\/identityList" + "$ref": "#\/definitions\/columnMediumtext" } } }, "deprecated": false, "x-appwrite": { - "method": "listIdentities", - "group": "identities", - "weight": 84, + "method": "updateMediumtextColumn", + "group": "columns", + "weight": 805, "cookies": false, "type": "", - "demo": "users\/list-identities.md", + "demo": "tablesdb\/update-mediumtext-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", "auth": { "Project": [], "Key": [] @@ -44879,74 +44274,110 @@ ], "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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } }, - "\/users\/identities\/{identityId}": { - "delete": { - "summary": "Delete identity", - "operationId": "usersDeleteIdentity", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { + "post": { + "summary": "Create point column", + "operationId": "tablesDBCreatePointColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "users" + "tablesDB" ], - "description": "Delete an identity by its unique ID.", + "description": "Create a geometric point column.", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnPoint", + "schema": { + "$ref": "#\/definitions\/columnPoint" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteIdentity", - "group": "identities", - "weight": 108, + "method": "createPointColumn", + "group": "columns", + "weight": 790, "cookies": false, "type": "", - "demo": "users\/delete-identity.md", + "demo": "tablesdb\/create-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [], "Key": [] @@ -44960,20 +44391,60 @@ ], "parameters": [ { - "name": "identityId", - "description": "Identity ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "array", + "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", + "default": null, + "x-example": "[1, 2]", + "x-nullable": true + } + }, + "required": [ + "key", + "required" + ] + } } ] } }, - "\/users\/md5": { - "post": { - "summary": "Create user with MD5 password", - "operationId": "usersCreateMD5User", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "patch": { + "summary": "Update point column", + "operationId": "tablesDBUpdatePointColumn", "consumes": [ "application\/json" ], @@ -44981,36 +44452,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update a point column. Changing the `default` value will not update already existing rows.", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnPoint", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnPoint" } } }, "deprecated": false, "x-appwrite": { - "method": "createMD5User", - "group": "users", - "weight": 69, + "method": "updatePointColumn", + "group": "columns", + "weight": 791, "cookies": false, "type": "", - "demo": "users\/create-md-5-user.md", + "demo": "tablesdb\/update-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [], "Key": [] @@ -45023,53 +44499,68 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "" + "x-example": false }, - "email": { - "type": "string", - "description": "User email.", + "default": { + "type": "array", + "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": "[1, 2]", + "x-nullable": true }, - "password": { + "newKey": { "type": "string", - "description": "User password hashed using MD5.", + "description": "New Column Key.", "default": null, - "x-example": "password", - "format": "password" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "x-example": null, + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "required" ] } } ] } }, - "\/users\/phpass": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { "post": { - "summary": "Create user with PHPass password", - "operationId": "usersCreatePHPassUser", + "summary": "Create polygon column", + "operationId": "tablesDBCreatePolygonColumn", "consumes": [ "application\/json" ], @@ -45077,36 +44568,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a geometric polygon column.", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnPolygon", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnPolygon" } } }, "deprecated": false, "x-appwrite": { - "method": "createPHPassUser", - "group": "users", - "weight": 72, + "method": "createPolygonColumn", + "group": "columns", + "weight": 792, "cookies": false, "type": "", - "demo": "users\/create-ph-pass-user.md", + "demo": "tablesdb\/create-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", "auth": { "Project": [], "Key": [] @@ -45119,53 +44615,61 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Column Key.", "default": null, - "x-example": "" + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": false }, - "password": { - "type": "string", - "description": "User password hashed using PHPass.", + "default": { + "type": "array", + "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "default": null, - "x-example": "password", - "format": "password" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-nullable": true } }, "required": [ - "userId", - "email", - "password" + "key", + "required" ] } } ] } }, - "\/users\/scrypt": { - "post": { - "summary": "Create user with Scrypt password", - "operationId": "usersCreateScryptUser", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "patch": { + "summary": "Update polygon column", + "operationId": "tablesDBUpdatePolygonColumn", "consumes": [ "application\/json" ], @@ -45173,36 +44677,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", "responses": { - "201": { - "description": "User", + "200": { + "description": "ColumnPolygon", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnPolygon" } } }, "deprecated": false, "x-appwrite": { - "method": "createScryptUser", - "group": "users", - "weight": 73, + "method": "updatePolygonColumn", + "group": "columns", + "weight": 793, "cookies": false, "type": "", - "demo": "users\/create-scrypt-user.md", + "demo": "tablesdb\/update-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", "auth": { "Project": [], "Key": [] @@ -45215,92 +44724,68 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "email": { - "type": "string", - "description": "User email.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": false }, - "password": { - "type": "string", - "description": "User password hashed using Scrypt.", + "default": { + "type": "array", + "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "default": null, - "x-example": "password", - "format": "password" + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-nullable": true }, - "passwordSalt": { + "newKey": { "type": "string", - "description": "Optional salt used to hash password.", - "default": null, - "x-example": "" - }, - "passwordCpu": { - "type": "integer", - "description": "Optional CPU cost used to hash password.", - "default": null, - "x-example": null, - "format": "int32" - }, - "passwordMemory": { - "type": "integer", - "description": "Optional memory cost used to hash password.", - "default": null, - "x-example": null, - "format": "int32" - }, - "passwordParallel": { - "type": "integer", - "description": "Optional parallelization cost used to hash password.", - "default": null, - "x-example": null, - "format": "int32" - }, - "passwordLength": { - "type": "integer", - "description": "Optional hash length used to hash password.", + "description": "New Column Key.", "default": null, "x-example": null, - "format": "int32" - }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "x-nullable": true } }, "required": [ - "userId", - "email", - "password", - "passwordSalt", - "passwordCpu", - "passwordMemory", - "passwordParallel", - "passwordLength" + "required" ] } } ] } }, - "\/users\/scrypt-modified": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { "post": { - "summary": "Create user with Scrypt modified password", - "operationId": "usersCreateScryptModifiedUser", + "summary": "Create relationship column", + "operationId": "tablesDBCreateRelationshipColumn", "consumes": [ "application\/json" ], @@ -45308,36 +44793,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnRelationship", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnRelationship" } } }, "deprecated": false, "x-appwrite": { - "method": "createScryptModifiedUser", - "group": "users", - "weight": 74, + "method": "createRelationshipColumn", + "group": "columns", + "weight": 794, "cookies": false, "type": "", - "demo": "users\/create-scrypt-modified-user.md", + "demo": "tablesdb\/create-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", "auth": { "Project": [], "Key": [] @@ -45350,74 +44840,95 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { - "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "email": { + "relatedTableId": { "type": "string", - "description": "User email.", + "description": "Related Table ID.", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": "" }, - "password": { + "type": { "type": "string", - "description": "User password hashed using Scrypt Modified.", + "description": "Relation type", "default": null, - "x-example": "password", - "format": "password" + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [] }, - "passwordSalt": { - "type": "string", - "description": "Salt used to hash password.", - "default": null, - "x-example": "" + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, + "x-example": false }, - "passwordSaltSeparator": { + "key": { "type": "string", - "description": "Salt separator used to hash password.", + "description": "Column Key.", "default": null, - "x-example": "" + "x-example": null, + "x-nullable": true }, - "passwordSignerKey": { + "twoWayKey": { "type": "string", - "description": "Signer key used to hash password.", + "description": "Two Way Column Key.", "default": null, - "x-example": "" + "x-example": null, + "x-nullable": true }, - "name": { + "onDelete": { "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "userId", - "email", - "password", - "passwordSalt", - "passwordSaltSeparator", - "passwordSignerKey" + "relatedTableId", + "type" ] } } ] } }, - "\/users\/sha": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { "post": { - "summary": "Create user with SHA password", - "operationId": "usersCreateSHAUser", + "summary": "Create string column", + "operationId": "tablesDBCreateStringColumn", "consumes": [ "application\/json" ], @@ -45425,36 +44936,45 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "description": "Create a string column.\n", "responses": { - "201": { - "description": "User", + "202": { + "description": "ColumnString", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createSHAUser", - "group": "users", - "weight": 71, + "method": "createStringColumn", + "group": "columns", + "weight": 796, "cookies": false, "type": "", - "demo": "users\/create-sha-user.md", + "demo": "tablesdb\/create-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", + "deprecated": { + "since": "1.9.0", + "replaceWith": "tablesDB.createTextColumn" + }, "auth": { "Project": [], "Key": [] @@ -45467,109 +44987,127 @@ } ], "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "userId": { + "key": { "type": "string", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "Column Key.", "default": null, - "x-example": "" + "x-example": null }, - "email": { - "type": "string", - "description": "User email.", + "size": { + "type": "integer", + "description": "Column size for text columns, in number of characters.", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": 1, + "format": "int32" }, - "password": { - "type": "string", - "description": "User password hashed using SHA.", + "required": { + "type": "boolean", + "description": "Is column required?", "default": null, - "x-example": "password", - "format": "password" + "x-example": false }, - "passwordVersion": { + "default": { "type": "string", - "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", - "default": "", - "x-example": "sha1", - "enum": [ - "sha1", - "sha224", - "sha256", - "sha384", - "sha512\/224", - "sha512\/256", - "sha512", - "sha3-224", - "sha3-256", - "sha3-384", - "sha3-512" - ], - "x-enum-name": "PasswordHash", - "x-enum-keys": [] + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true }, - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": "", - "x-example": "" + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false } }, "required": [ - "userId", - "email", - "password" + "key", + "size", + "required" ] } } ] } }, - "\/users\/{userId}": { - "get": { - "summary": "Get user", - "operationId": "usersGet", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { + "patch": { + "summary": "Update string column", + "operationId": "tablesDBUpdateStringColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get a user by its unique ID.", + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "User", + "description": "ColumnString", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "get", - "group": "users", - "weight": 77, + "method": "updateStringColumn", + "group": "columns", + "weight": 797, "cookies": false, "type": "", - "demo": "users\/get.md", + "demo": "tablesdb\/update-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateTextColumn" + }, "auth": { "Project": [], "Key": [] @@ -45583,50 +45121,118 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - } - ] - }, - "delete": { - "summary": "Delete user", - "operationId": "usersDelete", + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { + "post": { + "summary": "Create text column", + "operationId": "tablesDBCreateTextColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "users" + "tablesDB" ], - "description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.", + "description": "Create a text column.\n", "responses": { - "204": { - "description": "No content" + "202": { + "description": "ColumnText", + "schema": { + "$ref": "#\/definitions\/columnText" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "users", - "weight": 106, + "method": "createTextColumn", + "group": "columns", + "weight": 802, "cookies": false, "type": "", - "demo": "users\/delete.md", + "demo": "tablesdb\/create-text-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", "auth": { "Project": [], "Key": [] @@ -45640,20 +45246,72 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } } ] } }, - "\/users\/{userId}\/email": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { "patch": { - "summary": "Update email", - "operationId": "usersUpdateEmail", + "summary": "Update text column", + "operationId": "tablesDBUpdateTextColumn", "consumes": [ "application\/json" ], @@ -45661,36 +45319,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user email by its unique ID.", + "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "User", + "description": "ColumnText", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnText" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmail", - "group": "users", - "weight": 91, + "method": "updateTextColumn", + "group": "columns", + "weight": 803, "cookies": false, "type": "", - "demo": "users\/update-email.md", + "demo": "tablesdb\/update-text-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", "auth": { "Project": [], "Key": [] @@ -45704,11 +45367,26 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -45717,26 +45395,40 @@ "schema": { "type": "object", "properties": { - "email": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { "type": "string", - "description": "User email.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "email@example.com", - "format": "email" + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "email" + "required", + "default" ] } } ] } }, - "\/users\/{userId}\/impersonator": { - "patch": { - "summary": "Update user impersonator capability", - "operationId": "usersUpdateImpersonator", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "post": { + "summary": "Create URL column", + "operationId": "tablesDBCreateUrlColumn", "consumes": [ "application\/json" ], @@ -45744,36 +45436,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.\n", + "description": "Create a URL column.\n", "responses": { - "200": { - "description": "User", + "202": { + "description": "ColumnURL", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnUrl" } } }, "deprecated": false, "x-appwrite": { - "method": "updateImpersonator", - "group": "users", - "weight": 87, + "method": "createUrlColumn", + "group": "columns", + "weight": 798, "cookies": false, "type": "", - "demo": "users\/update-impersonator.md", + "demo": "tablesdb\/create-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-impersonator.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", "auth": { "Project": [], "Key": [] @@ -45787,11 +45484,19 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -45800,25 +45505,46 @@ "schema": { "type": "object", "properties": { - "impersonator": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, + "required": { "type": "boolean", - "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, "x-example": false } }, "required": [ - "impersonator" + "key", + "required" ] } } ] } }, - "\/users\/{userId}\/jwts": { - "post": { - "summary": "Create user JWT", - "operationId": "usersCreateJWT", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "patch": { + "summary": "Update URL column", + "operationId": "tablesDBUpdateUrlColumn", "consumes": [ "application\/json" ], @@ -45826,36 +45552,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.", + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", "responses": { - "201": { - "description": "JWT", + "200": { + "description": "ColumnURL", "schema": { - "$ref": "#\/definitions\/jwt" + "$ref": "#\/definitions\/columnUrl" } } }, "deprecated": false, "x-appwrite": { - "method": "createJWT", - "group": "sessions", - "weight": 109, + "method": "updateUrlColumn", + "group": "columns", + "weight": 799, "cookies": false, "type": "", - "demo": "users\/create-jwt.md", + "demo": "tablesdb\/update-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", "auth": { "Project": [], "Key": [] @@ -45869,11 +45600,26 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -45882,29 +45628,41 @@ "schema": { "type": "object", "properties": { - "sessionId": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { "type": "string", - "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", - "default": "", - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, - "duration": { - "type": "integer", - "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", - "default": 900, - "x-example": 0, - "format": "int32" + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } ] } }, - "\/users\/{userId}\/labels": { - "put": { - "summary": "Update user labels", - "operationId": "usersUpdateLabels", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { + "post": { + "summary": "Create varchar column", + "operationId": "tablesDBCreateVarcharColumn", "consumes": [ "application\/json" ], @@ -45912,36 +45670,41 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.", + "description": "Create a varchar column.\n", "responses": { - "200": { - "description": "User", + "202": { + "description": "ColumnVarchar", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/columnVarchar" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLabels", - "group": "users", - "weight": 86, + "method": "createVarcharColumn", + "group": "columns", + "weight": 800, "cookies": false, "type": "", - "demo": "users\/update-labels.md", + "demo": "tablesdb\/create-varchar-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", "auth": { "Project": [], "Key": [] @@ -45955,11 +45718,19 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -45968,63 +45739,101 @@ "schema": { "type": "object", "properties": { - "labels": { - "type": "array", - "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "key": { + "type": "string", + "description": "Column Key.", "default": null, - "x-example": null, - "items": { - "type": "string" - } + "x-example": null + }, + "size": { + "type": "integer", + "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", + "default": false, + "x-example": false } }, "required": [ - "labels" + "key", + "size", + "required" ] } } ] } }, - "\/users\/{userId}\/logs": { - "get": { - "summary": "List user logs", - "operationId": "usersListLogs", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { + "patch": { + "summary": "Update varchar column", + "operationId": "tablesDBUpdateVarcharColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get the user activity logs list by its unique ID.", + "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "Logs List", + "description": "ColumnVarchar", "schema": { - "$ref": "#\/definitions\/logList" + "$ref": "#\/definitions\/columnVarchar" } } }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 82, + "method": "updateVarcharColumn", + "group": "columns", + "weight": 801, "cookies": false, "type": "", - "demo": "users\/list-logs.md", + "demo": "tablesdb\/update-varchar-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", "auth": { "Project": [], "Key": [] @@ -46038,76 +45847,198 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is column required?", + "default": null, + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the varchar column.", + "default": null, + "x-example": 1, + "format": "int32", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } } ] } }, - "\/users\/{userId}\/memberships": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": { "get": { - "summary": "List user memberships", - "operationId": "usersListMemberships", + "summary": "Get column", + "operationId": "tablesDBGetColumn", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get the user membership list by its unique ID.", + "description": "Get column by ID.", "responses": { "200": { - "description": "Memberships List", + "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString", "schema": { - "$ref": "#\/definitions\/membershipList" + "x-oneOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnString" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/definitions\/columnBoolean", + "integer": "#\/definitions\/columnInteger", + "double": "#\/definitions\/columnFloat", + "string": "#\/definitions\/columnString", + "datetime": "#\/definitions\/columnDatetime", + "relationship": "#\/definitions\/columnRelationship" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/definitions\/columnBoolean": { + "type": "boolean" + }, + "#\/definitions\/columnInteger": { + "type": "integer" + }, + "#\/definitions\/columnFloat": { + "type": "double" + }, + "#\/definitions\/columnEmail": { + "type": "string", + "format": "email" + }, + "#\/definitions\/columnEnum": { + "type": "string", + "format": "enum" + }, + "#\/definitions\/columnUrl": { + "type": "string", + "format": "url" + }, + "#\/definitions\/columnIp": { + "type": "string", + "format": "ip" + }, + "#\/definitions\/columnDatetime": { + "type": "datetime" + }, + "#\/definitions\/columnRelationship": { + "type": "relationship" + }, + "#\/definitions\/columnString": { + "type": "string" + } + } + } } } }, "deprecated": false, "x-appwrite": { - "method": "listMemberships", - "group": "memberships", - "weight": 81, + "method": "getColumn", + "group": "columns", + "weight": 771, "cookies": false, "type": "", - "demo": "users\/list-memberships.md", + "demo": "tablesdb\/get-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.read", + "collections.read", + "columns.read", + "attributes.read" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md", "auth": { "Project": [], "Key": [] @@ -46121,149 +46052,70 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "tableId", + "description": "Table ID.", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" } ] - } - }, - "\/users\/{userId}\/mfa": { - "patch": { - "summary": "Update MFA", - "operationId": "usersUpdateMfa", + }, + "delete": { + "summary": "Delete column", + "operationId": "tablesDBDeleteColumn", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "users" + "tablesDB" ], - "description": "Enable or disable MFA on a user account.", + "description": "Deletes a column.", "responses": { - "200": { - "description": "User", - "schema": { - "$ref": "#\/definitions\/user" - } + "204": { + "description": "No content" } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateMfa", - "group": "users", - "weight": 96, + "method": "deleteColumn", + "group": "columns", + "weight": 772, "cookies": false, "type": "", - "demo": "users\/update-mfa.md", + "demo": "tablesdb\/delete-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFA" - }, - "methods": [ - { - "name": "updateMfa", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId", - "mfa" - ], - "required": [ - "userId", - "mfa" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/user" - } - ], - "description": "Enable or disable MFA on a user account.", - "demo": "users\/update-mfa.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFA" - } - }, - { - "name": "updateMFA", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId", - "mfa" - ], - "required": [ - "userId", - "mfa" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/user" - } - ], - "description": "Enable or disable MFA on a user account.", - "demo": "users\/update-mfa.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md", "auth": { "Project": [], "Key": [] @@ -46277,130 +46129,77 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "mfa": { - "type": "boolean", - "description": "Enable or disable MFA.", - "default": null, - "x-example": false - } - }, - "required": [ - "mfa" - ] - } + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" } ] } }, - "\/users\/{userId}\/mfa\/authenticators\/{type}": { - "delete": { - "summary": "Delete authenticator", - "operationId": "usersDeleteMfaAuthenticator", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": { + "patch": { + "summary": "Update relationship column", + "operationId": "tablesDBUpdateRelationshipColumn", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "users" + "tablesDB" ], - "description": "Delete an authenticator app.", + "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "204": { - "description": "No content" + "200": { + "description": "ColumnRelationship", + "schema": { + "$ref": "#\/definitions\/columnRelationship" + } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "deleteMfaAuthenticator", - "group": "mfa", - "weight": 101, + "method": "updateRelationshipColumn", + "group": "columns", + "weight": 795, "cookies": false, "type": "", - "demo": "users\/delete-mfa-authenticator.md", + "demo": "tablesdb\/update-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "columns.write", + "attributes.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.deleteMFAAuthenticator" - }, - "methods": [ - { - "name": "deleteMfaAuthenticator", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId", - "type" - ], - "required": [ - "userId", - "type" - ], - "responses": [ - { - "code": 204 - } - ], - "description": "Delete an authenticator app.", - "demo": "users\/delete-mfa-authenticator.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.deleteMFAAuthenticator" - } - }, - { - "name": "deleteMFAAuthenticator", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId", - "type" - ], - "required": [ - "userId", - "type" - ], - "responses": [ - { - "code": 204 - } - ], - "description": "Delete an authenticator app.", - "demo": "users\/delete-mfa-authenticator.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md", "auth": { "Project": [], "Key": [] @@ -46414,126 +46213,104 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "type", - "description": "Type of authenticator.", + "name": "tableId", + "description": "Table ID.", "required": true, "type": "string", - "x-example": "totp", - "enum": [ - "totp" - ], - "x-enum-name": "AuthenticatorType", - "x-enum-keys": [], + "x-example": "", "in": "path" - } - ] - } - }, - "\/users\/{userId}\/mfa\/factors": { - "get": { - "summary": "List factors", - "operationId": "usersListMfaFactors", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "users" - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "responses": { - "200": { - "description": "MFAFactors", - "schema": { - "$ref": "#\/definitions\/mfaFactors" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "listMfaFactors", - "group": "mfa", - "weight": 97, + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": null, + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [], + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + } + } + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "tablesDBListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "tablesDB" + ], + "description": "List indexes on the table.", + "responses": { + "200": { + "description": "Column Indexes List", + "schema": { + "$ref": "#\/definitions\/columnIndexList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 811, "cookies": false, "type": "", - "demo": "users\/list-mfa-factors.md", + "demo": "tablesdb\/list-indexes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.read", + "collections.read", + "indexes.read" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.listMFAFactors" - }, - "methods": [ - { - "name": "listMfaFactors", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaFactors" - } - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "demo": "users\/list-mfa-factors.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.listMFAFactors" - } - }, - { - "name": "listMFAFactors", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaFactors" - } - ], - "description": "List the factors available on the account to be used as a MFA challange.", - "demo": "users\/list-mfa-factors.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md", "auth": { "Project": [], "Key": [] @@ -46547,113 +46324,88 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, status, attributes, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/users\/{userId}\/mfa\/recovery-codes": { - "get": { - "summary": "Get MFA recovery codes", - "operationId": "usersGetMfaRecoveryCodes", - "consumes": [], + }, + "post": { + "summary": "Create index", + "operationId": "tablesDBCreateIndex", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.", "responses": { - "200": { - "description": "MFA Recovery Codes", + "202": { + "description": "Index", "schema": { - "$ref": "#\/definitions\/mfaRecoveryCodes" + "$ref": "#\/definitions\/columnIndex" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getMfaRecoveryCodes", - "group": "mfa", - "weight": 98, + "method": "createIndex", + "group": "indexes", + "weight": 808, "cookies": false, "type": "", - "demo": "users\/get-mfa-recovery-codes.md", + "demo": "tablesdb\/create-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "tables.write", + "collections.write", + "indexes.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.getMFARecoveryCodes" - }, - "methods": [ - { - "name": "getMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/get-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.getMFARecoveryCodes" - } - }, - { - "name": "getMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/get-mfa-recovery-codes.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md", "auth": { "Project": [], "Key": [] @@ -46667,113 +46419,134 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "default": null, + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "default": null, + "x-example": "key", + "enum": [ + "key", + "fulltext", + "unique", + "spatial" + ], + "x-enum-name": "TablesDBIndexType", + "x-enum-keys": [] + }, + "columns": { + "type": "array", + "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "columns" + ] + } } ] - }, - "put": { - "summary": "Update MFA recovery codes (regenerate)", - "operationId": "usersUpdateMfaRecoveryCodes", - "consumes": [ - "application\/json" - ], + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "tablesDBGetIndex", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "description": "Get index by ID.", "responses": { "200": { - "description": "MFA Recovery Codes", + "description": "Index", "schema": { - "$ref": "#\/definitions\/mfaRecoveryCodes" + "$ref": "#\/definitions\/columnIndex" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateMfaRecoveryCodes", - "group": "mfa", - "weight": 100, + "method": "getIndex", + "group": "indexes", + "weight": 809, "cookies": false, "type": "", - "demo": "users\/update-mfa-recovery-codes.md", + "demo": "tablesdb\/get-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.read", + "collections.read", + "indexes.read" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFARecoveryCodes" - }, - "methods": [ - { - "name": "updateMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/update-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.updateMFARecoveryCodes" - } - }, - { - "name": "updateMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", - "demo": "users\/update-mfa-recovery-codes.md", - "public": false - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md", "auth": { "Project": [], "Key": [] @@ -46787,113 +46560,69 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", "required": true, "type": "string", - "x-example": "", "in": "path" } ] }, - "patch": { - "summary": "Create MFA recovery codes", - "operationId": "usersCreateMfaRecoveryCodes", + "delete": { + "summary": "Delete index", + "operationId": "tablesDBDeleteIndex", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "users" + "tablesDB" ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "description": "Delete an index.", "responses": { - "201": { - "description": "MFA Recovery Codes", - "schema": { - "$ref": "#\/definitions\/mfaRecoveryCodes" - } + "204": { + "description": "No content" } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createMfaRecoveryCodes", - "group": "mfa", - "weight": 99, + "method": "deleteIndex", + "group": "indexes", + "weight": 810, "cookies": false, "type": "", - "demo": "users\/create-mfa-recovery-codes.md", + "demo": "tablesdb\/delete-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "tables.write", + "collections.write", + "indexes.write" + ], "platforms": [ "console", "server" ], "packaging": false, - "public": false, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.createMFARecoveryCodes" - }, - "methods": [ - { - "name": "createMfaRecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", - "demo": "users\/create-mfa-recovery-codes.md", - "public": false, - "deprecated": { - "since": "1.8.0", - "replaceWith": "users.createMFARecoveryCodes" - } - }, - { - "name": "createMFARecoveryCodes", - "namespace": "users", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "userId" - ], - "required": [ - "userId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/mfaRecoveryCodes" - } - ], - "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", - "demo": "users\/create-mfa-recovery-codes.md", - "public": true - } - ], + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md", "auth": { "Project": [], "Key": [] @@ -46907,102 +46636,148 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", "required": true, "type": "string", - "x-example": "", "in": "path" } ] } }, - "\/users\/{userId}\/name": { - "patch": { - "summary": "Update name", - "operationId": "usersUpdateName", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": { + "get": { + "summary": "List rows", + "operationId": "tablesDBListRows", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user name by its unique ID.", + "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.", "responses": { "200": { - "description": "User", + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/rowList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateName", - "group": "users", - "weight": 89, + "method": "listRows", + "group": "rows", + "weight": 899, "cookies": false, "type": "", - "demo": "users\/update-name.md", + "demo": "tablesdb\/list-rows.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "User name. Max length: 128 chars.", - "default": null, - "x-example": "" - } - }, - "required": [ - "name" - ] - } + "name": "tableId", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query \u2014 so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" } ] - } - }, - "\/users\/{userId}\/password": { - "patch": { - "summary": "Update password", - "operationId": "usersUpdatePassword", + }, + "post": { + "summary": "Create row", + "operationId": "tablesDBCreateRow", "consumes": [ "application\/json" ], @@ -47010,54 +46785,131 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user password by its unique ID.", + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { - "200": { - "description": "User", + "201": { + "description": "Row", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/row" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePassword", - "group": "users", - "weight": 90, + "method": "createRow", + "group": "rows", + "weight": 812, "cookies": false, "type": "", - "demo": "users\/update-password.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/create-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md", + "methods": [ + { + "name": "createRow", + "namespace": "tablesDB", + "desc": "Create row", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "tableId", + "rowId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/create-row.md", + "public": true + }, + { + "name": "createRows", + "namespace": "tablesDB", + "desc": "Create rows", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows", + "transactionId" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/create-rows.md", + "public": true + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -47066,25 +46918,52 @@ "schema": { "type": "object", "properties": { - "password": { + "rowId": { "type": "string", - "description": "New user password. Must be at least 8 chars.", + "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Row data as JSON object.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, - "x-example": null + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "description": "Array of rows data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true } - }, - "required": [ - "password" - ] + } } } ] - } - }, - "\/users\/{userId}\/phone": { - "patch": { - "summary": "Update phone", - "operationId": "usersUpdatePhone", + }, + "put": { + "summary": "Upsert rows", + "operationId": "tablesDBUpsertRows", "consumes": [ "application\/json" ], @@ -47092,36 +46971,70 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user phone by its unique ID.", + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", "responses": { - "200": { - "description": "User", + "201": { + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/rowList" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePhone", - "group": "users", - "weight": 92, + "method": "upsertRows", + "group": "rows", + "weight": 817, "cookies": false, "type": "", - "demo": "users\/update-phone.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/upsert-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md", + "methods": [ + { + "name": "upsertRows", + "namespace": "tablesDB", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rows", + "transactionId" + ], + "required": [ + "databaseId", + "tableId", + "rows" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/rowList" + } + ], + "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n", + "demo": "tablesdb\/upsert-rows.md", + "public": true + } + ], "auth": { "Project": [], "Key": [] @@ -47135,11 +47048,19 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -47148,61 +47069,73 @@ "schema": { "type": "object", "properties": { - "number": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { "type": "string", - "description": "User phone number.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": "+12065550100", - "format": "phone" + "x-example": "", + "x-nullable": true } }, "required": [ - "number" + "rows" ] } } ] - } - }, - "\/users\/{userId}\/prefs": { - "get": { - "summary": "Get user preferences", - "operationId": "usersGetPrefs", - "consumes": [], + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesDBUpdateRows", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get the user preferences by its unique ID.", + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", "responses": { "200": { - "description": "Preferences", + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/preferences" + "$ref": "#\/definitions\/rowList" } } }, "deprecated": false, "x-appwrite": { - "method": "getPrefs", - "group": "users", - "weight": 78, + "method": "updateRows", + "group": "rows", + "weight": 815, "cookies": false, "type": "", - "demo": "users\/get-prefs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "demo": "tablesdb\/update-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", "auth": { "Project": [], "Key": [] @@ -47216,55 +47149,97 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - } - ] - }, - "patch": { - "summary": "Update user preferences", - "operationId": "usersUpdatePrefs", - "consumes": [ - "application\/json" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } + } + ] + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDBDeleteRows", + "consumes": [ + "application\/json" ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.", + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", "responses": { "200": { - "description": "Preferences", + "description": "Rows List", "schema": { - "$ref": "#\/definitions\/preferences" + "$ref": "#\/definitions\/rowList" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePrefs", - "group": "users", - "weight": 94, + "method": "deleteRows", + "group": "rows", + "weight": 819, "cookies": false, "type": "", - "demo": "users\/update-prefs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/delete-rows.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", "auth": { "Project": [], "Key": [] @@ -47278,11 +47253,19 @@ ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -47291,94 +47274,134 @@ "schema": { "type": "object", "properties": { - "prefs": { - "type": "object", - "description": "Prefs key-value JSON object.", - "default": {}, - "x-example": "{}" + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true } - }, - "required": [ - "prefs" - ] + } } } ] } }, - "\/users\/{userId}\/sessions": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { "get": { - "summary": "List user sessions", - "operationId": "usersListSessions", + "summary": "Get row", + "operationId": "tablesDBGetRow", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Get the user sessions list by its unique ID.", + "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.", "responses": { "200": { - "description": "Sessions List", + "description": "Row", "schema": { - "$ref": "#\/definitions\/sessionList" + "$ref": "#\/definitions\/row" } } }, "deprecated": false, "x-appwrite": { - "method": "listSessions", - "group": "sessions", - "weight": 80, + "method": "getRow", + "group": "rows", + "weight": 813, "cookies": false, "type": "", - "demo": "users\/list-sessions.md", + "demo": "tablesdb\/get-row.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.read", + "scope": [ + "rows.read", + "documents.read" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", "required": false, - "type": "boolean", - "x-example": false, - "default": true, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", "in": "query" } ] }, - "post": { - "summary": "Create session", - "operationId": "usersCreateSession", + "put": { + "summary": "Upsert a row", + "operationId": "tablesDBUpsertRow", "consumes": [ "application\/json" ], @@ -47386,128 +47409,272 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.", + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { "201": { - "description": "Session", + "description": "Row", "schema": { - "$ref": "#\/definitions\/session" + "$ref": "#\/definitions\/row" } } }, "deprecated": false, "x-appwrite": { - "method": "createSession", - "group": "sessions", - "weight": 102, + "method": "upsertRow", + "group": "rows", + "weight": 816, "cookies": false, "type": "", - "demo": "users\/create-session.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/upsert-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md", + "methods": [ + { + "name": "upsertRow", + "namespace": "tablesDB", + "desc": "", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "tableId", + "rowId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "tableId", + "rowId" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/row" + } + ], + "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "demo": "tablesdb\/upsert-row.md", + "public": true + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] }, - "delete": { - "summary": "Delete user sessions", - "operationId": "usersDeleteSessions", + "patch": { + "summary": "Update row", + "operationId": "tablesDBUpdateRow", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "users" + "tablesDB" ], - "description": "Delete all user's sessions by using the user's unique ID.", + "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Row", + "schema": { + "$ref": "#\/definitions\/row" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteSessions", - "group": "sessions", - "weight": 105, + "method": "updateRow", + "group": "rows", + "weight": 814, "cookies": false, "type": "", - "demo": "users\/delete-sessions.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/update-row.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only columns and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] - } - }, - "\/users\/{userId}\/sessions\/{sessionId}": { + }, "delete": { - "summary": "Delete user session", - "operationId": "usersDeleteSession", + "summary": "Delete row", + "operationId": "tablesDBDeleteRow", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "users" + "tablesDB" ], - "description": "Delete a user sessions by its unique ID.", + "description": "Delete a row by its unique ID.", "responses": { "204": { "description": "No content" @@ -47515,58 +47682,88 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteSession", - "group": "sessions", - "weight": 104, + "method": "deleteRow", + "group": "rows", + "weight": 818, "cookies": false, "type": "", - "demo": "users\/delete-session.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/delete-row.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "sessionId", - "description": "Session ID.", + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] } }, - "\/users\/{userId}\/status": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { "patch": { - "summary": "Update user status", - "operationId": "usersUpdateStatus", + "summary": "Decrement row column", + "operationId": "tablesDBDecrementRowColumn", "consumes": [ "application\/json" ], @@ -47574,54 +47771,83 @@ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.", + "description": "Decrement a specific column of a row by a given value.", "responses": { "200": { - "description": "User", + "description": "Row", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/row" } } }, "deprecated": false, "x-appwrite": { - "method": "updateStatus", - "group": "users", - "weight": 85, + "method": "decrementRowColumn", + "group": "rows", + "weight": 823, "cookies": false, "type": "", - "demo": "users\/update-status.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "demo": "tablesdb\/decrement-row-column.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ - "console", - "server" + "client", + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], + "Session": [], + "JWT": [], "Key": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, { @@ -47630,83 +47856,215 @@ "schema": { "type": "object", "properties": { - "status": { - "type": "boolean", - "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" + }, + "min": { + "type": "number", + "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", "default": null, - "x-example": false + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true } - }, - "required": [ - "status" - ] + } } } ] } }, - "\/users\/{userId}\/targets": { - "get": { - "summary": "List user targets", - "operationId": "usersListTargets", - "consumes": [], + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": { + "patch": { + "summary": "Increment row column", + "operationId": "tablesDBIncrementRowColumn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "users" + "tablesDB" ], - "description": "List the messaging targets that are associated with a user.", + "description": "Increment a specific column of a row by a given value.", "responses": { "200": { - "description": "Target list", + "description": "Row", "schema": { - "$ref": "#\/definitions\/targetList" + "$ref": "#\/definitions\/row" } } }, "deprecated": false, "x-appwrite": { - "method": "listTargets", - "group": "targets", - "weight": 83, + "method": "incrementRowColumn", + "group": "rows", + "weight": 822, "cookies": false, "type": "", - "demo": "users\/list-targets.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "targets.read", + "demo": "tablesdb\/increment-row-column.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], "platforms": [ + "client", "server", "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], + "Session": [], + "JWT": [], "Key": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "rowId", + "description": "Row ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "column", + "description": "Column key.", "required": true, "type": "string", - "x-example": "", "in": "path" }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the column by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" + }, + "max": { + "type": "number", + "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } + } + ] + } + }, + "\/teams": { + "get": { + "summary": "List teams", + "operationId": "teamsList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "teams" + ], + "description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.", + "responses": { + "200": { + "description": "Teams List", + "schema": { + "$ref": "#\/definitions\/teamList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": "teams", + "weight": 520, + "cookies": false, + "type": "", + "demo": "teams\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "teams.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "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: userId, providerId, identifier, providerType", + "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: name, total, billingPlan", "required": false, "type": "array", "collectionFormat": "multi", @@ -47716,6 +48074,15 @@ "default": [], "in": "query" }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -47728,8 +48095,8 @@ ] }, "post": { - "summary": "Create user target", - "operationId": "usersCreateTarget", + "summary": "Create team", + "operationId": "teamsCreate", "consumes": [ "application\/json" ], @@ -47737,182 +48104,157 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Create a messaging target.", + "description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.", "responses": { "201": { - "description": "Target", + "description": "Team", "schema": { - "$ref": "#\/definitions\/target" + "$ref": "#\/definitions\/team" } } }, "deprecated": false, "x-appwrite": { - "method": "createTarget", - "group": "targets", - "weight": 75, + "method": "create", + "group": "teams", + "weight": 518, "cookies": false, "type": "", - "demo": "users\/create-target.md", + "demo": "teams\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.write", "platforms": [ - "server", - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ - { - "name": "userId", - "description": "User ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "targetId": { - "type": "string", - "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "providerType": { - "type": "string", - "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "default": null, - "x-example": "email", - "enum": [ - "email", - "sms", - "push" - ], - "x-enum-name": "MessagingProviderType", - "x-enum-keys": [] - }, - "identifier": { + "teamId": { "type": "string", - "description": "The target identifier (token, email, phone etc.)", + "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "" - }, - "providerId": { - "type": "string", - "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", - "default": "", - "x-example": "" + "x-example": "" }, "name": { "type": "string", - "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", - "default": "", + "description": "Team name. Max length: 128 chars.", + "default": null, "x-example": "" + }, + "roles": { + "type": "array", + "description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.", + "default": [ + "owner" + ], + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "targetId", - "providerType", - "identifier" + "teamId", + "name" ] } } ] } }, - "\/users\/{userId}\/targets\/{targetId}": { + "\/teams\/{teamId}": { "get": { - "summary": "Get user target", - "operationId": "usersGetTarget", + "summary": "Get team", + "operationId": "teamsGet", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Get a user's push notification target by ID.", + "description": "Get a team by its ID. All team members have read access for this resource.", "responses": { "200": { - "description": "Target", + "description": "Team", "schema": { - "$ref": "#\/definitions\/target" + "$ref": "#\/definitions\/team" } } }, "deprecated": false, "x-appwrite": { - "method": "getTarget", - "group": "targets", - "weight": 79, + "method": "get", + "group": "teams", + "weight": 519, "cookies": false, "type": "", - "demo": "users\/get-target.md", + "demo": "teams\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.read", + "scope": "teams.read", "platforms": [ - "server", - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "targetId", - "description": "Target ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "patch": { - "summary": "Update user target", - "operationId": "usersUpdateTarget", + "put": { + "summary": "Update name", + "operationId": "teamsUpdateName", "consumes": [ "application\/json" ], @@ -47920,62 +48262,57 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Update a messaging target.", + "description": "Update the team's name by its unique ID.", "responses": { "200": { - "description": "Target", + "description": "Team", "schema": { - "$ref": "#\/definitions\/target" + "$ref": "#\/definitions\/team" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTarget", - "group": "targets", - "weight": 95, + "method": "updateName", + "group": "teams", + "weight": 522, "cookies": false, "type": "", - "demo": "users\/update-target.md", + "demo": "teams\/update-name.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.write", "platforms": [ - "server", - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "targetId", - "description": "Target ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -47984,40 +48321,31 @@ "schema": { "type": "object", "properties": { - "identifier": { - "type": "string", - "description": "The target identifier (token, email, phone etc.)", - "default": "", - "x-example": "" - }, - "providerId": { - "type": "string", - "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", - "default": "", - "x-example": "" - }, "name": { "type": "string", - "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", - "default": "", + "description": "New team name. Max length: 128 chars.", + "default": null, "x-example": "" } - } + }, + "required": [ + "name" + ] } } ] }, "delete": { - "summary": "Delete user target", - "operationId": "usersDeleteTarget", + "summary": "Delete team", + "operationId": "teamsDelete", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "users" + "teams" ], - "description": "Delete a messaging target.", + "description": "Delete a team using its ID. Only team members with the owner role can delete the team.", "responses": { "204": { "description": "No content" @@ -48025,58 +48353,146 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTarget", - "group": "targets", - "weight": 107, + "method": "delete", + "group": "teams", + "weight": 521, "cookies": false, "type": "", - "demo": "users\/delete-target.md", + "demo": "teams\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "targets.write", + "scope": "teams.write", "platforms": [ - "server", - "console" + "console", + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, + } + ] + } + }, + "\/teams\/{teamId}\/memberships": { + "get": { + "summary": "List team memberships", + "operationId": "teamsListMemberships", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "teams" + ], + "description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.", + "responses": { + "200": { + "description": "Memberships List", + "schema": { + "$ref": "#\/definitions\/membershipList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listMemberships", + "group": "memberships", + "weight": 527, + "cookies": false, + "type": "", + "demo": "teams\/list-memberships.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "teams.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ { - "name": "targetId", - "description": "Target ID.", + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/users\/{userId}\/tokens": { + }, "post": { - "summary": "Create token", - "operationId": "usersCreateToken", + "summary": "Create team membership", + "operationId": "teamsCreateMembership", "consumes": [ "application\/json" ], @@ -48084,54 +48500,57 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n", + "description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n", "responses": { "201": { - "description": "Token", + "description": "Membership", "schema": { - "$ref": "#\/definitions\/token" + "$ref": "#\/definitions\/membership" } } }, "deprecated": false, "x-appwrite": { - "method": "createToken", - "group": "sessions", - "weight": 103, + "method": "createMembership", + "group": "memberships", + "weight": 525, "cookies": false, "type": "", - "demo": "users\/create-token.md", - "rate-limit": 0, + "demo": "teams\/create-membership.md", + "rate-limit": 10, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -48140,112 +48559,132 @@ "schema": { "type": "object", "properties": { - "length": { - "type": "integer", - "description": "Token length in characters. The default length is 6 characters", - "default": 6, - "x-example": 4, - "format": "int32" + "email": { + "type": "string", + "description": "Email of the new team member.", + "default": "", + "x-example": "email@example.com", + "format": "email" }, - "expire": { - "type": "integer", - "description": "Token expiration period in seconds. The default expiration is 15 minutes.", - "default": 900, - "x-example": 60, - "format": "int32" + "userId": { + "type": "string", + "description": "ID of the user to be added to a team.", + "default": "", + "x-example": "" + }, + "phone": { + "type": "string", + "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "default": "", + "x-example": "+12065550100", + "format": "phone" + }, + "roles": { + "type": "array", + "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "url": { + "type": "string", + "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", + "default": "", + "x-example": "https:\/\/example.com", + "format": "url" + }, + "name": { + "type": "string", + "description": "Name of the new team member. Max length: 128 chars.", + "default": "", + "x-example": "" } - } + }, + "required": [ + "roles" + ] } } ] } }, - "\/users\/{userId}\/verification": { - "patch": { - "summary": "Update email verification", - "operationId": "usersUpdateEmailVerification", - "consumes": [ - "application\/json" - ], + "\/teams\/{teamId}\/memberships\/{membershipId}": { + "get": { + "summary": "Get team membership", + "operationId": "teamsGetMembership", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Update the user email verification status by its unique ID.", + "description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.", "responses": { "200": { - "description": "User", + "description": "Membership", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/membership" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmailVerification", - "group": "users", - "weight": 93, + "method": "getMembership", + "group": "memberships", + "weight": 526, "cookies": false, "type": "", - "demo": "users\/update-email-verification.md", + "demo": "teams\/get-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "emailVerification": { - "type": "boolean", - "description": "User email verification status.", - "default": null, - "x-example": false - } - }, - "required": [ - "emailVerification" - ] - } + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - } - }, - "\/users\/{userId}\/verification\/phone": { + }, "patch": { - "summary": "Update phone verification", - "operationId": "usersUpdatePhoneVerification", + "summary": "Update team membership", + "operationId": "teamsUpdateMembership", "consumes": [ "application\/json" ], @@ -48253,54 +48692,65 @@ "application\/json" ], "tags": [ - "users" + "teams" ], - "description": "Update the user phone verification status by its unique ID.", + "description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n", "responses": { "200": { - "description": "User", + "description": "Membership", "schema": { - "$ref": "#\/definitions\/user" + "$ref": "#\/definitions\/membership" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePhoneVerification", - "group": "users", - "weight": 88, + "method": "updateMembership", + "group": "memberships", + "weight": 528, "cookies": false, "type": "", - "demo": "users\/update-phone-verification.md", + "demo": "teams\/update-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "users.write", + "scope": "teams.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "userId", - "description": "User ID.", + "name": "teamId", + "description": "Team ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" }, { @@ -48309,107 +48759,96 @@ "schema": { "type": "object", "properties": { - "phoneVerification": { - "type": "boolean", - "description": "User phone verification status.", + "roles": { + "type": "array", + "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", "default": null, - "x-example": false + "x-example": null, + "items": { + "type": "string" + } } }, "required": [ - "phoneVerification" + "roles" ] } } ] - } - }, - "\/vectorsdb": { - "get": { - "summary": "List databases", - "operationId": "vectorsDBList", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete team membership", + "operationId": "teamsDeleteMembership", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "vectorsDB" + "teams" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.", "responses": { - "200": { - "description": "Databases List", - "schema": { - "$ref": "#\/definitions\/databaseList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "vectorsdb", - "weight": 816, + "method": "deleteMembership", + "group": "memberships", + "weight": 1187, "cookies": false, "type": "", - "demo": "vectorsdb\/list.md", + "demo": "teams\/delete-membership.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "teams.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "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 columns: name", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "teamId", + "description": "Team ID.", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - }, - "post": { - "summary": "Create database", - "operationId": "vectorsDBCreate", + } + }, + "\/teams\/{teamId}\/memberships\/{membershipId}\/status": { + "patch": { + "summary": "Update team membership status", + "operationId": "teamsUpdateMembershipStatus", "consumes": [ "application\/json" ], @@ -48417,238 +48856,278 @@ "application\/json" ], "tags": [ - "vectorsDB" + "teams" ], - "description": "Create a new Database.\n", + "description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n", "responses": { - "201": { - "description": "Database", + "200": { + "description": "Membership", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/membership" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "vectorsdb", - "weight": 812, + "method": "updateMembershipStatus", + "group": "memberships", + "weight": 530, "cookies": false, "type": "", - "demo": "vectorsdb\/create.md", + "demo": "teams\/update-membership-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "public", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "JWT": [] } ], "parameters": [ + { + "name": "teamId", + "description": "Team ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "membershipId", + "description": "Membership ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "databaseId": { + "userId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "User ID.", "default": null, - "x-example": "" + "x-example": "" }, - "name": { + "secret": { "type": "string", - "description": "Database name. Max length: 128 chars.", + "description": "Secret key.", "default": null, - "x-example": "" - }, - "enabled": { - "type": "boolean", - "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "default": true, - "x-example": false + "x-example": "" } }, "required": [ - "databaseId", - "name" + "userId", + "secret" ] } } ] } }, - "\/vectorsdb\/embeddings\/text": { - "post": { - "summary": "Create Text Embeddings", - "operationId": "vectorsDBCreateTextEmbeddings", - "consumes": [ - "application\/json" - ], + "\/teams\/{teamId}\/prefs": { + "get": { + "summary": "Get team preferences", + "operationId": "teamsGetPrefs", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "teams" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).", "responses": { "200": { - "description": "Embedding list", + "description": "Preferences", "schema": { - "$ref": "#\/definitions\/embeddingList" + "$ref": "#\/definitions\/preferences" } } }, "deprecated": false, "x-appwrite": { - "method": "createTextEmbeddings", - "group": "documents", - "weight": 838, + "method": "getPrefs", + "group": "teams", + "weight": 523, "cookies": false, "type": "", - "demo": "vectorsdb\/create-text-embeddings.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "teams\/get-prefs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "teams.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", - "methods": [ - { - "name": "createTextEmbeddings", - "namespace": "vectorsDB", - "desc": "Create Text Embedding", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "texts", - "model" - ], - "required": [ - "texts" - ], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/embeddingList" - } - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-text-embeddings.md", - "public": true + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "teamId", + "description": "Team ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update team preferences", + "operationId": "teamsUpdatePrefs", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "teams" + ], + "description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.", + "responses": { + "200": { + "description": "Preferences", + "schema": { + "$ref": "#\/definitions\/preferences" } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePrefs", + "group": "teams", + "weight": 524, + "cookies": false, + "type": "", + "demo": "teams\/update-prefs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "teams.write", + "platforms": [ + "console", + "client", + "server" ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [], + "Session": [], "JWT": [] } ], "parameters": [ + { + "name": "teamId", + "description": "Team ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "texts": { - "type": "array", - "description": "Array of text to generate embeddings.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "model": { - "type": "string", - "description": "The embedding model to use for generating vector embeddings.", - "default": "embeddinggemma", - "x-example": "embeddinggemma", - "enum": [ - "embeddinggemma" - ], - "x-enum-name": null, - "x-enum-keys": [] + "prefs": { + "type": "object", + "description": "Prefs key-value JSON object.", + "default": {}, + "x-example": "{}" } }, "required": [ - "texts" + "prefs" ] } } ] } }, - "\/vectorsdb\/transactions": { + "\/tokens\/buckets\/{bucketId}\/files\/{fileId}": { "get": { - "summary": "List transactions", - "operationId": "vectorsDBListTransactions", + "summary": "List tokens", + "operationId": "tokensList", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "tokens" ], - "description": "List transactions across all databases.", + "description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.", "responses": { "200": { - "description": "Transaction List", + "description": "Resource Tokens List", "schema": { - "$ref": "#\/definitions\/transactionList" + "$ref": "#\/definitions\/resourceTokenList" } } }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 843, + "method": "list", + "group": "files", + "weight": 534, "cookies": false, "type": "", - "demo": "vectorsdb\/list-transactions.md", + "demo": "tokens\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "tokens.read", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-transactions.md", "auth": { "Project": [], "Key": [] @@ -48657,15 +49136,29 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", + "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: expire", "required": false, "type": "array", "collectionFormat": "multi", @@ -48674,12 +49167,21 @@ }, "default": [], "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, "post": { - "summary": "Create transaction", - "operationId": "vectorsDBCreateTransaction", + "summary": "Create file token", + "operationId": "tokensCreateFileToken", "consumes": [ "application\/json" ], @@ -48687,37 +49189,35 @@ "application\/json" ], "tags": [ - "vectorsDB" + "tokens" ], - "description": "Create a new transaction.", + "description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.", "responses": { "201": { - "description": "Transaction", + "description": "ResourceToken", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/resourceToken" } } }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 839, + "method": "createFileToken", + "group": "files", + "weight": 532, "cookies": false, "type": "", - "demo": "vectorsdb\/create-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "demo": "tokens\/create-file-token.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-transaction.md", "auth": { "Project": [], "Key": [] @@ -48726,24 +49226,39 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "default": 300, - "x-example": 60, - "format": "int32" + "expire": { + "type": "string", + "description": "Token expiry date", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } } } @@ -48751,46 +49266,44 @@ ] } }, - "\/vectorsdb\/transactions\/{transactionId}": { + "\/tokens\/{tokenId}": { "get": { - "summary": "Get transaction", - "operationId": "vectorsDBGetTransaction", + "summary": "Get token", + "operationId": "tokensGet", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "tokens" ], - "description": "Get a transaction by its unique ID.", + "description": "Get a token by its unique ID.", "responses": { "200": { - "description": "Transaction", + "description": "ResourceToken", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/resourceToken" } } }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 840, + "method": "get", + "group": "tokens", + "weight": 533, "cookies": false, "type": "", - "demo": "vectorsdb\/get-transaction.md", + "demo": "tokens\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "tokens.read", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-transaction.md", "auth": { "Project": [], "Key": [] @@ -48799,25 +49312,23 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "tokenId", + "description": "Token ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, "patch": { - "summary": "Update transaction", - "operationId": "vectorsDBUpdateTransaction", + "summary": "Update token", + "operationId": "tokensUpdate", "consumes": [ "application\/json" ], @@ -48825,37 +49336,35 @@ "application\/json" ], "tags": [ - "vectorsDB" + "tokens" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.", "responses": { "200": { - "description": "Transaction", + "description": "ResourceToken", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/resourceToken" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 841, + "method": "update", + "group": "tokens", + "weight": 535, "cookies": false, "type": "", - "demo": "vectorsdb\/update-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "demo": "tokens\/update.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-transaction.md", "auth": { "Project": [], "Key": [] @@ -48864,18 +49373,16 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "tokenId", + "description": "Token unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -48884,17 +49391,13 @@ "schema": { "type": "object", "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false + "expire": { + "type": "string", + "description": "File token expiry date", + "default": null, + "x-example": "2020-10-15T06:38:00.000+00:00", + "format": "datetime", + "x-nullable": true } } } @@ -48902,16 +49405,16 @@ ] }, "delete": { - "summary": "Delete transaction", - "operationId": "vectorsDBDeleteTransaction", + "summary": "Delete token", + "operationId": "tokensDelete", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "vectorsDB" + "tokens" ], - "description": "Delete a transaction by its unique ID.", + "description": "Delete a token by its unique ID.", "responses": { "204": { "description": "No content" @@ -48919,24 +49422,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 842, + "method": "delete", + "group": "tokens", + "weight": 536, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "demo": "tokens\/delete.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "tokens.write", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-transaction.md", "auth": { "Project": [], "Key": [] @@ -48945,65 +49446,60 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "tokenId", + "description": "Token ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/vectorsdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "vectorsDBCreateOperations", - "consumes": [ - "application\/json" - ], + "\/users": { + "get": { + "summary": "List users", + "operationId": "usersList", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create multiple operations in a single transaction.", + "description": "Get a list of all the project's users. You can use the query params to filter your results.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "Users List", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/userList" } } }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 844, + "method": "list", + "group": "users", + "weight": 71, "cookies": false, "type": "", - "demo": "vectorsdb\/create-operations.md", + "demo": "users\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.write", + "scope": "users.read", "platforms": [ "console", - "server", - "client" + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md", "auth": { "Project": [], "Key": [] @@ -49012,80 +49508,82 @@ "security": [ { "Project": [], - "Key": [], - "Session": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } - } - } - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/vectorsdb\/{databaseId}": { - "get": { - "summary": "Get database", - "operationId": "vectorsDBGet", - "consumes": [], + }, + "post": { + "summary": "Create user", + "operationId": "usersCreate", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "description": "Create a new user.", "responses": { - "200": { - "description": "Database", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "vectorsdb", - "weight": 813, + "method": "create", + "group": "users", + "weight": 62, "cookies": false, "type": "", - "demo": "vectorsdb\/get.md", + "demo": "users\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md", "auth": { "Project": [], "Key": [] @@ -49099,18 +49597,58 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "put": { - "summary": "Update database", - "operationId": "vectorsDBUpdate", + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email", + "x-nullable": true + }, + "phone": { + "type": "string", + "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", + "default": null, + "x-example": "+12065550100", + "format": "phone", + "x-nullable": true + }, + "password": { + "type": "string", + "description": "Plain text user password. Must be at least 8 chars.", + "default": "", + "x-example": null + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId" + ] + } + } + ] + } + }, + "\/users\/argon2": { + "post": { + "summary": "Create user with Argon2 password", + "operationId": "usersCreateArgon2User", "consumes": [ "application\/json" ], @@ -49118,36 +49656,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Update a database by its unique ID.", + "description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "Database", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": "vectorsdb", - "weight": 814, + "method": "createArgon2User", + "group": "users", + "weight": 65, "cookies": false, "type": "", - "demo": "vectorsdb\/update.md", + "demo": "users\/create-argon-2-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md", "auth": { "Project": [], "Key": [] @@ -49160,75 +49698,90 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "userId": { "type": "string", - "description": "Database name. Max length: 128 chars.", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "enabled": { - "type": "boolean", - "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", - "default": true, - "x-example": false + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Argon2.", + "default": null, + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" } }, "required": [ - "name" + "userId", + "email", + "password" ] } } ] - }, - "delete": { - "summary": "Delete database", - "operationId": "vectorsDBDelete", + } + }, + "\/users\/bcrypt": { + "post": { + "summary": "Create user with bcrypt password", + "operationId": "usersCreateBcryptUser", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "vectorsdb", - "weight": 815, + "method": "createBcryptUser", + "group": "users", + "weight": 63, "cookies": false, "type": "", - "demo": "vectorsdb\/delete.md", + "demo": "users\/create-bcrypt-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md", "auth": { "Project": [], "Key": [] @@ -49242,55 +49795,87 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Bcrypt.", + "default": null, + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } } ] } }, - "\/vectorsdb\/{databaseId}\/collections": { + "\/users\/identities": { "get": { - "summary": "List collections", - "operationId": "vectorsDBListCollections", + "summary": "List identities", + "operationId": "usersListIdentities", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "description": "Get identities for all users.", "responses": { "200": { - "description": "VectorsDB Collections List", + "description": "Identities List", "schema": { - "$ref": "#\/definitions\/vectorsdbCollectionList" + "$ref": "#\/definitions\/identityList" } } }, "deprecated": false, "x-appwrite": { - "method": "listCollections", - "group": "collections", - "weight": 823, + "method": "listIdentities", + "group": "identities", + "weight": 79, "cookies": false, "type": "", - "demo": "vectorsdb\/list-collections.md", + "demo": "users\/list-identities.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-collections.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md", "auth": { "Project": [], "Key": [] @@ -49303,17 +49888,9 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", + "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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry", "required": false, "type": "array", "collectionFormat": "multi", @@ -49342,10 +49919,71 @@ "in": "query" } ] - }, + } + }, + "\/users\/identities\/{identityId}": { + "delete": { + "summary": "Delete identity", + "operationId": "usersDeleteIdentity", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "users" + ], + "description": "Delete an identity by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIdentity", + "group": "identities", + "weight": 103, + "cookies": false, + "type": "", + "demo": "users\/delete-identity.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "identityId", + "description": "Identity ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/users\/md5": { "post": { - "summary": "Create collection", - "operationId": "vectorsDBCreateCollection", + "summary": "Create user with MD5 password", + "operationId": "usersCreateMD5User", "consumes": [ "application\/json" ], @@ -49353,36 +49991,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { "201": { - "description": "VectorsDB Collection", + "description": "User", "schema": { - "$ref": "#\/definitions\/vectorsdbCollection" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "createCollection", - "group": "collections", - "weight": 819, + "method": "createMD5User", + "group": "users", + "weight": 64, "cookies": false, "type": "", - "demo": "vectorsdb\/create-collection.md", + "demo": "users\/create-md-5-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md", "auth": { "Project": [], "Key": [] @@ -49395,110 +50033,90 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "collectionId": { + "userId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "name": { + "email": { "type": "string", - "description": "Collection name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "dimension": { - "type": "integer", - "description": "Embedding dimension.", + "description": "User email.", "default": null, - "x-example": 1, - "format": "int32" + "x-example": "email@example.com", + "format": "email" }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "password": { + "type": "string", + "description": "User password hashed using MD5.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documentSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false + "x-example": "password", + "format": "password" }, - "enabled": { - "type": "boolean", - "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", - "default": true, - "x-example": false + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" } }, "required": [ - "collectionId", - "name", - "dimension" + "userId", + "email", + "password" ] } } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}": { - "get": { - "summary": "Get collection", - "operationId": "vectorsDBGetCollection", - "consumes": [], + "\/users\/phpass": { + "post": { + "summary": "Create user with PHPass password", + "operationId": "usersCreatePHPassUser", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "VectorsDB Collection", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/vectorsdbCollection" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "getCollection", - "group": "collections", - "weight": 820, + "method": "createPHPassUser", + "group": "users", + "weight": 67, "cookies": false, "type": "", - "demo": "vectorsdb\/get-collection.md", + "demo": "users\/create-ph-pass-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md", "auth": { "Project": [], "Key": [] @@ -49512,26 +50130,52 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using PHPass.", + "default": null, + "x-example": "password", + "format": "password" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } } ] - }, - "put": { - "summary": "Update collection", - "operationId": "vectorsDBUpdateCollection", + } + }, + "\/users\/scrypt": { + "post": { + "summary": "Create user with Scrypt password", + "operationId": "usersCreateScryptUser", "consumes": [ "application\/json" ], @@ -49539,36 +50183,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Update a collection by its unique ID.", + "description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "200": { - "description": "VectorsDB Collection", + "201": { + "description": "User", "schema": { - "$ref": "#\/definitions\/vectorsdbCollection" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "updateCollection", - "group": "collections", - "weight": 821, + "method": "createScryptUser", + "group": "users", + "weight": 68, "cookies": false, "type": "", - "demo": "vectorsdb\/update-collection.md", + "demo": "users\/create-scrypt-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md", "auth": { "Project": [], "Key": [] @@ -49581,105 +50225,129 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { + "userId": { "type": "string", - "description": "Collection name. Max length: 128 chars.", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": null, - "x-example": "" + "x-example": "" }, - "dimension": { + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Scrypt.", + "default": null, + "x-example": "password", + "format": "password" + }, + "passwordSalt": { + "type": "string", + "description": "Optional salt used to hash password.", + "default": null, + "x-example": "" + }, + "passwordCpu": { "type": "integer", - "description": "Embedding dimensions.", + "description": "Optional CPU cost used to hash password.", "default": null, - "x-example": 1, + "x-example": null, "format": "int32" }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "passwordMemory": { + "type": "integer", + "description": "Optional memory cost used to hash password.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } + "x-example": null, + "format": "int32" }, - "documentSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false + "passwordParallel": { + "type": "integer", + "description": "Optional parallelization cost used to hash password.", + "default": null, + "x-example": null, + "format": "int32" }, - "enabled": { - "type": "boolean", - "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", - "default": true, - "x-example": false + "passwordLength": { + "type": "integer", + "description": "Optional hash length used to hash password.", + "default": null, + "x-example": null, + "format": "int32" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" } }, "required": [ - "name" + "userId", + "email", + "password", + "passwordSalt", + "passwordCpu", + "passwordMemory", + "passwordParallel", + "passwordLength" ] } } ] - }, - "delete": { - "summary": "Delete collection", - "operationId": "vectorsDBDeleteCollection", + } + }, + "\/users\/scrypt-modified": { + "post": { + "summary": "Create user with Scrypt modified password", + "operationId": "usersCreateScryptModifiedUser", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteCollection", - "group": "collections", - "weight": 822, + "method": "createScryptModifiedUser", + "group": "users", + "weight": 69, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-collection.md", + "demo": "users\/create-scrypt-modified-user.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-collection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md", "auth": { "Project": [], "Key": [] @@ -49693,317 +50361,392 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using Scrypt Modified.", + "default": null, + "x-example": "password", + "format": "password" + }, + "passwordSalt": { + "type": "string", + "description": "Salt used to hash password.", + "default": null, + "x-example": "" + }, + "passwordSaltSeparator": { + "type": "string", + "description": "Salt separator used to hash password.", + "default": null, + "x-example": "" + }, + "passwordSignerKey": { + "type": "string", + "description": "Signer key used to hash password.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password", + "passwordSalt", + "passwordSaltSeparator", + "passwordSignerKey" + ] + } + } + ] + } + }, + "\/users\/sha": { + "post": { + "summary": "Create user with SHA password", + "operationId": "usersCreateSHAUser", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.", + "responses": { + "201": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSHAUser", + "group": "users", + "weight": 66, + "cookies": false, + "type": "", + "demo": "users\/create-sha-user.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "email": { + "type": "string", + "description": "User email.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "password": { + "type": "string", + "description": "User password hashed using SHA.", + "default": null, + "x-example": "password", + "format": "password" + }, + "passwordVersion": { + "type": "string", + "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", + "default": "", + "x-example": "sha1", + "enum": [ + "sha1", + "sha224", + "sha256", + "sha384", + "sha512\/224", + "sha512\/256", + "sha512", + "sha3-224", + "sha3-256", + "sha3-384", + "sha3-512" + ], + "x-enum-name": "PasswordHash", + "x-enum-keys": [] + }, + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "userId", + "email", + "password" + ] + } } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "\/users\/{userId}": { "get": { - "summary": "List documents", - "operationId": "vectorsDBListDocuments", + "summary": "Get user", + "operationId": "usersGet", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Get a user by its unique ID.", "responses": { "200": { - "description": "Documents List", + "description": "User", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "listDocuments", - "group": "documents", - "weight": 833, + "method": "get", + "group": "users", + "weight": 72, "cookies": false, "type": "", - "demo": "vectorsdb\/list-documents.md", + "demo": "users\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "type": "string", - "x-example": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" } ] }, - "post": { - "summary": "Create document", - "operationId": "vectorsDBCreateDocument", + "delete": { + "summary": "Delete user", + "operationId": "usersDelete", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "vectorsDB" + "users" ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.", "responses": { - "201": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createDocument", - "group": "documents", - "weight": 829, + "method": "delete", + "group": "users", + "weight": 101, "cookies": false, "type": "", - "demo": "vectorsdb\/create-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", - "methods": [ - { - "name": "createDocument", - "namespace": "vectorsDB", - "desc": "Create document", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions" - ], - "required": [ - "databaseId", - "collectionId", - "documentId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/document" - } - ], - "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-document.md", - "public": true - }, - { - "name": "createDocuments", - "namespace": "vectorsDB", - "desc": "Create documents", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/documentList" - } - ], - "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/create-documents.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, + } + ] + } + }, + "\/users\/{userId}\/email": { + "patch": { + "summary": "Update email", + "operationId": "usersUpdateEmail", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Update the user email by its unique ID.", + "responses": { + "200": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateEmail", + "group": "users", + "weight": 86, + "cookies": false, + "type": "", + "demo": "users\/update-email.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": "", - "x-example": "" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "default": [], - "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { + "email": { "type": "string", - "description": "Transaction ID for staging the operation.", + "description": "User email.", "default": null, - "x-example": "" + "x-example": "email@example.com", + "format": "email" } - } + }, + "required": [ + "email" + ] } } ] - }, - "put": { - "summary": "Upsert documents", - "operationId": "vectorsDBUpsertDocuments", + } + }, + "\/users\/{userId}\/impersonator": { + "patch": { + "summary": "Update user impersonator capability", + "operationId": "usersUpdateImpersonator", "consumes": [ "application\/json" ], @@ -50011,67 +50754,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "description": "Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.\n", "responses": { - "201": { - "description": "Documents List", + "200": { + "description": "User", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "upsertDocuments", - "group": "documents", - "weight": 836, + "method": "updateImpersonator", + "group": "users", + "weight": 82, "cookies": false, "type": "", - "demo": "vectorsdb\/upsert-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-impersonator.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-documents.md", - "methods": [ - { - "name": "upsertDocuments", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/documentList" - } - ], - "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", - "demo": "vectorsdb\/upsert-documents.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-impersonator.md", "auth": { "Project": [], "Key": [] @@ -50085,19 +50797,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -50106,32 +50810,25 @@ "schema": { "type": "object", "properties": { - "documents": { - "type": "array", - "description": "Array of document data as JSON objects. May contain partial documents.", - "default": null, - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", + "impersonator": { + "type": "boolean", + "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", "default": null, - "x-example": "" + "x-example": false } }, "required": [ - "documents" + "impersonator" ] } } ] - }, - "patch": { - "summary": "Update documents", - "operationId": "vectorsDBUpdateDocuments", + } + }, + "\/users\/{userId}\/jwts": { + "post": { + "summary": "Create user JWT", + "operationId": "usersCreateJWT", "consumes": [ "application\/json" ], @@ -50139,36 +50836,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.", "responses": { - "200": { - "description": "Documents List", + "201": { + "description": "JWT", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/jwt" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDocuments", - "group": "documents", - "weight": 835, + "method": "createJWT", + "group": "sessions", + "weight": 104, "cookies": false, "type": "", - "demo": "vectorsdb\/update-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/create-jwt.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md", "auth": { "Project": [], "Key": [] @@ -50182,19 +50879,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -50203,35 +50892,29 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": [], - "x-example": "{}" - }, - "queries": { - "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { + "sessionId": { "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "" + "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", + "default": "", + "x-example": "" + }, + "duration": { + "type": "integer", + "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", + "default": 900, + "x-example": 0, + "format": "int32" } } } } ] - }, - "delete": { - "summary": "Delete documents", - "operationId": "vectorsDBDeleteDocuments", + } + }, + "\/users\/{userId}\/labels": { + "put": { + "summary": "Update user labels", + "operationId": "usersUpdateLabels", "consumes": [ "application\/json" ], @@ -50239,36 +50922,36 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.", "responses": { "200": { - "description": "Documents List", + "description": "User", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDocuments", - "group": "documents", - "weight": 837, + "method": "updateLabels", + "group": "users", + "weight": 81, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-documents.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-labels.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md", "auth": { "Project": [], "Key": [] @@ -50282,19 +50965,11 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -50303,108 +50978,86 @@ "schema": { "type": "object", "properties": { - "queries": { + "labels": { "type": "array", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", - "default": [], + "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", + "default": null, "x-example": null, "items": { "type": "string" } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "" } - } + }, + "required": [ + "labels" + ] } } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "\/users\/{userId}\/logs": { "get": { - "summary": "Get document", - "operationId": "vectorsDBGetDocument", + "summary": "List user logs", + "operationId": "usersListLogs", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Get the user activity logs list by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Logs List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/logList" } } }, "deprecated": false, "x-appwrite": { - "method": "getDocument", - "group": "documents", - "weight": 832, + "method": "listLogs", + "group": "logs", + "weight": 77, "cookies": false, "type": "", - "demo": "vectorsdb\/get-document.md", + "demo": "users\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "users.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset", "required": false, "type": "array", "collectionFormat": "multi", @@ -50415,162 +51068,113 @@ "in": "query" }, { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, - "type": "string", - "x-example": "", + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] - }, - "put": { - "summary": "Upsert a document", - "operationId": "vectorsDBUpsertDocument", - "consumes": [ - "application\/json" - ], + } + }, + "\/users\/{userId}\/memberships": { + "get": { + "summary": "List user memberships", + "operationId": "usersListMemberships", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "description": "Get the user membership list by its unique ID.", "responses": { - "201": { - "description": "Document", + "200": { + "description": "Memberships List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/membershipList" } } }, "deprecated": false, "x-appwrite": { - "method": "upsertDocument", - "group": "documents", - "weight": 831, + "method": "listMemberships", + "group": "memberships", + "weight": 76, "cookies": false, "type": "", - "demo": "vectorsdb\/upsert-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/list-memberships.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-document.md", - "methods": [ - { - "name": "upsertDocument", - "namespace": "vectorsDB", - "desc": "", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/document" - } - ], - "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", - "demo": "vectorsdb\/upsert-document.md", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "documentId", - "description": "Document ID.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": [], - "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "" - } - } - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - }, + } + }, + "\/users\/{userId}\/mfa": { "patch": { - "summary": "Update document", - "operationId": "vectorsDBUpdateDocument", + "summary": "Update MFA", + "operationId": "usersUpdateMfa", "consumes": [ "application\/json" ], @@ -50578,73 +51182,116 @@ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Enable or disable MFA on a user account.", "responses": { "200": { - "description": "Document", + "description": "User", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/user" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateDocument", - "group": "documents", - "weight": 830, + "method": "updateMfa", + "group": "users", + "weight": 91, "cookies": false, "type": "", - "demo": "vectorsdb\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/update-mfa.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-document.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFA" + }, + "methods": [ + { + "name": "updateMfa", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId", + "mfa" + ], + "required": [ + "userId", + "mfa" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/user" + } + ], + "description": "Enable or disable MFA on a user account.", + "demo": "users\/update-mfa.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFA" + } + }, + { + "name": "updateMFA", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId", + "mfa" + ], + "required": [ + "userId", + "mfa" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/user" + } + ], + "description": "Enable or disable MFA on a user account.", + "demo": "users\/update-mfa.md", + "public": true + } + ], "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -50653,163 +51300,250 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "default": [], - "x-example": "{}" - }, - "permissions": { - "type": "array", - "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", + "mfa": { + "type": "boolean", + "description": "Enable or disable MFA.", "default": null, - "x-example": "" + "x-example": false } - } + }, + "required": [ + "mfa" + ] } } ] - }, + } + }, + "\/users\/{userId}\/mfa\/authenticators\/{type}": { "delete": { - "summary": "Delete document", - "operationId": "vectorsDBDeleteDocument", + "summary": "Delete authenticator", + "operationId": "usersDeleteMfaAuthenticator", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete a document by its unique ID.", + "description": "Delete an authenticator app.", "responses": { "204": { "description": "No content" } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", - "weight": 834, + "method": "deleteMfaAuthenticator", + "group": "mfa", + "weight": 96, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "users\/delete-mfa-authenticator.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", "platforms": [ "console", - "client", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-document.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.deleteMFAAuthenticator" + }, + "methods": [ + { + "name": "deleteMfaAuthenticator", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId", + "type" + ], + "required": [ + "userId", + "type" + ], + "responses": [ + { + "code": 204 + } + ], + "description": "Delete an authenticator app.", + "demo": "users\/delete-mfa-authenticator.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.deleteMFAAuthenticator" + } + }, + { + "name": "deleteMFAAuthenticator", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId", + "type" + ], + "required": [ + "userId", + "type" + ], + "responses": [ + { + "code": 204 + } + ], + "description": "Delete an authenticator app.", + "demo": "users\/delete-mfa-authenticator.md", + "public": true + } + ], "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "type", + "description": "Type of authenticator.", "required": true, "type": "string", - "x-example": "", + "x-example": "totp", + "enum": [ + "totp" + ], + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [], "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "" - } - } - } } ] } }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "\/users\/{userId}\/mfa\/factors": { "get": { - "summary": "List indexes", - "operationId": "vectorsDBListIndexes", + "summary": "List factors", + "operationId": "usersListMfaFactors", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "List indexes in the collection.", + "description": "List the factors available on the account to be used as a MFA challange.", "responses": { "200": { - "description": "Indexes List", + "description": "MFAFactors", "schema": { - "$ref": "#\/definitions\/indexList" + "$ref": "#\/definitions\/mfaFactors" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 828, + "method": "listMfaFactors", + "group": "mfa", + "weight": 92, "cookies": false, "type": "", - "demo": "vectorsdb\/list-indexes.md", + "demo": "users\/list-mfa-factors.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-indexes.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.listMFAFactors" + }, + "methods": [ + { + "name": "listMfaFactors", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaFactors" + } + ], + "description": "List the factors available on the account to be used as a MFA challange.", + "demo": "users\/list-mfa-factors.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.listMFAFactors" + } + }, + { + "name": "listMFAFactors", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaFactors" + } + ], + "description": "List the factors available on the account to be used as a MFA challange.", + "demo": "users\/list-mfa-factors.md", + "public": true + } + ], "auth": { "Project": [], "Key": [] @@ -50823,84 +51557,113 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", - "required": false, - "type": "array", - "collectionFormat": "multi", - "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, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" } ] - }, - "post": { - "summary": "Create index", - "operationId": "vectorsDBCreateIndex", - "consumes": [ - "application\/json" - ], + } + }, + "\/users\/{userId}\/mfa\/recovery-codes": { + "get": { + "summary": "Get MFA recovery codes", + "operationId": "usersGetMfaRecoveryCodes", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", "responses": { - "202": { - "description": "Index", + "200": { + "description": "MFA Recovery Codes", "schema": { - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/mfaRecoveryCodes" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 825, - "cookies": false, - "type": "", - "demo": "vectorsdb\/create-index.md", + "method": "getMfaRecoveryCodes", + "group": "mfa", + "weight": 93, + "cookies": false, + "type": "", + "demo": "users\/get-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-index.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.getMFARecoveryCodes" + }, + "methods": [ + { + "name": "getMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/get-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.getMFARecoveryCodes" + } + }, + { + "name": "getMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/get-mfa-recovery-codes.md", + "public": true + } + ], "auth": { "Project": [], "Key": [] @@ -50914,132 +51677,113 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Index Key.", - "default": null, - "x-example": null - }, - "type": { - "type": "string", - "description": "Index type.", - "default": null, - "x-example": "hnsw_euclidean", - "enum": [ - "hnsw_euclidean", - "hnsw_dot", - "hnsw_cosine", - "object", - "key", - "unique" - ], - "x-enum-name": "VectorsDBIndexType", - "x-enum-keys": [] - }, - "attributes": { - "type": "array", - "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "default": [], - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } - }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "default": [], - "x-example": null, - "items": { - "type": "integer" - } - } - }, - "required": [ - "key", - "type", - "attributes" - ] - } } ] - } - }, - "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { - "get": { - "summary": "Get index", - "operationId": "vectorsDBGetIndex", - "consumes": [], + }, + "put": { + "summary": "Update MFA recovery codes (regenerate)", + "operationId": "usersUpdateMfaRecoveryCodes", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "vectorsDB" + "users" ], - "description": "Get index by ID.", + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", "responses": { "200": { - "description": "Index", + "description": "MFA Recovery Codes", "schema": { - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/mfaRecoveryCodes" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 826, + "method": "updateMfaRecoveryCodes", + "group": "mfa", + "weight": 95, "cookies": false, "type": "", - "demo": "vectorsdb\/get-index.md", + "demo": "users\/update-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-index.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFARecoveryCodes" + }, + "methods": [ + { + "name": "updateMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/update-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.updateMFARecoveryCodes" + } + }, + { + "name": "updateMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.", + "demo": "users\/update-mfa-recovery-codes.md", + "public": false + } + ], "auth": { "Project": [], "Key": [] @@ -51053,65 +51797,113 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", + "x-example": "", "in": "path" } ] }, - "delete": { - "summary": "Delete index", - "operationId": "vectorsDBDeleteIndex", + "patch": { + "summary": "Create MFA recovery codes", + "operationId": "usersCreateMfaRecoveryCodes", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ - "vectorsDB" + "users" ], - "description": "Delete an index.", + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "MFA Recovery Codes", + "schema": { + "$ref": "#\/definitions\/mfaRecoveryCodes" + } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 827, + "method": "createMfaRecoveryCodes", + "group": "mfa", + "weight": 94, "cookies": false, "type": "", - "demo": "vectorsdb\/delete-index.md", + "demo": "users\/create-mfa-recovery-codes.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-index.md", + "public": false, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.createMFARecoveryCodes" + }, + "methods": [ + { + "name": "createMfaRecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "demo": "users\/create-mfa-recovery-codes.md", + "public": false, + "deprecated": { + "since": "1.8.0", + "replaceWith": "users.createMFARecoveryCodes" + } + }, + { + "name": "createMFARecoveryCodes", + "namespace": "users", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "userId" + ], + "required": [ + "userId" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/mfaRecoveryCodes" + } + ], + "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.", + "demo": "users\/create-mfa-recovery-codes.md", + "public": true + } + ], "auth": { "Project": [], "Key": [] @@ -51125,69 +51917,57 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", + "x-example": "", "in": "path" } ] } }, - "\/webhooks": { - "get": { - "summary": "List webhooks", - "operationId": "webhooksList", - "consumes": [], + "\/users\/{userId}\/name": { + "patch": { + "summary": "Update name", + "operationId": "usersUpdateName", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "webhooks" + "users" ], - "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "description": "Update the user name by its unique ID.", "responses": { "200": { - "description": "Webhooks List", + "description": "User", "schema": { - "$ref": "#\/definitions\/webhookList" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": null, - "weight": 586, + "method": "updateName", + "group": "users", + "weight": 84, "cookies": false, "type": "", - "demo": "webhooks\/list.md", + "demo": "users\/update-name.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.read", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md", "auth": { "Project": [], "Key": [] @@ -51201,31 +51981,38 @@ ], "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: name, url, authUsername, tls, events, enabled, logs, attempts", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "User name. Max length: 128 chars.", + "default": null, + "x-example": "" + } + }, + "required": [ + "name" + ] + } } ] - }, - "post": { - "summary": "Create webhook", - "operationId": "webhooksCreate", + } + }, + "\/users\/{userId}\/password": { + "patch": { + "summary": "Update password", + "operationId": "usersUpdatePassword", "consumes": [ "application\/json" ], @@ -51233,35 +52020,36 @@ "application\/json" ], "tags": [ - "webhooks" + "users" ], - "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "description": "Update the user password by its unique ID.", "responses": { - "201": { - "description": "Webhook", + "200": { + "description": "User", "schema": { - "$ref": "#\/definitions\/webhook" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": null, - "weight": 585, + "method": "updatePassword", + "group": "users", + "weight": 85, "cookies": false, "type": "", - "demo": "webhooks\/create.md", + "demo": "users\/update-password.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md", "auth": { "Project": [], "Key": [] @@ -51274,120 +52062,157 @@ } ], "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "webhookId": { - "type": "string", - "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "default": null, - "x-example": "" - }, - "url": { + "password": { "type": "string", - "description": "Webhook URL.", + "description": "New user password. Must be at least 8 chars.", "default": null, "x-example": null - }, - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "default": true, - "x-example": false - }, - "tls": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "default": false, - "x-example": false - }, - "authUsername": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "authPassword": { - "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "secret": { + } + }, + "required": [ + "password" + ] + } + } + ] + } + }, + "\/users\/{userId}\/phone": { + "patch": { + "summary": "Update phone", + "operationId": "usersUpdatePhone", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Update the user phone by its unique ID.", + "responses": { + "200": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePhone", + "group": "users", + "weight": 87, + "cookies": false, + "type": "", + "demo": "users\/update-phone.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "number": { "type": "string", - "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "description": "User phone number.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "+12065550100", + "format": "phone" } }, "required": [ - "webhookId", - "url", - "name", - "events" + "number" ] } } ] } }, - "\/webhooks\/{webhookId}": { + "\/users\/{userId}\/prefs": { "get": { - "summary": "Get webhook", - "operationId": "webhooksGet", + "summary": "Get user preferences", + "operationId": "usersGetPrefs", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "webhooks" + "users" ], - "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "description": "Get the user preferences by its unique ID.", "responses": { "200": { - "description": "Webhook", + "description": "Preferences", "schema": { - "$ref": "#\/definitions\/webhook" + "$ref": "#\/definitions\/preferences" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": null, - "weight": 587, + "method": "getPrefs", + "group": "users", + "weight": 73, "cookies": false, "type": "", - "demo": "webhooks\/get.md", + "demo": "users\/get-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.read", + "scope": "users.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md", "auth": { "Project": [], "Key": [] @@ -51401,18 +52226,18 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "put": { - "summary": "Update webhook", - "operationId": "webhooksUpdate", + "patch": { + "summary": "Update user preferences", + "operationId": "usersUpdatePrefs", "consumes": [ "application\/json" ], @@ -51420,35 +52245,36 @@ "application\/json" ], "tags": [ - "webhooks" + "users" ], - "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.", "responses": { "200": { - "description": "Webhook", + "description": "Preferences", "schema": { - "$ref": "#\/definitions\/webhook" + "$ref": "#\/definitions\/preferences" } } }, "deprecated": false, "x-appwrite": { - "method": "update", - "group": null, - "weight": 589, + "method": "updatePrefs", + "group": "users", + "weight": 89, "cookies": false, "type": "", - "demo": "webhooks\/update.md", + "demo": "users\/update-prefs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md", "auth": { "Project": [], "Key": [] @@ -51462,11 +52288,11 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -51475,72 +52301,170 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Webhook name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "url": { - "type": "string", - "description": "Webhook URL.", - "default": null, - "x-example": null - }, - "events": { - "type": "array", - "description": "Events list. Maximum of 100 events are allowed.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "enabled": { - "type": "boolean", - "description": "Enable or disable a webhook.", - "default": true, - "x-example": false - }, - "tls": { - "type": "boolean", - "description": "Certificate verification, false for disabled or true for enabled.", - "default": false, - "x-example": false - }, - "authUsername": { - "type": "string", - "description": "Webhook HTTP user. Max length: 256 chars.", - "default": "", - "x-example": "" - }, - "authPassword": { - "type": "string", - "description": "Webhook HTTP password. Max length: 256 chars.", - "default": "", - "x-example": "" + "prefs": { + "type": "object", + "description": "Prefs key-value JSON object.", + "default": {}, + "x-example": "{}" } }, "required": [ - "name", - "url", - "events" + "prefs" ] } } ] + } + }, + "\/users\/{userId}\/sessions": { + "get": { + "summary": "List user sessions", + "operationId": "usersListSessions", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Get the user sessions list by its unique ID.", + "responses": { + "200": { + "description": "Sessions List", + "schema": { + "$ref": "#\/definitions\/sessionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listSessions", + "group": "sessions", + "weight": 75, + "cookies": false, + "type": "", + "demo": "users\/list-sessions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.read", + "sessions.read" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create session", + "operationId": "usersCreateSession", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.", + "responses": { + "201": { + "description": "Session", + "schema": { + "$ref": "#\/definitions\/session" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSession", + "group": "sessions", + "weight": 97, + "cookies": false, + "type": "", + "demo": "users\/create-session.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] }, "delete": { - "summary": "Delete webhook", - "operationId": "webhooksDelete", + "summary": "Delete user sessions", + "operationId": "usersDeleteSessions", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "webhooks" + "users" ], - "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "description": "Delete all user's sessions by using the user's unique ID.", "responses": { "204": { "description": "No content" @@ -51548,22 +52472,26 @@ }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": null, - "weight": 588, + "method": "deleteSessions", + "group": "sessions", + "weight": 100, "cookies": false, "type": "", - "demo": "webhooks\/delete.md", + "demo": "users\/delete-sessions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": [ + "users.write", + "sessions.write" + ], "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md", "auth": { "Project": [], "Key": [] @@ -51577,20 +52505,90 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/webhooks\/{webhookId}\/secret": { + "\/users\/{userId}\/sessions\/{sessionId}": { + "delete": { + "summary": "Delete user session", + "operationId": "usersDeleteSession", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "users" + ], + "description": "Delete a user sessions by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteSession", + "group": "sessions", + "weight": 99, + "cookies": false, + "type": "", + "demo": "users\/delete-session.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "users.write", + "sessions.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "sessionId", + "description": "Session ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/users\/{userId}\/status": { "patch": { - "summary": "Update webhook secret key", - "operationId": "webhooksUpdateSecret", + "summary": "Update user status", + "operationId": "usersUpdateStatus", "consumes": [ "application\/json" ], @@ -51598,35 +52596,36 @@ "application\/json" ], "tags": [ - "webhooks" + "users" ], - "description": "Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.", + "description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.", "responses": { "200": { - "description": "Webhook", + "description": "User", "schema": { - "$ref": "#\/definitions\/webhook" + "$ref": "#\/definitions\/user" } } }, "deprecated": false, "x-appwrite": { - "method": "updateSecret", - "group": null, - "weight": 590, + "method": "updateStatus", + "group": "users", + "weight": 80, "cookies": false, "type": "", - "demo": "webhooks\/update-secret.md", + "demo": "users\/update-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "webhooks.write", + "scope": "users.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md", "auth": { "Project": [], "Key": [] @@ -51640,11 +52639,11 @@ ], "parameters": [ { - "name": "webhookId", - "description": "Webhook ID.", + "name": "userId", + "description": "User ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -51653,23 +52652,4046 @@ "schema": { "type": "object", "properties": { - "secret": { - "type": "string", - "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "status": { + "type": "boolean", + "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": false } - } + }, + "required": [ + "status" + ] } } ] } - } - }, - "tags": [ - { - "name": "account", + }, + "\/users\/{userId}\/targets": { + "get": { + "summary": "List user targets", + "operationId": "usersListTargets", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "List the messaging targets that are associated with a user.", + "responses": { + "200": { + "description": "Target list", + "schema": { + "$ref": "#\/definitions\/targetList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTargets", + "group": "targets", + "weight": 78, + "cookies": false, + "type": "", + "demo": "users\/list-targets.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.read", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create user target", + "operationId": "usersCreateTarget", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Create a messaging target.", + "responses": { + "201": { + "description": "Target", + "schema": { + "$ref": "#\/definitions\/target" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTarget", + "group": "targets", + "weight": 70, + "cookies": false, + "type": "", + "demo": "users\/create-target.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.write", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "targetId": { + "type": "string", + "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "providerType": { + "type": "string", + "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", + "default": null, + "x-example": "email", + "enum": [ + "email", + "sms", + "push" + ], + "x-enum-name": "MessagingProviderType", + "x-enum-keys": [] + }, + "identifier": { + "type": "string", + "description": "The target identifier (token, email, phone etc.)", + "default": null, + "x-example": "" + }, + "providerId": { + "type": "string", + "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", + "default": "", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "default": "", + "x-example": "" + } + }, + "required": [ + "targetId", + "providerType", + "identifier" + ] + } + } + ] + } + }, + "\/users\/{userId}\/targets\/{targetId}": { + "get": { + "summary": "Get user target", + "operationId": "usersGetTarget", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Get a user's push notification target by ID.", + "responses": { + "200": { + "description": "Target", + "schema": { + "$ref": "#\/definitions\/target" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTarget", + "group": "targets", + "weight": 74, + "cookies": false, + "type": "", + "demo": "users\/get-target.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.read", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "patch": { + "summary": "Update user target", + "operationId": "usersUpdateTarget", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Update a messaging target.", + "responses": { + "200": { + "description": "Target", + "schema": { + "$ref": "#\/definitions\/target" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTarget", + "group": "targets", + "weight": 90, + "cookies": false, + "type": "", + "demo": "users\/update-target.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.write", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "description": "The target identifier (token, email, phone etc.)", + "default": "", + "x-example": "" + }, + "providerId": { + "type": "string", + "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", + "default": "", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", + "default": "", + "x-example": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete user target", + "operationId": "usersDeleteTarget", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "users" + ], + "description": "Delete a messaging target.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTarget", + "group": "targets", + "weight": 102, + "cookies": false, + "type": "", + "demo": "users\/delete-target.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "targets.write", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "targetId", + "description": "Target ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/users\/{userId}\/tokens": { + "post": { + "summary": "Create token", + "operationId": "usersCreateToken", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n", + "responses": { + "201": { + "description": "Token", + "schema": { + "$ref": "#\/definitions\/token" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createToken", + "group": "sessions", + "weight": 98, + "cookies": false, + "type": "", + "demo": "users\/create-token.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "length": { + "type": "integer", + "description": "Token length in characters. The default length is 6 characters", + "default": 6, + "x-example": 4, + "format": "int32" + }, + "expire": { + "type": "integer", + "description": "Token expiration period in seconds. The default expiration is 15 minutes.", + "default": 900, + "x-example": 60, + "format": "int32" + } + } + } + } + ] + } + }, + "\/users\/{userId}\/verification": { + "patch": { + "summary": "Update email verification", + "operationId": "usersUpdateEmailVerification", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Update the user email verification status by its unique ID.", + "responses": { + "200": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateEmailVerification", + "group": "users", + "weight": 88, + "cookies": false, + "type": "", + "demo": "users\/update-email-verification.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "emailVerification": { + "type": "boolean", + "description": "User email verification status.", + "default": null, + "x-example": false + } + }, + "required": [ + "emailVerification" + ] + } + } + ] + } + }, + "\/users\/{userId}\/verification\/phone": { + "patch": { + "summary": "Update phone verification", + "operationId": "usersUpdatePhoneVerification", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "users" + ], + "description": "Update the user phone verification status by its unique ID.", + "responses": { + "200": { + "description": "User", + "schema": { + "$ref": "#\/definitions\/user" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updatePhoneVerification", + "group": "users", + "weight": 83, + "cookies": false, + "type": "", + "demo": "users\/update-phone-verification.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "users.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "userId", + "description": "User ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "phoneVerification": { + "type": "boolean", + "description": "User phone verification status.", + "default": null, + "x-example": false + } + }, + "required": [ + "phoneVerification" + ] + } + } + ] + } + }, + "\/vectorsdb": { + "get": { + "summary": "List databases", + "operationId": "vectorsDBList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Databases List", + "schema": { + "$ref": "#\/definitions\/databaseList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": "vectorsdb", + "weight": 868, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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 columns: name", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create database", + "operationId": "vectorsDBCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new Database.\n", + "responses": { + "201": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": "vectorsdb", + "weight": 864, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "databaseId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "databaseId", + "name" + ] + } + } + ] + } + }, + "\/vectorsdb\/embeddings\/text": { + "post": { + "summary": "Create Text Embeddings", + "operationId": "vectorsDBCreateTextEmbeddings", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "200": { + "description": "Embedding list", + "schema": { + "$ref": "#\/definitions\/embeddingList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTextEmbeddings", + "group": "documents", + "weight": 890, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-text-embeddings.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "methods": [ + { + "name": "createTextEmbeddings", + "namespace": "vectorsDB", + "desc": "Create Text Embedding", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "texts", + "model" + ], + "required": [ + "texts" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/embeddingList" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-text-embeddings.md", + "public": true + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "texts": { + "type": "array", + "description": "Array of text to generate embeddings.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "model": { + "type": "string", + "description": "The embedding model to use for generating vector embeddings.", + "default": "embeddinggemma", + "x-example": "embeddinggemma", + "enum": [ + "embeddinggemma" + ], + "x-enum-name": null, + "x-enum-keys": [] + } + }, + "required": [ + "texts" + ] + } + } + ] + } + }, + "\/vectorsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "vectorsDBListTransactions", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "List transactions across all databases.", + "responses": { + "200": { + "description": "Transaction List", + "schema": { + "$ref": "#\/definitions\/transactionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "weight": 895, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-transactions.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "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).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + }, + "post": { + "summary": "Create transaction", + "operationId": "vectorsDBCreateTransaction", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new transaction.", + "responses": { + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 891, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60, + "format": "int32" + } + } + } + } + ] + } + }, + "\/vectorsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "vectorsDBGetTransaction", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a transaction by its unique ID.", + "responses": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransaction", + "group": "transactions", + "weight": 892, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "patch": { + "summary": "Update transaction", + "operationId": "vectorsDBUpdateTransaction", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update a transaction, to either commit or roll back its operations.", + "responses": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "weight": 893, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "commit": { + "type": "boolean", + "description": "Commit transaction?", + "default": false, + "x-example": false + }, + "rollback": { + "type": "boolean", + "description": "Rollback transaction?", + "default": false, + "x-example": false + } + } + } + } + ] + }, + "delete": { + "summary": "Delete transaction", + "operationId": "vectorsDBDeleteTransaction", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete a transaction by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 894, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-transaction.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vectorsdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "vectorsDBCreateOperations", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create multiple operations in a single transaction.", + "responses": { + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 896, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "console", + "server", + "client" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-operations.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "operations": { + "type": "array", + "description": "Array of staged operations.", + "default": [], + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "vectorsDBGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "vectorsdb", + "weight": 865, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update database", + "operationId": "vectorsDBUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update a database by its unique ID.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": "vectorsdb", + "weight": 866, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete database", + "operationId": "vectorsDBDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": "vectorsdb", + "weight": 867, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "databases.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections": { + "get": { + "summary": "List collections", + "operationId": "vectorsDBListCollections", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "VectorsDB Collections List", + "schema": { + "$ref": "#\/definitions\/vectorsdbCollectionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollections", + "group": "collections", + "weight": 875, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-collections.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-collections.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create collection", + "operationId": "vectorsDBCreateCollection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "VectorsDB Collection", + "schema": { + "$ref": "#\/definitions\/vectorsdbCollection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createCollection", + "group": "collections", + "weight": 871, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "collectionId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Collection name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimension.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "collectionId", + "name", + "dimension" + ] + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}": { + "get": { + "summary": "Get collection", + "operationId": "vectorsDBGetCollection", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "responses": { + "200": { + "description": "VectorsDB Collection", + "schema": { + "$ref": "#\/definitions\/vectorsdbCollection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollection", + "group": "collections", + "weight": 872, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update collection", + "operationId": "vectorsDBUpdateCollection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update a collection by its unique ID.", + "responses": { + "200": { + "description": "VectorsDB Collection", + "schema": { + "$ref": "#\/definitions\/vectorsdbCollection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateCollection", + "group": "collections", + "weight": 873, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Collection name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimensions.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete collection", + "operationId": "vectorsDBDeleteCollection", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteCollection", + "group": "collections", + "weight": 874, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-collection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "vectorsDBListDocuments", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDocuments", + "group": "documents", + "weight": 885, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-documents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-documents.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "vectorsDBCreateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 881, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "vectorsDB", + "desc": "Create document", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-document.md", + "public": true + }, + { + "name": "createDocuments", + "namespace": "vectorsDB", + "desc": "Create documents", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/create-documents.md", + "public": true + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "documentId": { + "type": "string", + "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": [], + "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "put": { + "summary": "Upsert documents", + "operationId": "vectorsDBUpsertDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 888, + "cookies": false, + "type": "", + "demo": "vectorsdb\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-documents.md", + "methods": [ + { + "name": "upsertDocuments", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/documentList" + } + ], + "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.\n", + "demo": "vectorsdb\/upsert-documents.md", + "public": true + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + }, + "required": [ + "documents" + ] + } + } + ] + }, + "patch": { + "summary": "Update documents", + "operationId": "vectorsDBUpdateDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 887, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-documents.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete documents", + "operationId": "vectorsDBDeleteDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 889, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-documents.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "vectorsDBGetDocument", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 884, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + } + ] + }, + "put": { + "summary": "Upsert a document", + "operationId": "vectorsDBUpsertDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 883, + "cookies": false, + "type": "", + "demo": "vectorsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "vectorsDB", + "desc": "", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/document" + } + ], + "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "demo": "vectorsdb\/upsert-document.md", + "public": true + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "patch": { + "summary": "Update document", + "operationId": "vectorsDBUpdateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 882, + "cookies": false, + "type": "", + "demo": "vectorsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/update-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete document", + "operationId": "vectorsDBDeleteDocument", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 886, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "vectorsDBListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "schema": { + "$ref": "#\/definitions\/indexList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 880, + "cookies": false, + "type": "", + "demo": "vectorsdb\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/list-indexes.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create index", + "operationId": "vectorsDBCreateIndex", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "responses": { + "202": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/index" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 877, + "cookies": false, + "type": "", + "demo": "vectorsdb\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/create-index.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "default": null, + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "default": null, + "x-example": "hnsw_euclidean", + "enum": [ + "hnsw_euclidean", + "hnsw_dot", + "hnsw_cosine", + "object", + "key", + "unique" + ], + "x-enum-name": "VectorsDBIndexType", + "x-enum-keys": [] + }, + "attributes": { + "type": "array", + "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } + } + }, + "required": [ + "key", + "type", + "attributes" + ] + } + } + ] + } + }, + "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "vectorsDBGetIndex", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "vectorsDB" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/index" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 878, + "cookies": false, + "type": "", + "demo": "vectorsdb\/get-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/get-index.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "vectorsDBDeleteIndex", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "vectorsDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 879, + "cookies": false, + "type": "", + "demo": "vectorsdb\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vectorsdb\/delete-index.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "type": "string", + "in": "path" + } + ] + } + }, + "\/webhooks": { + "get": { + "summary": "List webhooks", + "operationId": "webhooksList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results.", + "responses": { + "200": { + "description": "Webhooks List", + "schema": { + "$ref": "#\/definitions\/webhookList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": null, + "weight": 567, + "cookies": false, + "type": "", + "demo": "webhooks\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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: name, url, authUsername, tls, events, enabled, logs, attempts", + "required": false, + "type": "array", + "collectionFormat": "multi", + "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, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + } + ] + }, + "post": { + "summary": "Create webhook", + "operationId": "webhooksCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.", + "responses": { + "201": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 566, + "cookies": false, + "type": "", + "demo": "webhooks\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "webhookId": { + "type": "string", + "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "default": null, + "x-example": "" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "default": null, + "x-example": null + }, + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "default": true, + "x-example": false + }, + "tls": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "default": false, + "x-example": false + }, + "authUsername": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "authPassword": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "secret": { + "type": "string", + "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "default": null, + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "webhookId", + "url", + "name", + "events" + ] + } + } + ] + } + }, + "\/webhooks\/{webhookId}": { + "get": { + "summary": "Get webhook", + "operationId": "webhooksGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": null, + "weight": 568, + "cookies": false, + "type": "", + "demo": "webhooks\/get.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update webhook", + "operationId": "webhooksUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": null, + "weight": 570, + "cookies": false, + "type": "", + "demo": "webhooks\/update.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Webhook name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "url": { + "type": "string", + "description": "Webhook URL.", + "default": null, + "x-example": null + }, + "events": { + "type": "array", + "description": "Events list. Maximum of 100 events are allowed.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, + "enabled": { + "type": "boolean", + "description": "Enable or disable a webhook.", + "default": true, + "x-example": false + }, + "tls": { + "type": "boolean", + "description": "Certificate verification, false for disabled or true for enabled.", + "default": false, + "x-example": false + }, + "authUsername": { + "type": "string", + "description": "Webhook HTTP user. Max length: 256 chars.", + "default": "", + "x-example": "" + }, + "authPassword": { + "type": "string", + "description": "Webhook HTTP password. Max length: 256 chars.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "url", + "events" + ] + } + } + ] + }, + "delete": { + "summary": "Delete webhook", + "operationId": "webhooksDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "webhooks" + ], + "description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "delete", + "group": null, + "weight": 569, + "cookies": false, + "type": "", + "demo": "webhooks\/delete.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/webhooks\/{webhookId}\/secret": { + "patch": { + "summary": "Update webhook secret key", + "operationId": "webhooksUpdateSecret", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "webhooks" + ], + "description": "Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.", + "responses": { + "200": { + "description": "Webhook", + "schema": { + "$ref": "#\/definitions\/webhook" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateSecret", + "group": null, + "weight": 571, + "cookies": false, + "type": "", + "demo": "webhooks\/update-secret.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "webhooks.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "webhookId", + "description": "Webhook ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "secret": { + "type": "string", + "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } + } + ] + } + } + }, + "tags": [ + { + "name": "account", "description": "The Account service allows you to authenticate and manage a user account." }, { @@ -52340,1136 +57362,2203 @@ }, "deployments": { "type": "array", - "description": "List of deployments.", + "description": "List of deployments.", + "items": { + "type": "object", + "$ref": "#\/definitions\/deployment" + }, + "x-example": "" + } + }, + "required": [ + "total", + "deployments" + ], + "example": { + "total": 5, + "deployments": "" + } + }, + "executionList": { + "description": "Executions List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of executions that matched your query.", + "x-example": 5, + "format": "int32" + }, + "executions": { + "type": "array", + "description": "List of executions.", + "items": { + "type": "object", + "$ref": "#\/definitions\/execution" + }, + "x-example": "" + } + }, + "required": [ + "total", + "executions" + ], + "example": { + "total": 5, + "executions": "" + } + }, + "webhookList": { + "description": "Webhooks List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of webhooks that matched your query.", + "x-example": 5, + "format": "int32" + }, + "webhooks": { + "type": "array", + "description": "List of webhooks.", + "items": { + "type": "object", + "$ref": "#\/definitions\/webhook" + }, + "x-example": "" + } + }, + "required": [ + "total", + "webhooks" + ], + "example": { + "total": 5, + "webhooks": "" + } + }, + "keyList": { + "description": "API Keys List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of keys that matched your query.", + "x-example": 5, + "format": "int32" + }, + "keys": { + "type": "array", + "description": "List of keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/key" + }, + "x-example": "" + } + }, + "required": [ + "total", + "keys" + ], + "example": { + "total": 5, + "keys": "" + } + }, + "countryList": { + "description": "Countries List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of countries that matched your query.", + "x-example": 5, + "format": "int32" + }, + "countries": { + "type": "array", + "description": "List of countries.", + "items": { + "type": "object", + "$ref": "#\/definitions\/country" + }, + "x-example": "" + } + }, + "required": [ + "total", + "countries" + ], + "example": { + "total": 5, + "countries": "" + } + }, + "continentList": { + "description": "Continents List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of continents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "continents": { + "type": "array", + "description": "List of continents.", + "items": { + "type": "object", + "$ref": "#\/definitions\/continent" + }, + "x-example": "" + } + }, + "required": [ + "total", + "continents" + ], + "example": { + "total": 5, + "continents": "" + } + }, + "languageList": { + "description": "Languages List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of languages that matched your query.", + "x-example": 5, + "format": "int32" + }, + "languages": { + "type": "array", + "description": "List of languages.", + "items": { + "type": "object", + "$ref": "#\/definitions\/language" + }, + "x-example": "" + } + }, + "required": [ + "total", + "languages" + ], + "example": { + "total": 5, + "languages": "" + } + }, + "currencyList": { + "description": "Currencies List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of currencies that matched your query.", + "x-example": 5, + "format": "int32" + }, + "currencies": { + "type": "array", + "description": "List of currencies.", + "items": { + "type": "object", + "$ref": "#\/definitions\/currency" + }, + "x-example": "" + } + }, + "required": [ + "total", + "currencies" + ], + "example": { + "total": 5, + "currencies": "" + } + }, + "phoneList": { + "description": "Phones List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of phones that matched your query.", + "x-example": 5, + "format": "int32" + }, + "phones": { + "type": "array", + "description": "List of phones.", + "items": { + "type": "object", + "$ref": "#\/definitions\/phone" + }, + "x-example": "" + } + }, + "required": [ + "total", + "phones" + ], + "example": { + "total": 5, + "phones": "" + } + }, + "variableList": { + "description": "Variables List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of variables that matched your query.", + "x-example": 5, + "format": "int32" + }, + "variables": { + "type": "array", + "description": "List of variables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/variable" + }, + "x-example": "" + } + }, + "required": [ + "total", + "variables" + ], + "example": { + "total": 5, + "variables": "" + } + }, + "mockNumberList": { + "description": "Mock Numbers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of mockNumbers that matched your query.", + "x-example": 5, + "format": "int32" + }, + "mockNumbers": { + "type": "array", + "description": "List of mockNumbers.", + "items": { + "type": "object", + "$ref": "#\/definitions\/mockNumber" + }, + "x-example": "" + } + }, + "required": [ + "total", + "mockNumbers" + ], + "example": { + "total": 5, + "mockNumbers": "" + } + }, + "policyList": { + "description": "Policies List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of policies in the given project.", + "x-example": 9, + "format": "int32" + }, + "policies": { + "type": "array", + "description": "List of policies.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/policyPasswordDictionary" + }, + { + "$ref": "#\/definitions\/policyPasswordHistory" + }, + { + "$ref": "#\/definitions\/policyPasswordPersonalData" + }, + { + "$ref": "#\/definitions\/policySessionAlert" + }, + { + "$ref": "#\/definitions\/policySessionDuration" + }, + { + "$ref": "#\/definitions\/policySessionInvalidation" + }, + { + "$ref": "#\/definitions\/policySessionLimit" + }, + { + "$ref": "#\/definitions\/policyUserLimit" + }, + { + "$ref": "#\/definitions\/policyMembershipPrivacy" + } + ], + "x-discriminator": { + "propertyName": "$id", + "mapping": { + "password-dictionary": "#\/definitions\/policyPasswordDictionary", + "password-history": "#\/definitions\/policyPasswordHistory", + "password-personal-data": "#\/definitions\/policyPasswordPersonalData", + "session-alert": "#\/definitions\/policySessionAlert", + "session-duration": "#\/definitions\/policySessionDuration", + "session-invalidation": "#\/definitions\/policySessionInvalidation", + "session-limit": "#\/definitions\/policySessionLimit", + "user-limit": "#\/definitions\/policyUserLimit", + "membership-privacy": "#\/definitions\/policyMembershipPrivacy" + } + } + }, + "x-example": "" + } + }, + "required": [ + "total", + "policies" + ], + "example": { + "total": 9, + "policies": "" + } + }, + "emailTemplateList": { + "description": "Email Templates List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of templates that matched your query.", + "x-example": 5, + "format": "int32" + }, + "templates": { + "type": "array", + "description": "List of templates.", + "items": { + "type": "object", + "$ref": "#\/definitions\/emailTemplate" + }, + "x-example": "" + } + }, + "required": [ + "total", + "templates" + ], + "example": { + "total": 5, + "templates": "" + } + }, + "healthStatusList": { + "description": "Status List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of statuses that matched your query.", + "x-example": 5, + "format": "int32" + }, + "statuses": { + "type": "array", + "description": "List of statuses.", + "items": { + "type": "object", + "$ref": "#\/definitions\/healthStatus" + }, + "x-example": "" + } + }, + "required": [ + "total", + "statuses" + ], + "example": { + "total": 5, + "statuses": "" + } + }, + "localeCodeList": { + "description": "Locale codes list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of localeCodes that matched your query.", + "x-example": 5, + "format": "int32" + }, + "localeCodes": { + "type": "array", + "description": "List of localeCodes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/localeCode" + }, + "x-example": "" + } + }, + "required": [ + "total", + "localeCodes" + ], + "example": { + "total": 5, + "localeCodes": "" + } + }, + "providerList": { + "description": "Provider list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of providers that matched your query.", + "x-example": 5, + "format": "int32" + }, + "providers": { + "type": "array", + "description": "List of providers.", "items": { "type": "object", - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/provider" }, "x-example": "" } }, "required": [ "total", - "deployments" + "providers" ], "example": { "total": 5, - "deployments": "" + "providers": "" } }, - "executionList": { - "description": "Executions List", + "messageList": { + "description": "Message list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of executions that matched your query.", + "description": "Total number of messages that matched your query.", "x-example": 5, "format": "int32" }, - "executions": { + "messages": { "type": "array", - "description": "List of executions.", + "description": "List of messages.", "items": { "type": "object", - "$ref": "#\/definitions\/execution" + "$ref": "#\/definitions\/message" }, "x-example": "" } }, "required": [ "total", - "executions" + "messages" ], "example": { "total": 5, - "executions": "" + "messages": "" } }, - "webhookList": { - "description": "Webhooks List", + "topicList": { + "description": "Topic list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of webhooks that matched your query.", + "description": "Total number of topics that matched your query.", "x-example": 5, "format": "int32" }, - "webhooks": { + "topics": { "type": "array", - "description": "List of webhooks.", + "description": "List of topics.", "items": { "type": "object", - "$ref": "#\/definitions\/webhook" + "$ref": "#\/definitions\/topic" }, "x-example": "" } }, "required": [ "total", - "webhooks" + "topics" ], "example": { "total": 5, - "webhooks": "" + "topics": "" } }, - "keyList": { - "description": "API Keys List", + "subscriberList": { + "description": "Subscriber list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of keys that matched your query.", + "description": "Total number of subscribers that matched your query.", "x-example": 5, "format": "int32" }, - "keys": { + "subscribers": { "type": "array", - "description": "List of keys.", + "description": "List of subscribers.", "items": { "type": "object", - "$ref": "#\/definitions\/key" + "$ref": "#\/definitions\/subscriber" }, "x-example": "" } }, "required": [ "total", - "keys" + "subscribers" ], "example": { "total": 5, - "keys": "" + "subscribers": "" } }, - "countryList": { - "description": "Countries List", + "targetList": { + "description": "Target list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of countries that matched your query.", + "description": "Total number of targets that matched your query.", "x-example": 5, "format": "int32" }, - "countries": { + "targets": { "type": "array", - "description": "List of countries.", + "description": "List of targets.", "items": { "type": "object", - "$ref": "#\/definitions\/country" + "$ref": "#\/definitions\/target" }, "x-example": "" } }, "required": [ "total", - "countries" + "targets" ], "example": { "total": 5, - "countries": "" + "targets": "" } }, - "continentList": { - "description": "Continents List", + "transactionList": { + "description": "Transaction List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of continents that matched your query.", + "description": "Total number of transactions that matched your query.", "x-example": 5, "format": "int32" }, - "continents": { + "transactions": { "type": "array", - "description": "List of continents.", + "description": "List of transactions.", "items": { "type": "object", - "$ref": "#\/definitions\/continent" + "$ref": "#\/definitions\/transaction" }, "x-example": "" } }, "required": [ "total", - "continents" + "transactions" ], "example": { "total": 5, - "continents": "" + "transactions": "" } }, - "languageList": { - "description": "Languages List", + "specificationList": { + "description": "Specifications List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of languages that matched your query.", + "description": "Total number of specifications that matched your query.", "x-example": 5, "format": "int32" }, - "languages": { + "specifications": { "type": "array", - "description": "List of languages.", + "description": "List of specifications.", "items": { "type": "object", - "$ref": "#\/definitions\/language" + "$ref": "#\/definitions\/specification" }, "x-example": "" } }, "required": [ "total", - "languages" + "specifications" ], "example": { "total": 5, - "languages": "" + "specifications": "" } }, - "currencyList": { - "description": "Currencies List", + "vectorsdbCollectionList": { + "description": "VectorsDB Collections List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of currencies that matched your query.", + "description": "Total number of collections that matched your query.", "x-example": 5, "format": "int32" }, - "currencies": { + "collections": { "type": "array", - "description": "List of currencies.", + "description": "List of collections.", "items": { "type": "object", - "$ref": "#\/definitions\/currency" + "$ref": "#\/definitions\/vectorsdbCollection" }, "x-example": "" } }, "required": [ "total", - "currencies" + "collections" ], "example": { "total": 5, - "currencies": "" + "collections": "" } }, - "phoneList": { - "description": "Phones List", + "embeddingList": { + "description": "Embedding list", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of phones that matched your query.", + "description": "Total number of embeddings that matched your query.", "x-example": 5, "format": "int32" }, - "phones": { + "embeddings": { "type": "array", - "description": "List of phones.", + "description": "List of embeddings.", "items": { "type": "object", - "$ref": "#\/definitions\/phone" + "$ref": "#\/definitions\/embedding" }, "x-example": "" } }, "required": [ "total", - "phones" + "embeddings" ], "example": { "total": 5, - "phones": "" + "embeddings": "" } }, - "variableList": { - "description": "Variables List", + "database": { + "description": "Database", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of variables that matched your query.", - "x-example": 5, - "format": "int32" + "$id": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" }, - "variables": { + "name": { + "type": "string", + "description": "Database name.", + "x-example": "My Database" + }, + "$createdAt": { + "type": "string", + "description": "Database creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Database update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "enabled": { + "type": "boolean", + "description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "type": { + "type": "string", + "description": "Database type.", + "x-example": "legacy", + "enum": [ + "legacy", + "tablesdb", + "documentsdb", + "vectorsdb" + ] + }, + "policies": { "type": "array", - "description": "List of variables.", + "description": "Database backup policies.", "items": { "type": "object", - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/index" }, - "x-example": "" + "x-example": {} + }, + "archives": { + "type": "array", + "description": "Database backup archives.", + "items": { + "type": "object", + "$ref": "#\/definitions\/collection" + }, + "x-example": {} } }, "required": [ - "total", - "variables" + "$id", + "name", + "$createdAt", + "$updatedAt", + "enabled", + "type", + "policies", + "archives" ], "example": { - "total": 5, - "variables": "" + "$id": "5e5ea5c16897e", + "name": "My Database", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "enabled": false, + "type": "legacy", + "policies": {}, + "archives": {} } }, - "healthStatusList": { - "description": "Status List", + "embedding": { + "description": "Embedding", "type": "object", "properties": { - "total": { + "model": { + "type": "string", + "description": "Embedding model used to generate embeddings.", + "x-example": "embeddinggemma" + }, + "dimension": { "type": "integer", - "description": "Total number of statuses that matched your query.", - "x-example": 5, + "description": "Number of dimensions for each embedding vector.", + "x-example": 768, "format": "int32" }, - "statuses": { + "embedding": { "type": "array", - "description": "List of statuses.", + "description": "Embedding vector values. If an error occurs, this will be an empty array.", "items": { - "type": "object", - "$ref": "#\/definitions\/healthStatus" + "type": "number", + "format": "double" }, - "x-example": "" + "x-example": [ + 0.01, + 0.02, + 0.03 + ] + }, + "error": { + "type": "string", + "description": "Error message if embedding generation fails. Empty string if no error.", + "x-example": "Error message" } }, "required": [ - "total", - "statuses" + "model", + "dimension", + "embedding", + "error" ], "example": { - "total": 5, - "statuses": "" + "model": "embeddinggemma", + "dimension": 768, + "embedding": [ + 0.01, + 0.02, + 0.03 + ], + "error": "Error message" } }, - "localeCodeList": { - "description": "Locale codes list", + "collection": { + "description": "Collection", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of localeCodes that matched your query.", - "x-example": 5, - "format": "int32" + "$id": { + "type": "string", + "description": "Collection ID.", + "x-example": "5e5ea5c16897e" }, - "localeCodes": { + "$createdAt": { + "type": "string", + "description": "Collection creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Collection update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { "type": "array", - "description": "List of localeCodes.", + "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Collection name.", + "x-example": "My Collection" + }, + "enabled": { + "type": "boolean", + "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "documentSecurity": { + "type": "boolean", + "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "attributes": { + "type": "array", + "description": "Collection attributes.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/attributeBoolean" + }, + { + "$ref": "#\/definitions\/attributeInteger" + }, + { + "$ref": "#\/definitions\/attributeFloat" + }, + { + "$ref": "#\/definitions\/attributeEmail" + }, + { + "$ref": "#\/definitions\/attributeEnum" + }, + { + "$ref": "#\/definitions\/attributeUrl" + }, + { + "$ref": "#\/definitions\/attributeIp" + }, + { + "$ref": "#\/definitions\/attributeDatetime" + }, + { + "$ref": "#\/definitions\/attributeRelationship" + }, + { + "$ref": "#\/definitions\/attributePoint" + }, + { + "$ref": "#\/definitions\/attributeLine" + }, + { + "$ref": "#\/definitions\/attributePolygon" + }, + { + "$ref": "#\/definitions\/attributeVarchar" + }, + { + "$ref": "#\/definitions\/attributeText" + }, + { + "$ref": "#\/definitions\/attributeMediumtext" + }, + { + "$ref": "#\/definitions\/attributeLongtext" + }, + { + "$ref": "#\/definitions\/attributeString" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/definitions\/attributeBoolean", + "integer": "#\/definitions\/attributeInteger", + "double": "#\/definitions\/attributeFloat", + "string": "#\/definitions\/attributeString", + "datetime": "#\/definitions\/attributeDatetime", + "relationship": "#\/definitions\/attributeRelationship", + "point": "#\/definitions\/attributePoint", + "linestring": "#\/definitions\/attributeLine", + "polygon": "#\/definitions\/attributePolygon", + "varchar": "#\/definitions\/attributeVarchar", + "text": "#\/definitions\/attributeText", + "mediumtext": "#\/definitions\/attributeMediumtext", + "longtext": "#\/definitions\/attributeLongtext" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/definitions\/attributeBoolean": { + "type": "boolean" + }, + "#\/definitions\/attributeInteger": { + "type": "integer" + }, + "#\/definitions\/attributeFloat": { + "type": "double" + }, + "#\/definitions\/attributeEmail": { + "type": "string", + "format": "email" + }, + "#\/definitions\/attributeEnum": { + "type": "string", + "format": "enum" + }, + "#\/definitions\/attributeUrl": { + "type": "string", + "format": "url" + }, + "#\/definitions\/attributeIp": { + "type": "string", + "format": "ip" + }, + "#\/definitions\/attributeDatetime": { + "type": "datetime" + }, + "#\/definitions\/attributeRelationship": { + "type": "relationship" + }, + "#\/definitions\/attributePoint": { + "type": "point" + }, + "#\/definitions\/attributeLine": { + "type": "linestring" + }, + "#\/definitions\/attributePolygon": { + "type": "polygon" + }, + "#\/definitions\/attributeVarchar": { + "type": "varchar" + }, + "#\/definitions\/attributeText": { + "type": "text" + }, + "#\/definitions\/attributeMediumtext": { + "type": "mediumtext" + }, + "#\/definitions\/attributeLongtext": { + "type": "longtext" + }, + "#\/definitions\/attributeString": { + "type": "string" + } + } + } + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Collection indexes.", "items": { "type": "object", - "$ref": "#\/definitions\/localeCode" + "$ref": "#\/definitions\/index" }, - "x-example": "" + "x-example": {} + }, + "bytesMax": { + "type": "integer", + "description": "Maximum document size in bytes. Returns 0 when no limit applies.", + "x-example": 65535, + "format": "int32" + }, + "bytesUsed": { + "type": "integer", + "description": "Currently used document size in bytes based on defined attributes.", + "x-example": 1500, + "format": "int32" } }, "required": [ - "total", - "localeCodes" + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "documentSecurity", + "attributes", + "indexes", + "bytesMax", + "bytesUsed" ], "example": { - "total": 5, - "localeCodes": "" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "databaseId": "5e5ea5c16897e", + "name": "My Collection", + "enabled": false, + "documentSecurity": true, + "attributes": {}, + "indexes": {}, + "bytesMax": 65535, + "bytesUsed": 1500 } }, - "providerList": { - "description": "Provider list", + "attributeList": { + "description": "Attributes List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of providers that matched your query.", + "description": "Total number of attributes in the given collection.", "x-example": 5, "format": "int32" }, - "providers": { + "attributes": { "type": "array", - "description": "List of providers.", + "description": "List of attributes.", "items": { - "type": "object", - "$ref": "#\/definitions\/provider" + "x-anyOf": [ + { + "$ref": "#\/definitions\/attributeBoolean" + }, + { + "$ref": "#\/definitions\/attributeInteger" + }, + { + "$ref": "#\/definitions\/attributeFloat" + }, + { + "$ref": "#\/definitions\/attributeEmail" + }, + { + "$ref": "#\/definitions\/attributeEnum" + }, + { + "$ref": "#\/definitions\/attributeUrl" + }, + { + "$ref": "#\/definitions\/attributeIp" + }, + { + "$ref": "#\/definitions\/attributeDatetime" + }, + { + "$ref": "#\/definitions\/attributeRelationship" + }, + { + "$ref": "#\/definitions\/attributePoint" + }, + { + "$ref": "#\/definitions\/attributeLine" + }, + { + "$ref": "#\/definitions\/attributePolygon" + }, + { + "$ref": "#\/definitions\/attributeVarchar" + }, + { + "$ref": "#\/definitions\/attributeText" + }, + { + "$ref": "#\/definitions\/attributeMediumtext" + }, + { + "$ref": "#\/definitions\/attributeLongtext" + }, + { + "$ref": "#\/definitions\/attributeString" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/definitions\/attributeBoolean", + "integer": "#\/definitions\/attributeInteger", + "double": "#\/definitions\/attributeFloat", + "string": "#\/definitions\/attributeString", + "datetime": "#\/definitions\/attributeDatetime", + "relationship": "#\/definitions\/attributeRelationship", + "point": "#\/definitions\/attributePoint", + "linestring": "#\/definitions\/attributeLine", + "polygon": "#\/definitions\/attributePolygon", + "varchar": "#\/definitions\/attributeVarchar", + "text": "#\/definitions\/attributeText", + "mediumtext": "#\/definitions\/attributeMediumtext", + "longtext": "#\/definitions\/attributeLongtext" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/definitions\/attributeBoolean": { + "type": "boolean" + }, + "#\/definitions\/attributeInteger": { + "type": "integer" + }, + "#\/definitions\/attributeFloat": { + "type": "double" + }, + "#\/definitions\/attributeEmail": { + "type": "string", + "format": "email" + }, + "#\/definitions\/attributeEnum": { + "type": "string", + "format": "enum" + }, + "#\/definitions\/attributeUrl": { + "type": "string", + "format": "url" + }, + "#\/definitions\/attributeIp": { + "type": "string", + "format": "ip" + }, + "#\/definitions\/attributeDatetime": { + "type": "datetime" + }, + "#\/definitions\/attributeRelationship": { + "type": "relationship" + }, + "#\/definitions\/attributePoint": { + "type": "point" + }, + "#\/definitions\/attributeLine": { + "type": "linestring" + }, + "#\/definitions\/attributePolygon": { + "type": "polygon" + }, + "#\/definitions\/attributeVarchar": { + "type": "varchar" + }, + "#\/definitions\/attributeText": { + "type": "text" + }, + "#\/definitions\/attributeMediumtext": { + "type": "mediumtext" + }, + "#\/definitions\/attributeLongtext": { + "type": "longtext" + }, + "#\/definitions\/attributeString": { + "type": "string" + } + } + } }, "x-example": "" } }, "required": [ "total", - "providers" + "attributes" ], "example": { "total": 5, - "providers": "" + "attributes": "" } }, - "messageList": { - "description": "Message list", + "attributeString": { + "description": "AttributeString", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "size": { "type": "integer", - "description": "Total number of messages that matched your query.", - "x-example": 5, + "description": "Attribute size.", + "x-example": 128, "format": "int32" }, - "messages": { - "type": "array", - "description": "List of messages.", - "items": { - "type": "object", - "$ref": "#\/definitions\/message" - }, - "x-example": "" + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ - "total", - "messages" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" ], "example": { - "total": 5, - "messages": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "size": 128, + "default": "default", + "encrypt": false } }, - "topicList": { - "description": "Topic list", + "attributeInteger": { + "description": "AttributeInteger", "type": "object", "properties": { - "total": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "count" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "integer" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { "type": "integer", - "description": "Total number of topics that matched your query.", - "x-example": 5, - "format": "int32" + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true }, - "topics": { - "type": "array", - "description": "List of topics.", - "items": { - "type": "object", - "$ref": "#\/definitions\/topic" - }, - "x-example": "" + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true + }, + "default": { + "type": "integer", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 10, + "format": "int32", + "x-nullable": true } }, "required": [ - "total", - "topics" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "topics": "" + "key": "count", + "type": "integer", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1, + "max": 10, + "default": 10 } }, - "subscriberList": { - "description": "Subscriber list", + "attributeFloat": { + "description": "AttributeFloat", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of subscribers that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "percentageCompleted" }, - "subscribers": { - "type": "array", - "description": "List of subscribers.", - "items": { - "type": "object", - "$ref": "#\/definitions\/subscriber" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "double" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true + }, + "default": { + "type": "number", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": 2.5, + "format": "double", + "x-nullable": true } }, "required": [ - "total", - "subscribers" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "subscribers": "" + "key": "percentageCompleted", + "type": "double", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "min": 1.5, + "max": 10.5, + "default": 2.5 } }, - "targetList": { - "description": "Target list", + "attributeBoolean": { + "description": "AttributeBoolean", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of targets that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "isEnabled" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "boolean" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "targets": { - "type": "array", - "description": "List of targets.", - "items": { - "type": "object", - "$ref": "#\/definitions\/target" - }, - "x-example": "" + "default": { + "type": "boolean", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": false, + "x-nullable": true } }, "required": [ - "total", - "targets" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "targets": "" + "key": "isEnabled", + "type": "boolean", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": false } }, - "transactionList": { - "description": "Transaction List", + "attributeEmail": { + "description": "AttributeEmail", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of transactions that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "userEmail" }, - "transactions": { - "type": "array", - "description": "List of transactions.", - "items": { - "type": "object", - "$ref": "#\/definitions\/transaction" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "email" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", + "x-nullable": true } }, "required": [ - "total", - "transactions" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "transactions": "" + "key": "userEmail", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "email", + "default": "default@example.com" } }, - "specificationList": { - "description": "Specifications List", + "attributeEnum": { + "description": "AttributeEnum", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of specifications that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "status" }, - "specifications": { + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "elements": { "type": "array", - "description": "List of specifications.", + "description": "Array of elements in enumerated type.", "items": { - "type": "object", - "$ref": "#\/definitions\/specification" + "type": "string" }, - "x-example": "" + "x-example": "element" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "enum" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "x-nullable": true } }, "required": [ - "total", - "specifications" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "elements", + "format" ], "example": { - "total": 5, - "specifications": "" + "key": "status", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "elements": "element", + "format": "enum", + "default": "element" } }, - "vectorsdbCollectionList": { - "description": "VectorsDB Collections List", + "attributeIp": { + "description": "AttributeIP", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of collections that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "ipAddress" }, - "collections": { - "type": "array", - "description": "List of collections.", - "items": { - "type": "object", - "$ref": "#\/definitions\/vectorsdbCollection" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "ip" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "192.0.2.0", + "x-nullable": true } }, "required": [ - "total", - "collections" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "collections": "" + "key": "ipAddress", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "ip", + "default": "192.0.2.0" } }, - "embeddingList": { - "description": "Embedding list", + "attributeUrl": { + "description": "AttributeURL", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of embeddings that matched your query.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "githubUrl" }, - "embeddings": { - "type": "array", - "description": "List of embeddings.", - "items": { - "type": "object", - "$ref": "#\/definitions\/embedding" - }, - "x-example": "" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "http:\/\/example.com", + "x-nullable": true } }, "required": [ - "total", - "embeddings" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "format" ], "example": { - "total": 5, - "embeddings": "" + "key": "githubUrl", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "url", + "default": "http:\/\/example.com" } }, - "database": { - "description": "Database", + "attributeDatetime": { + "description": "AttributeDatetime", "type": "object", "properties": { - "$id": { + "key": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "Attribute Key.", + "x-example": "birthDay" }, - "name": { + "type": { "type": "string", - "description": "Database name.", - "x-example": "My Database" + "description": "Attribute type.", + "x-example": "datetime" }, - "$createdAt": { + "status": { "type": "string", - "description": "Database creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" }, - "$updatedAt": { + "error": { "type": "string", - "description": "Database update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" }, - "enabled": { + "required": { "type": "boolean", - "description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "description": "Is attribute required?", + "x-example": true }, - "type": { + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { "type": "string", - "description": "Database type.", - "x-example": "legacy", - "enum": [ - "legacy", - "tablesdb", - "documentsdb", - "vectorsdb" - ] + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "policies": { - "type": "array", - "description": "Database backup policies.", - "items": { - "type": "object", - "$ref": "#\/definitions\/index" - }, - "x-example": {} + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "archives": { - "type": "array", - "description": "Database backup archives.", - "items": { - "type": "object", - "$ref": "#\/definitions\/collection" - }, - "x-example": {} + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true } }, "required": [ - "$id", - "name", + "key", + "type", + "status", + "error", + "required", "$createdAt", "$updatedAt", - "enabled", - "type", - "policies", - "archives" + "format" ], "example": { - "$id": "5e5ea5c16897e", - "name": "My Database", + "key": "birthDay", + "type": "datetime", + "status": "available", + "error": "string", + "required": true, + "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "enabled": false, - "type": "legacy", - "policies": {}, - "archives": {} + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "embedding": { - "description": "Embedding", + "attributeRelationship": { + "description": "AttributeRelationship", "type": "object", "properties": { - "model": { + "key": { "type": "string", - "description": "Embedding model used to generate embeddings.", - "x-example": "embeddinggemma" + "description": "Attribute Key.", + "x-example": "fullName" }, - "dimension": { - "type": "integer", - "description": "Number of dimensions for each embedding vector.", - "x-example": 768, - "format": "int32" + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" }, - "embedding": { - "type": "array", - "description": "Embedding vector values. If an error occurs, this will be an empty array.", - "items": { - "type": "number", - "format": "double" - }, - "x-example": [ - 0.01, - 0.02, - 0.03 - ] + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" }, "error": { "type": "string", - "description": "Error message if embedding generation fails. Empty string if no error.", - "x-example": "Error message" - } - }, - "required": [ - "model", - "dimension", - "embedding", - "error" - ], - "example": { - "model": "embeddinggemma", - "dimension": 768, - "embedding": [ - 0.01, - 0.02, - 0.03 - ], - "error": "Error message" - } - }, - "collection": { - "description": "Collection", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Collection ID.", - "x-example": "5e5ea5c16897e" + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, + "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Collection creation date in ISO 8601 format.", + "description": "Attribute creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Collection update date in ISO 8601 format.", + "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$permissions": { - "type": "array", - "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - }, - "databaseId": { + "relatedCollection": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "The ID of the related collection.", + "x-example": "collection" }, - "name": { + "relationType": { "type": "string", - "description": "Collection name.", - "x-example": "My Collection" + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" }, - "enabled": { + "twoWay": { "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.", + "description": "Is the relationship two-way?", "x-example": false }, - "documentSecurity": { - "type": "boolean", - "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true - }, - "attributes": { - "type": "array", - "description": "Collection attributes.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/attributeBoolean" - }, - { - "$ref": "#\/definitions\/attributeInteger" - }, - { - "$ref": "#\/definitions\/attributeFloat" - }, - { - "$ref": "#\/definitions\/attributeEmail" - }, - { - "$ref": "#\/definitions\/attributeEnum" - }, - { - "$ref": "#\/definitions\/attributeUrl" - }, - { - "$ref": "#\/definitions\/attributeIp" - }, - { - "$ref": "#\/definitions\/attributeDatetime" - }, - { - "$ref": "#\/definitions\/attributeRelationship" - }, - { - "$ref": "#\/definitions\/attributePoint" - }, - { - "$ref": "#\/definitions\/attributeLine" - }, - { - "$ref": "#\/definitions\/attributePolygon" - }, - { - "$ref": "#\/definitions\/attributeVarchar" - }, - { - "$ref": "#\/definitions\/attributeText" - }, - { - "$ref": "#\/definitions\/attributeMediumtext" - }, - { - "$ref": "#\/definitions\/attributeLongtext" - }, - { - "$ref": "#\/definitions\/attributeString" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/definitions\/attributeBoolean", - "integer": "#\/definitions\/attributeInteger", - "double": "#\/definitions\/attributeFloat", - "string": "#\/definitions\/attributeString", - "datetime": "#\/definitions\/attributeDatetime", - "relationship": "#\/definitions\/attributeRelationship", - "point": "#\/definitions\/attributePoint", - "linestring": "#\/definitions\/attributeLine", - "polygon": "#\/definitions\/attributePolygon", - "varchar": "#\/definitions\/attributeVarchar", - "text": "#\/definitions\/attributeText", - "mediumtext": "#\/definitions\/attributeMediumtext", - "longtext": "#\/definitions\/attributeLongtext" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/definitions\/attributeBoolean": { - "type": "boolean" - }, - "#\/definitions\/attributeInteger": { - "type": "integer" - }, - "#\/definitions\/attributeFloat": { - "type": "double" - }, - "#\/definitions\/attributeEmail": { - "type": "string", - "format": "email" - }, - "#\/definitions\/attributeEnum": { - "type": "string", - "format": "enum" - }, - "#\/definitions\/attributeUrl": { - "type": "string", - "format": "url" - }, - "#\/definitions\/attributeIp": { - "type": "string", - "format": "ip" - }, - "#\/definitions\/attributeDatetime": { - "type": "datetime" - }, - "#\/definitions\/attributeRelationship": { - "type": "relationship" - }, - "#\/definitions\/attributePoint": { - "type": "point" - }, - "#\/definitions\/attributeLine": { - "type": "linestring" - }, - "#\/definitions\/attributePolygon": { - "type": "polygon" - }, - "#\/definitions\/attributeVarchar": { - "type": "varchar" - }, - "#\/definitions\/attributeText": { - "type": "text" - }, - "#\/definitions\/attributeMediumtext": { - "type": "mediumtext" - }, - "#\/definitions\/attributeLongtext": { - "type": "longtext" - }, - "#\/definitions\/attributeString": { - "type": "string" - } - } - } - }, - "x-example": {} - }, - "indexes": { - "type": "array", - "description": "Collection indexes.", - "items": { - "type": "object", - "$ref": "#\/definitions\/index" - }, - "x-example": {} + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" }, - "bytesMax": { - "type": "integer", - "description": "Maximum document size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" }, - "bytesUsed": { - "type": "integer", - "description": "Currently used document size in bytes based on defined attributes.", - "x-example": 1500, - "format": "int32" + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ - "$id", + "key", + "type", + "status", + "error", + "required", "$createdAt", "$updatedAt", - "$permissions", - "databaseId", - "name", - "enabled", - "documentSecurity", - "attributes", - "indexes", - "bytesMax", - "bytesUsed" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "databaseId": "5e5ea5c16897e", - "name": "My Collection", - "enabled": false, - "documentSecurity": true, - "attributes": {}, - "indexes": {}, - "bytesMax": 65535, - "bytesUsed": 1500 - } - }, - "attributeList": { - "description": "Attributes List", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "Total number of attributes in the given collection.", - "x-example": 5, - "format": "int32" - }, - "attributes": { - "type": "array", - "description": "List of attributes.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/attributeBoolean" - }, - { - "$ref": "#\/definitions\/attributeInteger" - }, - { - "$ref": "#\/definitions\/attributeFloat" - }, - { - "$ref": "#\/definitions\/attributeEmail" - }, - { - "$ref": "#\/definitions\/attributeEnum" - }, - { - "$ref": "#\/definitions\/attributeUrl" - }, - { - "$ref": "#\/definitions\/attributeIp" - }, - { - "$ref": "#\/definitions\/attributeDatetime" - }, - { - "$ref": "#\/definitions\/attributeRelationship" - }, - { - "$ref": "#\/definitions\/attributePoint" - }, - { - "$ref": "#\/definitions\/attributeLine" - }, - { - "$ref": "#\/definitions\/attributePolygon" - }, - { - "$ref": "#\/definitions\/attributeVarchar" - }, - { - "$ref": "#\/definitions\/attributeText" - }, - { - "$ref": "#\/definitions\/attributeMediumtext" - }, - { - "$ref": "#\/definitions\/attributeLongtext" - }, - { - "$ref": "#\/definitions\/attributeString" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/definitions\/attributeBoolean", - "integer": "#\/definitions\/attributeInteger", - "double": "#\/definitions\/attributeFloat", - "string": "#\/definitions\/attributeString", - "datetime": "#\/definitions\/attributeDatetime", - "relationship": "#\/definitions\/attributeRelationship", - "point": "#\/definitions\/attributePoint", - "linestring": "#\/definitions\/attributeLine", - "polygon": "#\/definitions\/attributePolygon", - "varchar": "#\/definitions\/attributeVarchar", - "text": "#\/definitions\/attributeText", - "mediumtext": "#\/definitions\/attributeMediumtext", - "longtext": "#\/definitions\/attributeLongtext" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/definitions\/attributeBoolean": { - "type": "boolean" - }, - "#\/definitions\/attributeInteger": { - "type": "integer" - }, - "#\/definitions\/attributeFloat": { - "type": "double" - }, - "#\/definitions\/attributeEmail": { - "type": "string", - "format": "email" - }, - "#\/definitions\/attributeEnum": { - "type": "string", - "format": "enum" - }, - "#\/definitions\/attributeUrl": { - "type": "string", - "format": "url" - }, - "#\/definitions\/attributeIp": { - "type": "string", - "format": "ip" - }, - "#\/definitions\/attributeDatetime": { - "type": "datetime" - }, - "#\/definitions\/attributeRelationship": { - "type": "relationship" - }, - "#\/definitions\/attributePoint": { - "type": "point" - }, - "#\/definitions\/attributeLine": { - "type": "linestring" - }, - "#\/definitions\/attributePolygon": { - "type": "polygon" - }, - "#\/definitions\/attributeVarchar": { - "type": "varchar" - }, - "#\/definitions\/attributeText": { - "type": "text" - }, - "#\/definitions\/attributeMediumtext": { - "type": "mediumtext" - }, - "#\/definitions\/attributeLongtext": { - "type": "longtext" - }, - "#\/definitions\/attributeString": { - "type": "string" - } - } - } - }, - "x-example": "" - } - }, - "required": [ - "total", - "attributes" + "relatedCollection", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { - "total": 5, - "attributes": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "relatedCollection": "collection", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "attributeString": { - "description": "AttributeString", + "attributePoint": { + "description": "AttributePoint", "type": "object", "properties": { "key": { @@ -53521,22 +59610,13 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Attribute size.", - "x-example": 128, - "format": "int32" - }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + 0, + 0 + ], "x-nullable": true } }, @@ -53547,8 +59627,7 @@ "error", "required", "$createdAt", - "$updatedAt", - "size" + "$updatedAt" ], "example": { "key": "fullName", @@ -53559,24 +59638,25 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "attributeInteger": { - "description": "AttributeInteger", + "attributeLine": { + "description": "AttributeLine", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "count" + "x-example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "integer" + "x-example": "string" }, "status": { "type": "string", @@ -53617,25 +59697,130 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "min": { - "type": "integer", - "description": "Minimum value to enforce for new documents.", - "x-example": 1, - "format": "int64", + "default": { + "type": "array", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" + ], + "example": { + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] + } + }, + "attributePolygon": { + "description": "AttributePolygon", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" }, - "max": { - "type": "integer", - "description": "Maximum value to enforce for new documents.", - "x-example": 10, - "format": "int64", + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, "x-nullable": true }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "default": { - "type": "integer", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": 10, - "format": "int32", + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "x-nullable": true } }, @@ -53649,32 +59834,51 @@ "$updatedAt" ], "example": { - "key": "count", - "type": "integer", + "key": "fullName", + "type": "string", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "min": 1, - "max": 10, - "default": 10 + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, - "attributeFloat": { - "description": "AttributeFloat", + "attributeVarchar": { + "description": "AttributeVarchar", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "percentageCompleted" + "x-example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "double" + "x-example": "string" }, "status": { "type": "string", @@ -53715,25 +59919,112 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "min": { - "type": "number", - "description": "Minimum value to enforce for new documents.", - "x-example": 1.5, - "format": "double", + "size": { + "type": "integer", + "description": "Attribute size.", + "x-example": 128, + "format": "int32" + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", "x-nullable": true }, - "max": { - "type": "number", - "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, - "format": "double", + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt", + "size" + ], + "example": { + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "size": 128, + "default": "default", + "encrypt": false + } + }, + "attributeText": { + "description": "AttributeText", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": "fullName" + }, + "type": { + "type": "string", + "description": "Attribute type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "AttributeStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false, "x-nullable": true }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "default": { - "type": "number", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": 2.5, - "format": "double", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, "x-nullable": true } }, @@ -53747,32 +60038,31 @@ "$updatedAt" ], "example": { - "key": "percentageCompleted", - "type": "double", + "key": "fullName", + "type": "string", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "min": 1.5, - "max": 10.5, - "default": 2.5 + "default": "default", + "encrypt": false } }, - "attributeBoolean": { - "description": "AttributeBoolean", + "attributeMediumtext": { + "description": "AttributeMediumtext", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "isEnabled" + "x-example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "boolean" + "x-example": "string" }, "status": { "type": "string", @@ -53814,8 +60104,14 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "boolean", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", "x-example": false, "x-nullable": true } @@ -53830,25 +60126,26 @@ "$updatedAt" ], "example": { - "key": "isEnabled", - "type": "boolean", + "key": "fullName", + "type": "string", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": false + "default": "default", + "encrypt": false } }, - "attributeEmail": { - "description": "AttributeEmail", + "attributeLongtext": { + "description": "AttributeLongtext", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "userEmail" + "x-example": "fullName" }, "type": { "type": "string", @@ -53894,15 +60191,16 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "email" - }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default@example.com", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this attribute is encrypted or not.", + "x-example": false, "x-nullable": true } }, @@ -53913,11 +60211,10 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "userEmail", + "key": "fullName", "type": "string", "status": "available", "error": "string", @@ -53925,18 +60222,150 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "email", - "default": "default@example.com" + "default": "default", + "encrypt": false + } + }, + "vectorsdbCollection": { + "description": "VectorsDB Collection", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Collection ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Collection creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Collection update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "Collection name.", + "x-example": "My Collection" + }, + "enabled": { + "type": "boolean", + "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false + }, + "documentSecurity": { + "type": "boolean", + "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "attributes": { + "type": "array", + "description": "Collection attributes.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/attributeObject" + }, + { + "$ref": "#\/definitions\/attributeVector" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "object": "#\/definitions\/attributeObject", + "vector": "#\/definitions\/attributeVector" + } + } + }, + "x-example": {} + }, + "indexes": { + "type": "array", + "description": "Collection indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/index" + }, + "x-example": {} + }, + "bytesMax": { + "type": "integer", + "description": "Maximum document size in bytes. Returns 0 when no limit applies.", + "x-example": 65535, + "format": "int32" + }, + "bytesUsed": { + "type": "integer", + "description": "Currently used document size in bytes based on defined attributes.", + "x-example": 1500, + "format": "int32" + }, + "dimension": { + "type": "integer", + "description": "Embedding dimension.", + "x-example": 1536, + "format": "int32" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "databaseId", + "name", + "enabled", + "documentSecurity", + "attributes", + "indexes", + "bytesMax", + "bytesUsed", + "dimension" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "databaseId": "5e5ea5c16897e", + "name": "My Collection", + "enabled": false, + "documentSecurity": true, + "attributes": {}, + "indexes": {}, + "bytesMax": 65535, + "bytesUsed": 1500, + "dimension": 1536 } }, - "attributeEnum": { - "description": "AttributeEnum", + "attributeObject": { + "description": "AttributeObject", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "status" + "x-example": "fullName" }, "type": { "type": "string", @@ -53981,25 +60410,6 @@ "type": "string", "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "elements": { - "type": "array", - "description": "Array of elements in enumerated type.", - "items": { - "type": "string" - }, - "x-example": "element" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "enum" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "element", - "x-nullable": true } }, "required": [ @@ -54009,32 +60419,27 @@ "error", "required", "$createdAt", - "$updatedAt", - "elements", - "format" + "$updatedAt" ], "example": { - "key": "status", + "key": "fullName", "type": "string", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "elements": "element", - "format": "enum", - "default": "element" + "$updatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "attributeIp": { - "description": "AttributeIP", + "attributeVector": { + "description": "AttributeVector", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "ipAddress" + "x-example": "fullName" }, "type": { "type": "string", @@ -54080,16 +60485,11 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "ip" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "192.0.2.0", - "x-nullable": true + "size": { + "type": "integer", + "description": "Vector dimensions.", + "x-example": 1536, + "format": "int32" } }, "required": [ @@ -54100,10 +60500,10 @@ "required", "$createdAt", "$updatedAt", - "format" + "size" ], "example": { - "key": "ipAddress", + "key": "fullName", "type": "string", "status": "available", "error": "string", @@ -54111,203 +60511,426 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "ip", - "default": "192.0.2.0" + "size": 1536 } }, - "attributeUrl": { - "description": "AttributeURL", + "table": { + "description": "Table", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Attribute Key.", - "x-example": "githubUrl" + "description": "Table ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Attribute type.", - "x-example": "string" + "description": "Table creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "$updatedAt": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" + "description": "Table update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { + "$permissions": { + "type": "array", + "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + }, + "databaseId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "description": "Database ID.", + "x-example": "5e5ea5c16897e" }, - "required": { + "name": { + "type": "string", + "description": "Table name.", + "x-example": "My Table" + }, + "enabled": { "type": "boolean", - "description": "Is attribute required?", - "x-example": true + "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", + "x-example": false }, - "array": { + "rowSecurity": { "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "x-nullable": true + "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "columns": { + "type": "array", + "description": "Table columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnPoint" + }, + { + "$ref": "#\/definitions\/columnLine" + }, + { + "$ref": "#\/definitions\/columnPolygon" + }, + { + "$ref": "#\/definitions\/columnVarchar" + }, + { + "$ref": "#\/definitions\/columnText" + }, + { + "$ref": "#\/definitions\/columnMediumtext" + }, + { + "$ref": "#\/definitions\/columnLongtext" + }, + { + "$ref": "#\/definitions\/columnString" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/definitions\/columnBoolean", + "integer": "#\/definitions\/columnInteger", + "double": "#\/definitions\/columnFloat", + "string": "#\/definitions\/columnString", + "datetime": "#\/definitions\/columnDatetime", + "relationship": "#\/definitions\/columnRelationship", + "point": "#\/definitions\/columnPoint", + "linestring": "#\/definitions\/columnLine", + "polygon": "#\/definitions\/columnPolygon", + "varchar": "#\/definitions\/columnVarchar", + "text": "#\/definitions\/columnText", + "mediumtext": "#\/definitions\/columnMediumtext", + "longtext": "#\/definitions\/columnLongtext" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/definitions\/columnBoolean": { + "type": "boolean" + }, + "#\/definitions\/columnInteger": { + "type": "integer" + }, + "#\/definitions\/columnFloat": { + "type": "double" + }, + "#\/definitions\/columnEmail": { + "type": "string", + "format": "email" + }, + "#\/definitions\/columnEnum": { + "type": "string", + "format": "enum" + }, + "#\/definitions\/columnUrl": { + "type": "string", + "format": "url" + }, + "#\/definitions\/columnIp": { + "type": "string", + "format": "ip" + }, + "#\/definitions\/columnDatetime": { + "type": "datetime" + }, + "#\/definitions\/columnRelationship": { + "type": "relationship" + }, + "#\/definitions\/columnPoint": { + "type": "point" + }, + "#\/definitions\/columnLine": { + "type": "linestring" + }, + "#\/definitions\/columnPolygon": { + "type": "polygon" + }, + "#\/definitions\/columnVarchar": { + "type": "varchar" + }, + "#\/definitions\/columnText": { + "type": "text" + }, + "#\/definitions\/columnMediumtext": { + "type": "mediumtext" + }, + "#\/definitions\/columnLongtext": { + "type": "longtext" + }, + "#\/definitions\/columnString": { + "type": "string" + } + } + } + }, + "x-example": {} }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "indexes": { + "type": "array", + "description": "Table indexes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/columnIndex" + }, + "x-example": {} }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "url" + "bytesMax": { + "type": "integer", + "description": "Maximum row size in bytes. Returns 0 when no limit applies.", + "x-example": 65535, + "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", - "x-nullable": true + "bytesUsed": { + "type": "integer", + "description": "Currently used row size in bytes based on defined columns.", + "x-example": 1500, + "format": "int32" } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", "$updatedAt", - "format" + "$permissions", + "databaseId", + "name", + "enabled", + "rowSecurity", + "columns", + "indexes", + "bytesMax", + "bytesUsed" ], "example": { - "key": "githubUrl", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "url", - "default": "http:\/\/example.com" + "$permissions": [ + "read(\"any\")" + ], + "databaseId": "5e5ea5c16897e", + "name": "My Table", + "enabled": false, + "rowSecurity": true, + "columns": {}, + "indexes": {}, + "bytesMax": 65535, + "bytesUsed": 1500 } }, - "attributeDatetime": { - "description": "AttributeDatetime", + "columnList": { + "description": "Columns List", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "birthDay" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "datetime" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "format": { - "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "total": { + "type": "integer", + "description": "Total number of columns in the given table.", + "x-example": 5, + "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", - "x-nullable": true + "columns": { + "type": "array", + "description": "List of columns.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/columnBoolean" + }, + { + "$ref": "#\/definitions\/columnInteger" + }, + { + "$ref": "#\/definitions\/columnFloat" + }, + { + "$ref": "#\/definitions\/columnEmail" + }, + { + "$ref": "#\/definitions\/columnEnum" + }, + { + "$ref": "#\/definitions\/columnUrl" + }, + { + "$ref": "#\/definitions\/columnIp" + }, + { + "$ref": "#\/definitions\/columnDatetime" + }, + { + "$ref": "#\/definitions\/columnRelationship" + }, + { + "$ref": "#\/definitions\/columnPoint" + }, + { + "$ref": "#\/definitions\/columnLine" + }, + { + "$ref": "#\/definitions\/columnPolygon" + }, + { + "$ref": "#\/definitions\/columnVarchar" + }, + { + "$ref": "#\/definitions\/columnText" + }, + { + "$ref": "#\/definitions\/columnMediumtext" + }, + { + "$ref": "#\/definitions\/columnLongtext" + }, + { + "$ref": "#\/definitions\/columnString" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "boolean": "#\/definitions\/columnBoolean", + "integer": "#\/definitions\/columnInteger", + "double": "#\/definitions\/columnFloat", + "string": "#\/definitions\/columnString", + "datetime": "#\/definitions\/columnDatetime", + "relationship": "#\/definitions\/columnRelationship", + "point": "#\/definitions\/columnPoint", + "linestring": "#\/definitions\/columnLine", + "polygon": "#\/definitions\/columnPolygon", + "varchar": "#\/definitions\/columnVarchar", + "text": "#\/definitions\/columnText", + "mediumtext": "#\/definitions\/columnMediumtext", + "longtext": "#\/definitions\/columnLongtext" + }, + "x-propertyNames": [ + "type", + "format" + ], + "x-mapping": { + "#\/definitions\/columnBoolean": { + "type": "boolean" + }, + "#\/definitions\/columnInteger": { + "type": "integer" + }, + "#\/definitions\/columnFloat": { + "type": "double" + }, + "#\/definitions\/columnEmail": { + "type": "string", + "format": "email" + }, + "#\/definitions\/columnEnum": { + "type": "string", + "format": "enum" + }, + "#\/definitions\/columnUrl": { + "type": "string", + "format": "url" + }, + "#\/definitions\/columnIp": { + "type": "string", + "format": "ip" + }, + "#\/definitions\/columnDatetime": { + "type": "datetime" + }, + "#\/definitions\/columnRelationship": { + "type": "relationship" + }, + "#\/definitions\/columnPoint": { + "type": "point" + }, + "#\/definitions\/columnLine": { + "type": "linestring" + }, + "#\/definitions\/columnPolygon": { + "type": "polygon" + }, + "#\/definitions\/columnVarchar": { + "type": "varchar" + }, + "#\/definitions\/columnText": { + "type": "text" + }, + "#\/definitions\/columnMediumtext": { + "type": "mediumtext" + }, + "#\/definitions\/columnLongtext": { + "type": "longtext" + }, + "#\/definitions\/columnString": { + "type": "string" + } + } + } + }, + "x-example": "" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "total", + "columns" ], "example": { - "key": "birthDay", - "type": "datetime", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "total": 5, + "columns": "" } }, - "attributeRelationship": { - "description": "AttributeRelationship", + "columnString": { + "description": "ColumnString", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", + "description": "Column Key.", "x-example": "fullName" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -54316,63 +60939,51 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "relatedCollection": { - "type": "string", - "description": "The ID of the related collection.", - "x-example": "collection" + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" }, - "relationType": { + "default": { "type": "string", - "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true }, - "twoWay": { + "encrypt": { "type": "boolean", - "description": "Is the relationship two-way?", - "x-example": false - }, - "twoWayKey": { - "type": "string", - "description": "The key of the two-way relationship.", - "x-example": "string" - }, - "onDelete": { - "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" - }, - "side": { - "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Defines whether this column is encrypted or not.", + "x-example": false, + "x-nullable": true } }, "required": [ @@ -54383,12 +60994,7 @@ "required", "$createdAt", "$updatedAt", - "relatedCollection", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "size" ], "example": { "key": "fullName", @@ -54399,31 +61005,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "relatedCollection": "collection", - "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", - "twoWay": false, - "twoWayKey": "string", - "onDelete": "restrict|cascade|setNull", - "side": "parent|child" + "size": 128, + "default": "default", + "encrypt": false } }, - "attributePoint": { - "description": "AttributePoint", + "columnInteger": { + "description": "ColumnInteger", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "count" }, "type": { "type": "string", - "description": "Attribute type.", - "x-example": "string" + "description": "Column type.", + "x-example": "integer" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -54432,134 +61035,53 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - 0, - 0 - ], + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", "x-nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" - ], - "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] - } - }, - "attributeLine": { - "description": "AttributeLine", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" - }, - "type": { - "type": "string", - "description": "Attribute type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "AttributeStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": true }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false, + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", "x-nullable": true }, - "$createdAt": { - "type": "string", - "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "type": "integer", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 10, + "format": "int32", "x-nullable": true } }, @@ -54573,43 +61095,36 @@ "$updatedAt" ], "example": { - "key": "fullName", - "type": "string", + "key": "count", + "type": "integer", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ] + "min": 1, + "max": 10, + "default": 10 } }, - "attributePolygon": { - "description": "AttributePolygon", + "columnFloat": { + "description": "ColumnFloat", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "percentageCompleted" }, "type": { "type": "string", - "description": "Attribute type.", - "x-example": "string" + "description": "Column type.", + "x-example": "double" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -54618,59 +61133,53 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true + }, "default": { - "type": "array", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ], + "type": "number", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": 2.5, + "format": "double", "x-nullable": true } }, @@ -54684,55 +61193,36 @@ "$updatedAt" ], "example": { - "key": "fullName", - "type": "string", + "key": "percentageCompleted", + "type": "double", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "min": 1.5, + "max": 10.5, + "default": 2.5 } }, - "attributeVarchar": { - "description": "AttributeVarchar", + "columnBoolean": { + "description": "ColumnBoolean", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "isEnabled" }, "type": { "type": "string", - "description": "Attribute type.", - "x-example": "string" + "description": "Column type.", + "x-example": "boolean" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -54741,49 +61231,37 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Attribute size.", - "x-example": 128, - "format": "int32" - }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": false, "x-nullable": true } @@ -54795,40 +61273,37 @@ "error", "required", "$createdAt", - "$updatedAt", - "size" + "$updatedAt" ], "example": { - "key": "fullName", - "type": "string", + "key": "isEnabled", + "type": "boolean", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "default": false } }, - "attributeText": { - "description": "AttributeText", + "columnEmail": { + "description": "ColumnEmail", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "userEmail" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -54837,44 +61312,43 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "format": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true + "description": "String format.", + "x-example": "email" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default@example.com", "x-nullable": true } }, @@ -54885,10 +61359,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "userEmail", "type": "string", "status": "available", "error": "string", @@ -54896,27 +61371,27 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "format": "email", + "default": "default@example.com" } }, - "attributeMediumtext": { - "description": "AttributeMediumtext", + "columnEnum": { + "description": "ColumnEnum", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "status" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -54925,44 +61400,51 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" + }, + "format": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true + "description": "String format.", + "x-example": "enum" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "element", "x-nullable": true } }, @@ -54973,10 +61455,12 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -54984,27 +61468,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "elements": "element", + "format": "enum", + "default": "element" } }, - "attributeLongtext": { - "description": "AttributeLongtext", + "columnIp": { + "description": "ColumnIP", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "ipAddress" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -55013,44 +61498,43 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "format": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true + "description": "String format.", + "x-example": "ip" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "192.0.2.0", "x-nullable": true } }, @@ -55061,10 +61545,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -55072,159 +61557,27 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false - } - }, - "vectorsdbCollection": { - "description": "VectorsDB Collection", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Collection ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Collection creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Collection update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - }, - "databaseId": { - "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" - }, - "name": { - "type": "string", - "description": "Collection name.", - "x-example": "My Collection" - }, - "enabled": { - "type": "boolean", - "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false - }, - "documentSecurity": { - "type": "boolean", - "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true - }, - "attributes": { - "type": "array", - "description": "Collection attributes.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/attributeObject" - }, - { - "$ref": "#\/definitions\/attributeVector" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "object": "#\/definitions\/attributeObject", - "vector": "#\/definitions\/attributeVector" - } - } - }, - "x-example": {} - }, - "indexes": { - "type": "array", - "description": "Collection indexes.", - "items": { - "type": "object", - "$ref": "#\/definitions\/index" - }, - "x-example": {} - }, - "bytesMax": { - "type": "integer", - "description": "Maximum document size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" - }, - "bytesUsed": { - "type": "integer", - "description": "Currently used document size in bytes based on defined attributes.", - "x-example": 1500, - "format": "int32" - }, - "dimension": { - "type": "integer", - "description": "Embedding dimension.", - "x-example": 1536, - "format": "int32" - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "$permissions", - "databaseId", - "name", - "enabled", - "documentSecurity", - "attributes", - "indexes", - "bytesMax", - "bytesUsed", - "dimension" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "databaseId": "5e5ea5c16897e", - "name": "My Collection", - "enabled": false, - "documentSecurity": true, - "attributes": {}, - "indexes": {}, - "bytesMax": 65535, - "bytesUsed": 1500, - "dimension": 1536 + "format": "ip", + "default": "192.0.2.0" } }, - "attributeObject": { - "description": "AttributeObject", + "columnUrl": { + "description": "ColumnURL", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "githubUrl" }, "type": { "type": "string", - "description": "Attribute type.", + "description": "Column type.", "x-example": "string" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -55233,33 +61586,44 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "format": { + "type": "string", + "description": "String format.", + "x-example": "url" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "https:\/\/example.com", + "x-nullable": true } }, "required": [ @@ -55269,36 +61633,39 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00" + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "format": "url", + "default": "https:\/\/example.com" } }, - "attributeVector": { - "description": "AttributeVector", + "columnDatetime": { + "description": "ColumnDatetime", "type": "object", "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": "fullName" + "description": "Column Key.", + "x-example": "birthDay" }, "type": { "type": "string", - "description": "Attribute type.", - "x-example": "string" + "description": "Column type.", + "x-example": "datetime" }, "status": { "type": "string", - "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -55307,39 +61674,44 @@ "stuck", "failed" ], - "x-enum-name": "AttributeStatus" + "x-enum-name": "ColumnStatus" }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", "x-example": "string" }, "required": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is column required?", "x-example": true }, "array": { "type": "boolean", - "description": "Is attribute an array?", + "description": "Is column an array?", "x-example": false, "x-nullable": true }, "$createdAt": { "type": "string", - "description": "Attribute creation date in ISO 8601 format.", + "description": "Column creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Attribute update date in ISO 8601 format.", + "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Vector dimensions.", - "x-example": 1536, - "format": "int32" + "format": { + "type": "string", + "description": "ISO 8601 format.", + "x-example": "datetime" + }, + "default": { + "type": "string", + "description": "Default value for column when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true } }, "required": [ @@ -55350,422 +61722,226 @@ "required", "$createdAt", "$updatedAt", - "size" + "format" ], "example": { - "key": "fullName", - "type": "string", + "key": "birthDay", + "type": "datetime", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 1536 + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "table": { - "description": "Table", + "columnRelationship": { + "description": "ColumnRelationship", "type": "object", "properties": { - "$id": { - "type": "string", - "description": "Table ID.", - "x-example": "5e5ea5c16897e" - }, - "$createdAt": { - "type": "string", - "description": "Table creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { + "key": { "type": "string", - "description": "Table update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] + "description": "Column Key.", + "x-example": "fullName" }, - "databaseId": { + "type": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "description": "Column type.", + "x-example": "string" }, - "name": { + "status": { "type": "string", - "description": "Table name.", - "x-example": "My Table" - }, - "enabled": { - "type": "boolean", - "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false - }, - "rowSecurity": { - "type": "boolean", - "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true - }, - "columns": { - "type": "array", - "description": "Table columns.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/columnBoolean" - }, - { - "$ref": "#\/definitions\/columnInteger" - }, - { - "$ref": "#\/definitions\/columnFloat" - }, - { - "$ref": "#\/definitions\/columnEmail" - }, - { - "$ref": "#\/definitions\/columnEnum" - }, - { - "$ref": "#\/definitions\/columnUrl" - }, - { - "$ref": "#\/definitions\/columnIp" - }, - { - "$ref": "#\/definitions\/columnDatetime" - }, - { - "$ref": "#\/definitions\/columnRelationship" - }, - { - "$ref": "#\/definitions\/columnPoint" - }, - { - "$ref": "#\/definitions\/columnLine" - }, - { - "$ref": "#\/definitions\/columnPolygon" - }, - { - "$ref": "#\/definitions\/columnVarchar" - }, - { - "$ref": "#\/definitions\/columnText" - }, - { - "$ref": "#\/definitions\/columnMediumtext" - }, - { - "$ref": "#\/definitions\/columnLongtext" - }, - { - "$ref": "#\/definitions\/columnString" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/definitions\/columnBoolean", - "integer": "#\/definitions\/columnInteger", - "double": "#\/definitions\/columnFloat", - "string": "#\/definitions\/columnString", - "datetime": "#\/definitions\/columnDatetime", - "relationship": "#\/definitions\/columnRelationship", - "point": "#\/definitions\/columnPoint", - "linestring": "#\/definitions\/columnLine", - "polygon": "#\/definitions\/columnPolygon", - "varchar": "#\/definitions\/columnVarchar", - "text": "#\/definitions\/columnText", - "mediumtext": "#\/definitions\/columnMediumtext", - "longtext": "#\/definitions\/columnLongtext" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/definitions\/columnBoolean": { - "type": "boolean" - }, - "#\/definitions\/columnInteger": { - "type": "integer" - }, - "#\/definitions\/columnFloat": { - "type": "double" - }, - "#\/definitions\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/definitions\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/definitions\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/definitions\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/definitions\/columnDatetime": { - "type": "datetime" - }, - "#\/definitions\/columnRelationship": { - "type": "relationship" - }, - "#\/definitions\/columnPoint": { - "type": "point" - }, - "#\/definitions\/columnLine": { - "type": "linestring" - }, - "#\/definitions\/columnPolygon": { - "type": "polygon" - }, - "#\/definitions\/columnVarchar": { - "type": "varchar" - }, - "#\/definitions\/columnText": { - "type": "text" - }, - "#\/definitions\/columnMediumtext": { - "type": "mediumtext" - }, - "#\/definitions\/columnLongtext": { - "type": "longtext" - }, - "#\/definitions\/columnString": { - "type": "string" - } - } - } - }, - "x-example": {} + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" }, - "indexes": { - "type": "array", - "description": "Table indexes.", - "items": { - "type": "object", - "$ref": "#\/definitions\/columnIndex" - }, - "x-example": {} + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" }, - "bytesMax": { - "type": "integer", - "description": "Maximum row size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true }, - "bytesUsed": { - "type": "integer", - "description": "Currently used row size in bytes based on defined columns.", - "x-example": 1500, - "format": "int32" + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" + }, + "relationType": { + "type": "string", + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + }, + "twoWay": { + "type": "boolean", + "description": "Is the relationship two-way?", + "x-example": false + }, + "twoWayKey": { + "type": "string", + "description": "The key of the two-way relationship.", + "x-example": "string" + }, + "onDelete": { + "type": "string", + "description": "How deleting the parent document will propagate to child documents.", + "x-example": "restrict|cascade|setNull" + }, + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ - "$id", + "key", + "type", + "status", + "error", + "required", "$createdAt", "$updatedAt", - "$permissions", - "databaseId", - "name", - "enabled", - "rowSecurity", - "columns", - "indexes", - "bytesMax", - "bytesUsed" + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { - "$id": "5e5ea5c16897e", + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "databaseId": "5e5ea5c16897e", - "name": "My Table", - "enabled": false, - "rowSecurity": true, - "columns": {}, - "indexes": {}, - "bytesMax": 65535, - "bytesUsed": 1500 + "relatedTable": "table", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "columnList": { - "description": "Columns List", + "columnPoint": { + "description": "ColumnPoint", "type": "object", "properties": { - "total": { - "type": "integer", - "description": "Total number of columns in the given table.", - "x-example": 5, - "format": "int32" + "key": { + "type": "string", + "description": "Column Key.", + "x-example": "fullName" }, - "columns": { + "type": { + "type": "string", + "description": "Column type.", + "x-example": "string" + }, + "status": { + "type": "string", + "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available", + "enum": [ + "available", + "processing", + "deleting", + "stuck", + "failed" + ], + "x-enum-name": "ColumnStatus" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "x-example": "string" + }, + "required": { + "type": "boolean", + "description": "Is column required?", + "x-example": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false, + "x-nullable": true + }, + "$createdAt": { + "type": "string", + "description": "Column creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Column update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "default": { "type": "array", - "description": "List of columns.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/columnBoolean" - }, - { - "$ref": "#\/definitions\/columnInteger" - }, - { - "$ref": "#\/definitions\/columnFloat" - }, - { - "$ref": "#\/definitions\/columnEmail" - }, - { - "$ref": "#\/definitions\/columnEnum" - }, - { - "$ref": "#\/definitions\/columnUrl" - }, - { - "$ref": "#\/definitions\/columnIp" - }, - { - "$ref": "#\/definitions\/columnDatetime" - }, - { - "$ref": "#\/definitions\/columnRelationship" - }, - { - "$ref": "#\/definitions\/columnPoint" - }, - { - "$ref": "#\/definitions\/columnLine" - }, - { - "$ref": "#\/definitions\/columnPolygon" - }, - { - "$ref": "#\/definitions\/columnVarchar" - }, - { - "$ref": "#\/definitions\/columnText" - }, - { - "$ref": "#\/definitions\/columnMediumtext" - }, - { - "$ref": "#\/definitions\/columnLongtext" - }, - { - "$ref": "#\/definitions\/columnString" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "boolean": "#\/definitions\/columnBoolean", - "integer": "#\/definitions\/columnInteger", - "double": "#\/definitions\/columnFloat", - "string": "#\/definitions\/columnString", - "datetime": "#\/definitions\/columnDatetime", - "relationship": "#\/definitions\/columnRelationship", - "point": "#\/definitions\/columnPoint", - "linestring": "#\/definitions\/columnLine", - "polygon": "#\/definitions\/columnPolygon", - "varchar": "#\/definitions\/columnVarchar", - "text": "#\/definitions\/columnText", - "mediumtext": "#\/definitions\/columnMediumtext", - "longtext": "#\/definitions\/columnLongtext" - }, - "x-propertyNames": [ - "type", - "format" - ], - "x-mapping": { - "#\/definitions\/columnBoolean": { - "type": "boolean" - }, - "#\/definitions\/columnInteger": { - "type": "integer" - }, - "#\/definitions\/columnFloat": { - "type": "double" - }, - "#\/definitions\/columnEmail": { - "type": "string", - "format": "email" - }, - "#\/definitions\/columnEnum": { - "type": "string", - "format": "enum" - }, - "#\/definitions\/columnUrl": { - "type": "string", - "format": "url" - }, - "#\/definitions\/columnIp": { - "type": "string", - "format": "ip" - }, - "#\/definitions\/columnDatetime": { - "type": "datetime" - }, - "#\/definitions\/columnRelationship": { - "type": "relationship" - }, - "#\/definitions\/columnPoint": { - "type": "point" - }, - "#\/definitions\/columnLine": { - "type": "linestring" - }, - "#\/definitions\/columnPolygon": { - "type": "polygon" - }, - "#\/definitions\/columnVarchar": { - "type": "varchar" - }, - "#\/definitions\/columnText": { - "type": "text" - }, - "#\/definitions\/columnMediumtext": { - "type": "mediumtext" - }, - "#\/definitions\/columnLongtext": { - "type": "longtext" - }, - "#\/definitions\/columnString": { - "type": "string" - } - } - } - }, - "x-example": "" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": [ + 0, + 0 + ], + "x-nullable": true } }, "required": [ - "total", - "columns" + "key", + "type", + "status", + "error", + "required", + "$createdAt", + "$updatedAt" ], "example": { - "total": 5, - "columns": "" + "key": "fullName", + "type": "string", + "status": "available", + "error": "string", + "required": true, + "array": false, + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "default": [ + 0, + 0 + ] } }, - "columnString": { - "description": "ColumnString", + "columnLine": { + "description": "ColumnLine", "type": "object", "properties": { "key": { @@ -55817,22 +61993,19 @@ "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Column size.", - "x-example": 128, - "format": "int32" - }, "default": { - "type": "string", + "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "x-nullable": true } }, @@ -55843,8 +62016,7 @@ "error", "required", "$createdAt", - "$updatedAt", - "size" + "$updatedAt" ], "example": { "key": "fullName", @@ -55855,24 +62027,31 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "columnInteger": { - "description": "ColumnInteger", + "columnPolygon": { + "description": "ColumnPolygon", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "count" + "x-example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "integer" + "x-example": "string" }, "status": { "type": "string", @@ -55913,25 +62092,31 @@ "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "min": { - "type": "integer", - "description": "Minimum value to enforce for new documents.", - "x-example": 1, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value to enforce for new documents.", - "x-example": 10, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", + "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 10, - "format": "int32", + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "x-nullable": true } }, @@ -55945,32 +62130,51 @@ "$updatedAt" ], "example": { - "key": "count", - "type": "integer", + "key": "fullName", + "type": "string", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "min": 1, - "max": 10, - "default": 10 + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, - "columnFloat": { - "description": "ColumnFloat", + "columnVarchar": { + "description": "ColumnVarchar", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "percentageCompleted" + "x-example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "double" + "x-example": "string" }, "status": { "type": "string", @@ -56011,25 +62215,22 @@ "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "min": { - "type": "number", - "description": "Minimum value to enforce for new documents.", - "x-example": 1.5, - "format": "double", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, - "format": "double", - "x-nullable": true + "size": { + "type": "integer", + "description": "Column size.", + "x-example": 128, + "format": "int32" }, "default": { - "type": "number", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 2.5, - "format": "double", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, "x-nullable": true } }, @@ -56040,35 +62241,36 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "size" ], "example": { - "key": "percentageCompleted", - "type": "double", + "key": "fullName", + "type": "string", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "min": 1.5, - "max": 10.5, - "default": 2.5 + "size": 128, + "default": "default", + "encrypt": false } }, - "columnBoolean": { - "description": "ColumnBoolean", + "columnText": { + "description": "ColumnText", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "isEnabled" + "x-example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "boolean" + "x-example": "string" }, "status": { "type": "string", @@ -56110,8 +62312,14 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "boolean", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", "x-example": false, "x-nullable": true } @@ -56126,25 +62334,26 @@ "$updatedAt" ], "example": { - "key": "isEnabled", - "type": "boolean", + "key": "fullName", + "type": "string", "status": "available", "error": "string", "required": true, "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": false + "default": "default", + "encrypt": false } }, - "columnEmail": { - "description": "ColumnEmail", + "columnMediumtext": { + "description": "ColumnMediumtext", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "userEmail" + "x-example": "fullName" }, "type": { "type": "string", @@ -56190,15 +62399,16 @@ "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "email" - }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default@example.com", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, "x-nullable": true } }, @@ -56209,11 +62419,10 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "userEmail", + "key": "fullName", "type": "string", "status": "available", "error": "string", @@ -56221,18 +62430,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "email", - "default": "default@example.com" + "default": "default", + "encrypt": false } }, - "columnEnum": { - "description": "ColumnEnum", + "columnLongtext": { + "description": "ColumnLongtext", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "status" + "x-example": "fullName" }, "type": { "type": "string", @@ -56278,23 +62487,16 @@ "description": "Column update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "elements": { - "type": "array", - "description": "Array of elements in enumerated type.", - "items": { - "type": "string" - }, - "x-example": "element" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "enum" - }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, "x-nullable": true } }, @@ -56305,12 +62507,10 @@ "error", "required", "$createdAt", - "$updatedAt", - "elements", - "format" + "$updatedAt" ], "example": { - "key": "status", + "key": "fullName", "type": "string", "status": "available", "error": "string", @@ -56318,28 +62518,42 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "elements": "element", - "format": "enum", - "default": "element" + "default": "default", + "encrypt": false } }, - "columnIp": { - "description": "ColumnIP", + "index": { + "description": "Index", "type": "object", "properties": { + "$id": { + "type": "string", + "description": "Index ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { + "type": "string", + "description": "Index creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Index update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, "key": { "type": "string", - "description": "Column Key.", - "x-example": "ipAddress" + "description": "Index key.", + "x-example": "index1" }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Index type.", + "x-example": "primary" }, "status": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", "x-example": "available", "enum": [ "available", @@ -56347,1659 +62561,1665 @@ "deleting", "stuck", "failed" - ], - "x-enum-name": "ColumnStatus" + ] }, "error": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", "x-example": "string" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "attributes": { + "type": "array", + "description": "Index attributes.", + "items": { + "type": "string" + }, + "x-example": [] }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, + "lengths": { + "type": "array", + "description": "Index attributes length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], "x-nullable": true + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "key", + "type", + "status", + "error", + "attributes", + "lengths" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "key": "index1", + "type": "primary", + "status": "available", + "error": "string", + "attributes": [], + "lengths": [], + "orders": [] + } + }, + "columnIndex": { + "description": "Index", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Index ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Index creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Index update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "format": { + "key": { "type": "string", - "description": "String format.", - "x-example": "ip" + "description": "Index Key.", + "x-example": "index1" }, - "default": { + "type": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", + "description": "Index type.", + "x-example": "primary" + }, + "status": { + "type": "string", + "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", + "x-example": "available" + }, + "error": { + "type": "string", + "description": "Error message. Displays error generated on failure of creating or deleting an index.", + "x-example": "string" + }, + "columns": { + "type": "array", + "description": "Index columns.", + "items": { + "type": "string" + }, + "x-example": [] + }, + "lengths": { + "type": "array", + "description": "Index columns length.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-example": [] + }, + "orders": { + "type": "array", + "description": "Index orders.", + "items": { + "type": "string" + }, + "x-example": [], "x-nullable": true } }, "required": [ + "$id", + "$createdAt", + "$updatedAt", "key", "type", "status", "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "columns", + "lengths" ], "example": { - "key": "ipAddress", - "type": "string", + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "key": "index1", + "type": "primary", "status": "available", "error": "string", - "required": true, - "array": false, + "columns": [], + "lengths": [], + "orders": [] + } + }, + "row": { + "description": "Row", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Row ID.", + "x-example": "5e5ea5c16897e" + }, + "$sequence": { + "type": "string", + "description": "Row sequence ID.", + "x-example": "1", + "readOnly": true + }, + "$tableId": { + "type": "string", + "description": "Table ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true + }, + "$databaseId": { + "type": "string", + "description": "Database ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true + }, + "$createdAt": { + "type": "string", + "description": "Row creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Row update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$tableId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ], + "example": { + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$tableId": "5e5ea5c15117e", + "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "ip", - "default": "192.0.2.0" + "$permissions": [ + "read(\"any\")" + ] } }, - "columnUrl": { - "description": "ColumnURL", + "document": { + "description": "Document", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "githubUrl" + "description": "Document ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$sequence": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Document sequence ID.", + "x-example": "1", + "readOnly": true }, - "status": { + "$collectionId": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Collection ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, - "error": { + "$databaseId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "Database ID.", + "x-example": "5e5ea5c15117e", + "readOnly": true }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "$createdAt": { + "type": "string", + "description": "Document creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Document update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$permissions": { + "type": "array", + "description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "items": { + "type": "string" + }, + "x-example": [ + "read(\"any\")" + ] + } + }, + "additionalProperties": true, + "required": [ + "$id", + "$sequence", + "$collectionId", + "$databaseId", + "$createdAt", + "$updatedAt", + "$permissions" + ], + "example": { + "$id": "5e5ea5c16897e", + "$sequence": "1", + "$collectionId": "5e5ea5c15117e", + "$databaseId": "5e5ea5c15117e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "read(\"any\")" + ], + "username": "john.doe", + "email": "john.doe@example.com", + "fullName": "John Doe", + "age": 30, + "isAdmin": false + } + }, + "log": { + "description": "Log", + "type": "object", + "properties": { + "event": { + "type": "string", + "description": "Event name.", + "x-example": "account.sessions.create" + }, + "userId": { + "type": "string", + "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", + "x-example": "610fc2f985ee0" + }, + "userEmail": { + "type": "string", + "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", + "x-example": "john@appwrite.io" + }, + "userName": { + "type": "string", + "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", + "x-example": "John Doe" + }, + "mode": { + "type": "string", + "description": "API mode when event triggered.", + "x-example": "admin" + }, + "userType": { + "type": "string", + "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", + "x-example": "user" + }, + "ip": { + "type": "string", + "description": "IP session in use when the session was created.", + "x-example": "127.0.0.1" + }, + "time": { + "type": "string", + "description": "Log creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "osCode": { + "type": "string", + "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", + "x-example": "Mac" + }, + "osName": { + "type": "string", + "description": "Operating system name.", + "x-example": "Mac" + }, + "osVersion": { + "type": "string", + "description": "Operating system version.", + "x-example": "Mac" + }, + "clientType": { + "type": "string", + "description": "Client type.", + "x-example": "browser" + }, + "clientCode": { + "type": "string", + "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", + "x-example": "CM" + }, + "clientName": { + "type": "string", + "description": "Client name.", + "x-example": "Chrome Mobile iOS" + }, + "clientVersion": { + "type": "string", + "description": "Client version.", + "x-example": "84.0" + }, + "clientEngine": { + "type": "string", + "description": "Client engine name.", + "x-example": "WebKit" + }, + "clientEngineVersion": { + "type": "string", + "description": "Client engine name.", + "x-example": "605.1.15" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "deviceName": { + "type": "string", + "description": "Device name.", + "x-example": "smartphone" }, - "$createdAt": { + "deviceBrand": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Device brand name.", + "x-example": "Google" }, - "$updatedAt": { + "deviceModel": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Device model name.", + "x-example": "Nexus 5" }, - "format": { + "countryCode": { "type": "string", - "description": "String format.", - "x-example": "url" + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" }, - "default": { + "countryName": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "x-nullable": true + "description": "Country name.", + "x-example": "United States" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" + "event", + "userId", + "userEmail", + "userName", + "mode", + "userType", + "ip", + "time", + "osCode", + "osName", + "osVersion", + "clientType", + "clientCode", + "clientName", + "clientVersion", + "clientEngine", + "clientEngineVersion", + "deviceName", + "deviceBrand", + "deviceModel", + "countryCode", + "countryName" ], "example": { - "key": "githubUrl", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "url", - "default": "https:\/\/example.com" + "event": "account.sessions.create", + "userId": "610fc2f985ee0", + "userEmail": "john@appwrite.io", + "userName": "John Doe", + "mode": "admin", + "userType": "user", + "ip": "127.0.0.1", + "time": "2020-10-15T06:38:00.000+00:00", + "osCode": "Mac", + "osName": "Mac", + "osVersion": "Mac", + "clientType": "browser", + "clientCode": "CM", + "clientName": "Chrome Mobile iOS", + "clientVersion": "84.0", + "clientEngine": "WebKit", + "clientEngineVersion": "605.1.15", + "deviceName": "smartphone", + "deviceBrand": "Google", + "deviceModel": "Nexus 5", + "countryCode": "US", + "countryName": "United States" } }, - "columnDatetime": { - "description": "ColumnDatetime", + "user": { + "description": "User", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "birthDay" - }, - "type": { - "type": "string", - "description": "Column type.", - "x-example": "datetime" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { + "$id": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "User ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "User creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "User update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "format": { + "name": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "User name.", + "x-example": "John Doe" }, - "default": { + "password": { "type": "string", - "description": "Default value for column when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "description": "Hashed user password.", + "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", "x-nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "format" - ], - "example": { - "key": "birthDay", - "type": "datetime", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "format": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" - } - }, - "columnRelationship": { - "description": "ColumnRelationship", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" }, - "type": { + "hash": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Password hashing algorithm.", + "x-example": "argon2", + "x-nullable": true }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "hashOptions": { + "type": "object", + "description": "Password hashing algorithm configuration.", + "x-example": {}, + "items": { + "x-oneOf": [ + { + "$ref": "#\/definitions\/algoArgon2" + }, + { + "$ref": "#\/definitions\/algoScrypt" + }, + { + "$ref": "#\/definitions\/algoScryptModified" + }, + { + "$ref": "#\/definitions\/algoBcrypt" + }, + { + "$ref": "#\/definitions\/algoPhpass" + }, + { + "$ref": "#\/definitions\/algoSha" + }, + { + "$ref": "#\/definitions\/algoMd5" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/definitions\/algoArgon2", + "scrypt": "#\/definitions\/algoScrypt", + "scryptMod": "#\/definitions\/algoScryptModified", + "bcrypt": "#\/definitions\/algoBcrypt", + "phpass": "#\/definitions\/algoPhpass", + "sha": "#\/definitions\/algoSha", + "md5": "#\/definitions\/algoMd5" + } + } + }, + "x-nullable": true }, - "error": { + "registration": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User registration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "required": { + "status": { "type": "boolean", - "description": "Is column required?", + "description": "User status. Pass `true` for enabled and `false` for disabled.", "x-example": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "labels": { + "type": "array", + "description": "Labels for the user.", + "items": { + "type": "string" + }, + "x-example": [ + "vip" + ] }, - "$createdAt": { + "passwordUpdate": { "type": "string", - "description": "Column creation date in ISO 8601 format.", + "description": "Password update time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$updatedAt": { + "email": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "User email address.", + "x-example": "john@appwrite.io" }, - "relatedTable": { + "phone": { "type": "string", - "description": "The ID of the related table.", - "x-example": "table" + "description": "User phone number in E.164 format.", + "x-example": "+4930901820" }, - "relationType": { - "type": "string", - "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + "emailVerification": { + "type": "boolean", + "description": "Email verification status.", + "x-example": true }, - "twoWay": { + "phoneVerification": { "type": "boolean", - "description": "Is the relationship two-way?", - "x-example": false + "description": "Phone verification status.", + "x-example": true }, - "twoWayKey": { - "type": "string", - "description": "The key of the two-way relationship.", - "x-example": "string" + "mfa": { + "type": "boolean", + "description": "Multi factor authentication status.", + "x-example": true }, - "onDelete": { + "prefs": { + "type": "object", + "description": "User preferences as a key-value object", + "x-example": { + "theme": "pink", + "timezone": "UTC" + }, + "items": { + "type": "object", + "$ref": "#\/definitions\/preferences" + } + }, + "targets": { + "type": "array", + "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", + "items": { + "type": "object", + "$ref": "#\/definitions\/target" + }, + "x-example": [] + }, + "accessedAt": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "side": { + "impersonator": { + "type": "boolean", + "description": "Whether the user can impersonate other users.", + "x-example": false, + "x-nullable": true + }, + "impersonatorUserId": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", + "x-example": "5e5ea5c16897e", + "x-nullable": true } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", "$updatedAt", - "relatedTable", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "name", + "registration", + "status", + "labels", + "passwordUpdate", + "email", + "phone", + "emailVerification", + "phoneVerification", + "mfa", + "prefs", + "targets", + "accessedAt" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "relatedTable": "table", - "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", - "twoWay": false, - "twoWayKey": "string", - "onDelete": "restrict|cascade|setNull", - "side": "parent|child" + "name": "John Doe", + "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "hash": "argon2", + "hashOptions": {}, + "registration": "2020-10-15T06:38:00.000+00:00", + "status": true, + "labels": [ + "vip" + ], + "passwordUpdate": "2020-10-15T06:38:00.000+00:00", + "email": "john@appwrite.io", + "phone": "+4930901820", + "emailVerification": true, + "phoneVerification": true, + "mfa": true, + "prefs": { + "theme": "pink", + "timezone": "UTC" + }, + "targets": [], + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "impersonator": false, + "impersonatorUserId": "5e5ea5c16897e" } }, - "columnPoint": { - "description": "ColumnPoint", + "algoMd5": { + "description": "AlgoMD5", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { + "description": "Algo type.", + "x-example": "md5" + } + }, + "required": [ + "type" + ], + "example": { + "type": "md5" + } + }, + "algoSha": { + "description": "AlgoSHA", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { + "description": "Algo type.", + "x-example": "sha" + } + }, + "required": [ + "type" + ], + "example": { + "type": "sha" + } + }, + "algoPhpass": { + "description": "AlgoPHPass", + "type": "object", + "properties": { + "type": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - 0, - 0 - ], - "x-nullable": true + "description": "Algo type.", + "x-example": "phpass" + } + }, + "required": [ + "type" + ], + "example": { + "type": "phpass" + } + }, + "algoBcrypt": { + "description": "AlgoBcrypt", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Algo type.", + "x-example": "bcrypt" } }, "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "type" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "type": "bcrypt" } }, - "columnLine": { - "description": "ColumnLine", + "algoScrypt": { + "description": "AlgoScrypt", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "description": "Algo type.", + "x-example": "scrypt" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "costCpu": { + "type": "integer", + "description": "CPU complexity of computed hash.", + "x-example": 8, + "format": "int32" }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "costMemory": { + "type": "integer", + "description": "Memory complexity of computed hash.", + "x-example": 14, + "format": "int32" }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "costParallel": { + "type": "integer", + "description": "Parallelization of computed hash.", + "x-example": 1, + "format": "int32" }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], - "x-nullable": true + "length": { + "type": "integer", + "description": "Length used to compute hash.", + "x-example": 64, + "format": "int32" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "costCpu", + "costMemory", + "costParallel", + "length" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ] + "type": "scrypt", + "costCpu": 8, + "costMemory": 14, + "costParallel": 1, + "length": 64 } }, - "columnPolygon": { - "description": "ColumnPolygon", + "algoScryptModified": { + "description": "AlgoScryptModified", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Algo type.", + "x-example": "scryptMod" }, - "error": { + "salt": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "description": "Salt used to compute hash.", + "x-example": "UxLMreBr6tYyjQ==" }, - "$createdAt": { + "saltSeparator": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Separator used to compute hash.", + "x-example": "Bw==" }, - "$updatedAt": { + "signerKey": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "default": { - "type": "array", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ], - "x-nullable": true + "description": "Key used to compute hash.", + "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" + "salt", + "saltSeparator", + "signerKey" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "type": "scryptMod", + "salt": "UxLMreBr6tYyjQ==", + "saltSeparator": "Bw==", + "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, - "columnVarchar": { - "description": "ColumnVarchar", + "algoArgon2": { + "description": "AlgoArgon2", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "x-example": "fullName" - }, "type": { "type": "string", - "description": "Column type.", - "x-example": "string" - }, - "status": { - "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "error": { - "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true - }, - "$createdAt": { - "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Algo type.", + "x-example": "argon2" }, - "size": { + "memoryCost": { "type": "integer", - "description": "Column size.", - "x-example": 128, + "description": "Memory used to compute hash.", + "x-example": 65536, "format": "int32" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true + "timeCost": { + "type": "integer", + "description": "Amount of time consumed to compute hash", + "x-example": 4, + "format": "int32" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true + "threads": { + "type": "integer", + "description": "Number of threads used to compute hash.", + "x-example": 3, + "format": "int32" } }, "required": [ - "key", "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt", - "size" + "memoryCost", + "timeCost", + "threads" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "size": 128, - "default": "default", - "encrypt": false + "type": "argon2", + "memoryCost": 65536, + "timeCost": 4, + "threads": 3 } }, - "columnText": { - "description": "ColumnText", + "preferences": { + "description": "Preferences", + "type": "object", + "additionalProperties": true, + "example": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } + }, + "session": { + "description": "Session", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Session ID.", + "x-example": "5e5ea5c16897e" }, - "type": { + "$createdAt": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Session creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "status": { + "$updatedAt": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Session update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "error": { + "userId": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "User ID.", + "x-example": "5e5bb8c16897e" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "expire": { + "type": "string", + "description": "Session expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "provider": { + "type": "string", + "description": "Session Provider.", + "x-example": "email" }, - "$createdAt": { + "providerUid": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Session Provider User ID.", + "x-example": "user@example.com" }, - "$updatedAt": { + "providerAccessToken": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Session Provider Access Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + }, + "providerAccessTokenExpiry": { + "type": "string", + "description": "The date of when the access token expires in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "default": { + "providerRefreshToken": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true + "description": "Session Provider Refresh Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" - ], - "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false - } - }, - "columnMediumtext": { - "description": "ColumnMediumtext", - "type": "object", - "properties": { - "key": { + "ip": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "IP in use when the session was created.", + "x-example": "127.0.0.1" }, - "type": { + "osCode": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", + "x-example": "Mac" + }, + "osName": { + "type": "string", + "description": "Operating system name.", + "x-example": "Mac" + }, + "osVersion": { + "type": "string", + "description": "Operating system version.", + "x-example": "Mac" }, - "status": { + "clientType": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Client type.", + "x-example": "browser" }, - "error": { + "clientCode": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", + "x-example": "CM" }, - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": true + "clientName": { + "type": "string", + "description": "Client name.", + "x-example": "Chrome Mobile iOS" }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "clientVersion": { + "type": "string", + "description": "Client version.", + "x-example": "84.0" }, - "$createdAt": { + "clientEngine": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Client engine name.", + "x-example": "WebKit" }, - "$updatedAt": { + "clientEngineVersion": { "type": "string", - "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Client engine name.", + "x-example": "605.1.15" }, - "default": { + "deviceName": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true + "description": "Device name.", + "x-example": "smartphone" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true - } - }, - "required": [ - "key", - "type", - "status", - "error", - "required", - "$createdAt", - "$updatedAt" - ], - "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false - } - }, - "columnLongtext": { - "description": "ColumnLongtext", - "type": "object", - "properties": { - "key": { + "deviceBrand": { "type": "string", - "description": "Column Key.", - "x-example": "fullName" + "description": "Device brand name.", + "x-example": "Google" }, - "type": { + "deviceModel": { "type": "string", - "description": "Column type.", - "x-example": "string" + "description": "Device model name.", + "x-example": "Nexus 5" }, - "status": { + "countryCode": { "type": "string", - "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" + "description": "Country two-character ISO 3166-1 alpha code.", + "x-example": "US" }, - "error": { + "countryName": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "description": "Country name.", + "x-example": "United States" }, - "required": { + "current": { "type": "boolean", - "description": "Is column required?", + "description": "Returns true if this the current user session.", "x-example": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false, - "x-nullable": true + "factors": { + "type": "array", + "description": "Returns a list of active session factors.", + "items": { + "type": "string" + }, + "x-example": [ + "email" + ] }, - "$createdAt": { + "secret": { "type": "string", - "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Secret used to authenticate the user. Only included if the request was made with an API key", + "x-example": "5e5bb8c16897e" }, - "$updatedAt": { + "mfaUpdatedAt": { "type": "string", - "description": "Column update date in ISO 8601 format.", + "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true } }, "required": [ - "key", - "type", - "status", - "error", - "required", + "$id", "$createdAt", - "$updatedAt" + "$updatedAt", + "userId", + "expire", + "provider", + "providerUid", + "providerAccessToken", + "providerAccessTokenExpiry", + "providerRefreshToken", + "ip", + "osCode", + "osName", + "osVersion", + "clientType", + "clientCode", + "clientName", + "clientVersion", + "clientEngine", + "clientEngineVersion", + "deviceName", + "deviceBrand", + "deviceModel", + "countryCode", + "countryName", + "current", + "factors", + "secret", + "mfaUpdatedAt" ], "example": { - "key": "fullName", - "type": "string", - "status": "available", - "error": "string", - "required": true, - "array": false, + "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "userId": "5e5bb8c16897e", + "expire": "2020-10-15T06:38:00.000+00:00", + "provider": "email", + "providerUid": "user@example.com", + "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", + "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "ip": "127.0.0.1", + "osCode": "Mac", + "osName": "Mac", + "osVersion": "Mac", + "clientType": "browser", + "clientCode": "CM", + "clientName": "Chrome Mobile iOS", + "clientVersion": "84.0", + "clientEngine": "WebKit", + "clientEngineVersion": "605.1.15", + "deviceName": "smartphone", + "deviceBrand": "Google", + "deviceModel": "Nexus 5", + "countryCode": "US", + "countryName": "United States", + "current": true, + "factors": [ + "email" + ], + "secret": "5e5bb8c16897e", + "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "index": { - "description": "Index", + "identity": { + "description": "Identity", "type": "object", "properties": { "$id": { "type": "string", - "description": "Index ID.", + "description": "Identity ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Index creation date in ISO 8601 format.", + "description": "Identity creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Index update date in ISO 8601 format.", + "description": "Identity update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "key": { + "userId": { "type": "string", - "description": "Index key.", - "x-example": "index1" + "description": "User ID.", + "x-example": "5e5bb8c16897e" }, - "type": { + "provider": { "type": "string", - "description": "Index type.", - "x-example": "primary" + "description": "Identity Provider.", + "x-example": "email" }, - "status": { + "providerUid": { "type": "string", - "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ] + "description": "ID of the User in the Identity Provider.", + "x-example": "5e5bb8c16897e" }, - "error": { + "providerEmail": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "description": "Email of the User in the Identity Provider.", + "x-example": "user@example.com" }, - "attributes": { - "type": "array", - "description": "Index attributes.", - "items": { - "type": "string" - }, - "x-example": [] + "providerAccessToken": { + "type": "string", + "description": "Identity Provider Access Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, - "lengths": { - "type": "array", - "description": "Index attributes length.", - "items": { - "type": "integer", - "format": "int32" - }, - "x-example": [] + "providerAccessTokenExpiry": { + "type": "string", + "description": "The date of when the access token expires in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "orders": { - "type": "array", - "description": "Index orders.", - "items": { - "type": "string" - }, - "x-example": [], - "x-nullable": true + "providerRefreshToken": { + "type": "string", + "description": "Identity Provider Refresh Token.", + "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "key", - "type", - "status", - "error", - "attributes", - "lengths" + "userId", + "provider", + "providerUid", + "providerEmail", + "providerAccessToken", + "providerAccessTokenExpiry", + "providerRefreshToken" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "key": "index1", - "type": "primary", - "status": "available", - "error": "string", - "attributes": [], - "lengths": [], - "orders": [] + "userId": "5e5bb8c16897e", + "provider": "email", + "providerUid": "5e5bb8c16897e", + "providerEmail": "user@example.com", + "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", + "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, - "columnIndex": { - "description": "Index", + "token": { + "description": "Token", "type": "object", "properties": { "$id": { "type": "string", - "description": "Index ID.", - "x-example": "5e5ea5c16897e" + "description": "Token ID.", + "x-example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Index creation date in ISO 8601 format.", + "description": "Token creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$updatedAt": { + "userId": { "type": "string", - "description": "Index update date in ISO 8601 format.", + "description": "User ID.", + "x-example": "5e5ea5c168bb8" + }, + "secret": { + "type": "string", + "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" + }, + "expire": { + "type": "string", + "description": "Token expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "key": { + "phrase": { "type": "string", - "description": "Index Key.", - "x-example": "index1" + "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", + "x-example": "Golden Fox" + } + }, + "required": [ + "$id", + "$createdAt", + "userId", + "secret", + "expire", + "phrase" + ], + "example": { + "$id": "bb8ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5ea5c168bb8", + "secret": "", + "expire": "2020-10-15T06:38:00.000+00:00", + "phrase": "Golden Fox" + } + }, + "jwt": { + "description": "JWT", + "type": "object", + "properties": { + "jwt": { + "type": "string", + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + }, + "required": [ + "jwt" + ], + "example": { + "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + }, + "locale": { + "description": "Locale", + "type": "object", + "properties": { + "ip": { + "type": "string", + "description": "User IP address.", + "x-example": "127.0.0.1" }, - "type": { + "countryCode": { "type": "string", - "description": "Index type.", - "x-example": "primary" + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", + "x-example": "US" }, - "status": { + "country": { "type": "string", - "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available" + "description": "Country name. This field support localization.", + "x-example": "United States" }, - "error": { + "continentCode": { "type": "string", - "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", + "x-example": "NA" }, - "columns": { - "type": "array", - "description": "Index columns.", - "items": { - "type": "string" - }, - "x-example": [] + "continent": { + "type": "string", + "description": "Continent name. This field support localization.", + "x-example": "North America" }, - "lengths": { - "type": "array", - "description": "Index columns length.", - "items": { - "type": "integer", - "format": "int32" - }, - "x-example": [] + "eu": { + "type": "boolean", + "description": "True if country is part of the European Union.", + "x-example": false }, - "orders": { - "type": "array", - "description": "Index orders.", - "items": { - "type": "string" - }, - "x-example": [], - "x-nullable": true + "currency": { + "type": "string", + "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", + "x-example": "USD" } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "key", - "type", - "status", - "error", - "columns", - "lengths" + "ip", + "countryCode", + "country", + "continentCode", + "continent", + "eu", + "currency" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "key": "index1", - "type": "primary", - "status": "available", - "error": "string", - "columns": [], - "lengths": [], - "orders": [] + "ip": "127.0.0.1", + "countryCode": "US", + "country": "United States", + "continentCode": "NA", + "continent": "North America", + "eu": false, + "currency": "USD" + } + }, + "localeCode": { + "description": "LocaleCode", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", + "x-example": "en-us" + }, + "name": { + "type": "string", + "description": "Locale name", + "x-example": "US" + } + }, + "required": [ + "code", + "name" + ], + "example": { + "code": "en-us", + "name": "US" } }, - "row": { - "description": "Row", + "file": { + "description": "File", "type": "object", "properties": { "$id": { "type": "string", - "description": "Row ID.", + "description": "File ID.", "x-example": "5e5ea5c16897e" }, - "$sequence": { - "type": "string", - "description": "Row sequence ID.", - "x-example": "1", - "readOnly": true - }, - "$tableId": { - "type": "string", - "description": "Table ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true - }, - "$databaseId": { + "bucketId": { "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "description": "Bucket ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Row creation date in ISO 8601 format.", + "description": "File creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Row update date in ISO 8601 format.", + "description": "File update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", - "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "items": { "type": "string" }, "x-example": [ "read(\"any\")" ] + }, + "name": { + "type": "string", + "description": "File name.", + "x-example": "Pink.png" + }, + "signature": { + "type": "string", + "description": "File MD5 signature.", + "x-example": "5d529fd02b544198ae075bd57c1762bb" + }, + "mimeType": { + "type": "string", + "description": "File mime type.", + "x-example": "image\/png" + }, + "sizeOriginal": { + "type": "integer", + "description": "File original size in bytes.", + "x-example": 17890, + "format": "int32" + }, + "chunksTotal": { + "type": "integer", + "description": "Total number of chunks available", + "x-example": 17890, + "format": "int32" + }, + "chunksUploaded": { + "type": "integer", + "description": "Total number of chunks uploaded", + "x-example": 17890, + "format": "int32" + }, + "encryption": { + "type": "boolean", + "description": "Whether file contents are encrypted at rest.", + "x-example": true + }, + "compression": { + "type": "string", + "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", + "x-example": "gzip" } }, - "additionalProperties": true, "required": [ "$id", - "$sequence", - "$tableId", - "$databaseId", + "bucketId", "$createdAt", "$updatedAt", - "$permissions" + "$permissions", + "name", + "signature", + "mimeType", + "sizeOriginal", + "chunksTotal", + "chunksUploaded", + "encryption", + "compression" ], "example": { "$id": "5e5ea5c16897e", - "$sequence": "1", - "$tableId": "5e5ea5c15117e", - "$databaseId": "5e5ea5c15117e", + "bucketId": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "$permissions": [ "read(\"any\")" - ] + ], + "name": "Pink.png", + "signature": "5d529fd02b544198ae075bd57c1762bb", + "mimeType": "image\/png", + "sizeOriginal": 17890, + "chunksTotal": 17890, + "chunksUploaded": 17890, + "encryption": true, + "compression": "gzip" } }, - "document": { - "description": "Document", + "bucket": { + "description": "Bucket", "type": "object", "properties": { "$id": { "type": "string", - "description": "Document ID.", + "description": "Bucket ID.", "x-example": "5e5ea5c16897e" }, - "$sequence": { - "type": "string", - "description": "Document sequence ID.", - "x-example": "1", - "readOnly": true - }, - "$collectionId": { - "type": "string", - "description": "Collection ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true - }, - "$databaseId": { - "type": "string", - "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true - }, "$createdAt": { "type": "string", - "description": "Document creation date in ISO 8601 format.", + "description": "Bucket creation time in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Document update date in ISO 8601 format.", + "description": "Bucket update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", - "description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "items": { "type": "string" }, "x-example": [ "read(\"any\")" ] + }, + "fileSecurity": { + "type": "boolean", + "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": true + }, + "name": { + "type": "string", + "description": "Bucket name.", + "x-example": "Documents" + }, + "enabled": { + "type": "boolean", + "description": "Bucket enabled.", + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size supported.", + "x-example": 100, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions.", + "items": { + "type": "string" + }, + "x-example": [ + "jpg", + "png" + ] + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", + "x-example": "gzip" + }, + "encryption": { + "type": "boolean", + "description": "Bucket is encrypted.", + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Virus scanning is enabled.", + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Image transformations are enabled.", + "x-example": false + }, + "totalSize": { + "type": "integer", + "description": "Total size of this bucket in bytes.", + "x-example": 128, + "format": "int32" } }, - "additionalProperties": true, "required": [ "$id", - "$sequence", - "$collectionId", - "$databaseId", "$createdAt", "$updatedAt", - "$permissions" + "$permissions", + "fileSecurity", + "name", + "enabled", + "maximumFileSize", + "allowedFileExtensions", + "compression", + "encryption", + "antivirus", + "transformations", + "totalSize" ], "example": { "$id": "5e5ea5c16897e", - "$sequence": "1", - "$collectionId": "5e5ea5c15117e", - "$databaseId": "5e5ea5c15117e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", "$permissions": [ "read(\"any\")" ], - "username": "john.doe", - "email": "john.doe@example.com", - "fullName": "John Doe", - "age": 30, - "isAdmin": false + "fileSecurity": true, + "name": "Documents", + "enabled": false, + "maximumFileSize": 100, + "allowedFileExtensions": [ + "jpg", + "png" + ], + "compression": "gzip", + "encryption": false, + "antivirus": false, + "transformations": false, + "totalSize": 128 } }, - "log": { - "description": "Log", + "resourceToken": { + "description": "ResourceToken", "type": "object", "properties": { - "event": { - "type": "string", - "description": "Event name.", - "x-example": "account.sessions.create" - }, - "userId": { - "type": "string", - "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", - "x-example": "610fc2f985ee0" - }, - "userEmail": { - "type": "string", - "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "john@appwrite.io" - }, - "userName": { - "type": "string", - "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "John Doe" - }, - "mode": { - "type": "string", - "description": "API mode when event triggered.", - "x-example": "admin" - }, - "userType": { - "type": "string", - "description": "User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.", - "x-example": "user" - }, - "ip": { + "$id": { "type": "string", - "description": "IP session in use when the session was created.", - "x-example": "127.0.0.1" + "description": "Token ID.", + "x-example": "bb8ea5c16897e" }, - "time": { + "$createdAt": { "type": "string", - "description": "Log creation date in ISO 8601 format.", + "description": "Token creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "osCode": { - "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" - }, - "osName": { - "type": "string", - "description": "Operating system name.", - "x-example": "Mac" - }, - "osVersion": { - "type": "string", - "description": "Operating system version.", - "x-example": "Mac" - }, - "clientType": { - "type": "string", - "description": "Client type.", - "x-example": "browser" - }, - "clientCode": { - "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" - }, - "clientName": { - "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" - }, - "clientVersion": { - "type": "string", - "description": "Client version.", - "x-example": "84.0" - }, - "clientEngine": { - "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" - }, - "clientEngineVersion": { - "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" - }, - "deviceName": { + "resourceId": { "type": "string", - "description": "Device name.", - "x-example": "smartphone" + "description": "Resource ID.", + "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" }, - "deviceBrand": { + "resourceType": { "type": "string", - "description": "Device brand name.", - "x-example": "Google" + "description": "Resource type.", + "x-example": "files" }, - "deviceModel": { + "expire": { "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" + "description": "Token expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "countryCode": { + "secret": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "JWT encoded string.", + "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, - "countryName": { + "accessedAt": { "type": "string", - "description": "Country name.", - "x-example": "United States" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ - "event", - "userId", - "userEmail", - "userName", - "mode", - "userType", - "ip", - "time", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", - "countryCode", - "countryName" + "$id", + "$createdAt", + "resourceId", + "resourceType", + "expire", + "secret", + "accessedAt" ], "example": { - "event": "account.sessions.create", - "userId": "610fc2f985ee0", - "userEmail": "john@appwrite.io", - "userName": "John Doe", - "mode": "admin", - "userType": "user", - "ip": "127.0.0.1", - "time": "2020-10-15T06:38:00.000+00:00", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", - "countryCode": "US", - "countryName": "United States" + "$id": "bb8ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8", + "resourceType": "files", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "accessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "user": { - "description": "User", + "team": { + "description": "Team", "type": "object", "properties": { "$id": { "type": "string", - "description": "User ID.", + "description": "Team ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "User creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "User update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "name": { - "type": "string", - "description": "User name.", - "x-example": "John Doe" - }, - "password": { - "type": "string", - "description": "Hashed user password.", - "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", - "x-nullable": true - }, - "hash": { - "type": "string", - "description": "Password hashing algorithm.", - "x-example": "argon2", - "x-nullable": true - }, - "hashOptions": { - "type": "object", - "description": "Password hashing algorithm configuration.", - "x-example": {}, - "items": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/algoArgon2" - }, - { - "$ref": "#\/definitions\/algoScrypt" - }, - { - "$ref": "#\/definitions\/algoScryptModified" - }, - { - "$ref": "#\/definitions\/algoBcrypt" - }, - { - "$ref": "#\/definitions\/algoPhpass" - }, - { - "$ref": "#\/definitions\/algoSha" - }, - { - "$ref": "#\/definitions\/algoMd5" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/definitions\/algoArgon2", - "scrypt": "#\/definitions\/algoScrypt", - "scryptMod": "#\/definitions\/algoScryptModified", - "bcrypt": "#\/definitions\/algoBcrypt", - "phpass": "#\/definitions\/algoPhpass", - "sha": "#\/definitions\/algoSha", - "md5": "#\/definitions\/algoMd5" - } - } - }, - "x-nullable": true - }, - "registration": { - "type": "string", - "description": "User registration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "status": { - "type": "boolean", - "description": "User status. Pass `true` for enabled and `false` for disabled.", - "x-example": true - }, - "labels": { - "type": "array", - "description": "Labels for the user.", - "items": { - "type": "string" - }, - "x-example": [ - "vip" - ] - }, - "passwordUpdate": { - "type": "string", - "description": "Password update time in ISO 8601 format.", + "description": "Team creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "email": { + "$updatedAt": { "type": "string", - "description": "User email address.", - "x-example": "john@appwrite.io" + "description": "Team update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "phone": { + "name": { "type": "string", - "description": "User phone number in E.164 format.", - "x-example": "+4930901820" - }, - "emailVerification": { - "type": "boolean", - "description": "Email verification status.", - "x-example": true - }, - "phoneVerification": { - "type": "boolean", - "description": "Phone verification status.", - "x-example": true + "description": "Team name.", + "x-example": "VIP" }, - "mfa": { - "type": "boolean", - "description": "Multi factor authentication status.", - "x-example": true + "total": { + "type": "integer", + "description": "Total number of team members.", + "x-example": 7, + "format": "int32" }, "prefs": { "type": "object", - "description": "User preferences as a key-value object", + "description": "Team preferences as a key-value object", "x-example": { "theme": "pink", "timezone": "UTC" @@ -58008,32 +64228,6 @@ "type": "object", "$ref": "#\/definitions\/preferences" } - }, - "targets": { - "type": "array", - "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", - "items": { - "type": "object", - "$ref": "#\/definitions\/target" - }, - "x-example": [] - }, - "accessedAt": { - "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "impersonator": { - "type": "boolean", - "description": "Whether the user can impersonate other users.", - "x-example": false, - "x-nullable": true - }, - "impersonatorUserId": { - "type": "string", - "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", - "x-example": "5e5ea5c16897e", - "x-nullable": true } }, "required": [ @@ -58041,1349 +64235,1921 @@ "$createdAt", "$updatedAt", "name", - "registration", - "status", - "labels", - "passwordUpdate", - "email", - "phone", - "emailVerification", - "phoneVerification", - "mfa", - "prefs", - "targets", - "accessedAt" + "total", + "prefs" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "John Doe", - "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", - "hash": "argon2", - "hashOptions": {}, - "registration": "2020-10-15T06:38:00.000+00:00", - "status": true, - "labels": [ - "vip" - ], - "passwordUpdate": "2020-10-15T06:38:00.000+00:00", - "email": "john@appwrite.io", - "phone": "+4930901820", - "emailVerification": true, - "phoneVerification": true, - "mfa": true, + "name": "VIP", + "total": 7, "prefs": { "theme": "pink", "timezone": "UTC" - }, - "targets": [], - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "impersonator": false, - "impersonatorUserId": "5e5ea5c16897e" - } - }, - "algoMd5": { - "description": "AlgoMD5", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Algo type.", - "x-example": "md5" } - }, - "required": [ - "type" - ], - "example": { - "type": "md5" } }, - "algoSha": { - "description": "AlgoSHA", + "membership": { + "description": "Membership", "type": "object", "properties": { - "type": { + "$id": { "type": "string", - "description": "Algo type.", - "x-example": "sha" - } - }, - "required": [ - "type" - ], - "example": { - "type": "sha" - } - }, - "algoPhpass": { - "description": "AlgoPHPass", - "type": "object", - "properties": { - "type": { + "description": "Membership ID.", + "x-example": "5e5ea5c16897e" + }, + "$createdAt": { "type": "string", - "description": "Algo type.", - "x-example": "phpass" - } - }, - "required": [ - "type" - ], - "example": { - "type": "phpass" - } - }, - "algoBcrypt": { - "description": "AlgoBcrypt", - "type": "object", - "properties": { - "type": { + "description": "Membership creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { "type": "string", - "description": "Algo type.", - "x-example": "bcrypt" - } - }, - "required": [ - "type" - ], - "example": { - "type": "bcrypt" - } - }, - "algoScrypt": { - "description": "AlgoScrypt", - "type": "object", - "properties": { - "type": { + "description": "Membership update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "userId": { "type": "string", - "description": "Algo type.", - "x-example": "scrypt" + "description": "User ID.", + "x-example": "5e5ea5c16897e" }, - "costCpu": { - "type": "integer", - "description": "CPU complexity of computed hash.", - "x-example": 8, - "format": "int32" + "userName": { + "type": "string", + "description": "User name. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "John Doe" }, - "costMemory": { - "type": "integer", - "description": "Memory complexity of computed hash.", - "x-example": 14, - "format": "int32" + "userEmail": { + "type": "string", + "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "john@appwrite.io" }, - "costParallel": { - "type": "integer", - "description": "Parallelization of computed hash.", - "x-example": 1, - "format": "int32" + "userPhone": { + "type": "string", + "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", + "x-example": "+1 555 555 5555" }, - "length": { - "type": "integer", - "description": "Length used to compute hash.", - "x-example": 64, - "format": "int32" - } - }, - "required": [ - "type", - "costCpu", - "costMemory", - "costParallel", - "length" - ], - "example": { - "type": "scrypt", - "costCpu": 8, - "costMemory": 14, - "costParallel": 1, - "length": 64 - } - }, - "algoScryptModified": { - "description": "AlgoScryptModified", - "type": "object", - "properties": { - "type": { + "teamId": { "type": "string", - "description": "Algo type.", - "x-example": "scryptMod" + "description": "Team ID.", + "x-example": "5e5ea5c16897e" }, - "salt": { + "teamName": { "type": "string", - "description": "Salt used to compute hash.", - "x-example": "UxLMreBr6tYyjQ==" + "description": "Team name.", + "x-example": "VIP" }, - "saltSeparator": { + "invited": { "type": "string", - "description": "Separator used to compute hash.", - "x-example": "Bw==" + "description": "Date, the user has been invited to join the team in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "signerKey": { + "joined": { "type": "string", - "description": "Key used to compute hash.", - "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "confirm": { + "type": "boolean", + "description": "User confirmation status, true if the user has joined the team or false otherwise.", + "x-example": false + }, + "mfa": { + "type": "boolean", + "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", + "x-example": false + }, + "roles": { + "type": "array", + "description": "User list of roles", + "items": { + "type": "string" + }, + "x-example": [ + "owner" + ] } }, "required": [ - "type", - "salt", - "saltSeparator", - "signerKey" + "$id", + "$createdAt", + "$updatedAt", + "userId", + "userName", + "userEmail", + "userPhone", + "teamId", + "teamName", + "invited", + "joined", + "confirm", + "mfa", + "roles" ], "example": { - "type": "scryptMod", - "salt": "UxLMreBr6tYyjQ==", - "saltSeparator": "Bw==", - "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "userId": "5e5ea5c16897e", + "userName": "John Doe", + "userEmail": "john@appwrite.io", + "userPhone": "+1 555 555 5555", + "teamId": "5e5ea5c16897e", + "teamName": "VIP", + "invited": "2020-10-15T06:38:00.000+00:00", + "joined": "2020-10-15T06:38:00.000+00:00", + "confirm": false, + "mfa": false, + "roles": [ + "owner" + ] } }, - "algoArgon2": { - "description": "AlgoArgon2", + "site": { + "description": "Site", "type": "object", "properties": { - "type": { + "$id": { "type": "string", - "description": "Algo type.", - "x-example": "argon2" + "description": "Site ID.", + "x-example": "5e5ea5c16897e" }, - "memoryCost": { - "type": "integer", - "description": "Memory used to compute hash.", - "x-example": 65536, - "format": "int32" + "$createdAt": { + "type": "string", + "description": "Site creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "timeCost": { + "$updatedAt": { + "type": "string", + "description": "Site update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "name": { + "type": "string", + "description": "Site name.", + "x-example": "My Site" + }, + "enabled": { + "type": "boolean", + "description": "Site enabled.", + "x-example": false + }, + "live": { + "type": "boolean", + "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "x-example": false + }, + "framework": { + "type": "string", + "description": "Site framework.", + "x-example": "react" + }, + "deploymentRetention": { "type": "integer", - "description": "Amount of time consumed to compute hash", - "x-example": 4, + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, "format": "int32" }, - "threads": { + "deploymentId": { + "type": "string", + "description": "Site's active deployment ID.", + "x-example": "5e5ea5c16897e" + }, + "deploymentCreatedAt": { + "type": "string", + "description": "Active deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "deploymentScreenshotLight": { + "type": "string", + "description": "Screenshot of active deployment with light theme preference file ID.", + "x-example": "5e5ea5c16897e" + }, + "deploymentScreenshotDark": { + "type": "string", + "description": "Screenshot of active deployment with dark theme preference file ID.", + "x-example": "5e5ea5c16897e" + }, + "latestDeploymentId": { + "type": "string", + "description": "Site's latest deployment ID.", + "x-example": "5e5ea5c16897e" + }, + "latestDeploymentCreatedAt": { + "type": "string", + "description": "Latest deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "latestDeploymentStatus": { + "type": "string", + "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", + "x-example": "ready" + }, + "vars": { + "type": "array", + "description": "Site variables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/variable" + }, + "x-example": [] + }, + "timeout": { "type": "integer", - "description": "Number of threads used to compute hash.", - "x-example": 3, + "description": "Site request timeout in seconds.", + "x-example": 300, "format": "int32" + }, + "installCommand": { + "type": "string", + "description": "The install command used to install the site dependencies.", + "x-example": "npm install" + }, + "buildCommand": { + "type": "string", + "description": "The build command used to build the site.", + "x-example": "npm run build" + }, + "startCommand": { + "type": "string", + "description": "Custom command to use when starting site runtime.", + "x-example": "node custom-server.mjs" + }, + "outputDirectory": { + "type": "string", + "description": "The directory where the site build output is located.", + "x-example": "build" + }, + "installationId": { + "type": "string", + "description": "Site VCS (Version Control System) installation id.", + "x-example": "6m40at4ejk5h2u9s1hboo" + }, + "providerRepositoryId": { + "type": "string", + "description": "VCS (Version Control System) Repository ID", + "x-example": "appwrite" + }, + "providerBranch": { + "type": "string", + "description": "VCS (Version Control System) branch name", + "x-example": "main" + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site in VCS (Version Control System) repository", + "x-example": "sites\/helloWorld" + }, + "providerSilentMode": { + "type": "boolean", + "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", + "x-example": false + }, + "buildSpecification": { + "type": "string", + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" + }, + "runtimeSpecification": { + "type": "string", + "description": "Machine specification for SSR executions.", + "x-example": "s-1vcpu-512mb" + }, + "buildRuntime": { + "type": "string", + "description": "Site build runtime.", + "x-example": "node-22" + }, + "adapter": { + "type": "string", + "description": "Site framework adapter.", + "x-example": "static" + }, + "fallbackFile": { + "type": "string", + "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", + "x-example": "index.html" } }, "required": [ - "type", - "memoryCost", - "timeCost", - "threads" + "$id", + "$createdAt", + "$updatedAt", + "name", + "enabled", + "live", + "logging", + "framework", + "deploymentRetention", + "deploymentId", + "deploymentCreatedAt", + "deploymentScreenshotLight", + "deploymentScreenshotDark", + "latestDeploymentId", + "latestDeploymentCreatedAt", + "latestDeploymentStatus", + "vars", + "timeout", + "installCommand", + "buildCommand", + "startCommand", + "outputDirectory", + "installationId", + "providerRepositoryId", + "providerBranch", + "providerRootDirectory", + "providerSilentMode", + "buildSpecification", + "runtimeSpecification", + "buildRuntime", + "adapter", + "fallbackFile" ], "example": { - "type": "argon2", - "memoryCost": 65536, - "timeCost": 4, - "threads": 3 - } - }, - "preferences": { - "description": "Preferences", - "type": "object", - "additionalProperties": true, - "example": { - "language": "en", - "timezone": "UTC", - "darkTheme": true + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My Site", + "enabled": false, + "live": false, + "logging": false, + "framework": "react", + "deploymentRetention": 7, + "deploymentId": "5e5ea5c16897e", + "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "deploymentScreenshotLight": "5e5ea5c16897e", + "deploymentScreenshotDark": "5e5ea5c16897e", + "latestDeploymentId": "5e5ea5c16897e", + "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentStatus": "ready", + "vars": [], + "timeout": 300, + "installCommand": "npm install", + "buildCommand": "npm run build", + "startCommand": "node custom-server.mjs", + "outputDirectory": "build", + "installationId": "6m40at4ejk5h2u9s1hboo", + "providerRepositoryId": "appwrite", + "providerBranch": "main", + "providerRootDirectory": "sites\/helloWorld", + "providerSilentMode": false, + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb", + "buildRuntime": "node-22", + "adapter": "static", + "fallbackFile": "index.html" } }, - "session": { - "description": "Session", + "function": { + "description": "Function", "type": "object", "properties": { "$id": { "type": "string", - "description": "Session ID.", + "description": "Function ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Session creation date in ISO 8601 format.", + "description": "Function creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Session update date in ISO 8601 format.", + "description": "Function update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "userId": { + "execute": { + "type": "array", + "description": "Execution permissions.", + "items": { + "type": "string" + }, + "x-example": "users" + }, + "name": { "type": "string", - "description": "User ID.", - "x-example": "5e5bb8c16897e" + "description": "Function name.", + "x-example": "My Function" }, - "expire": { + "enabled": { + "type": "boolean", + "description": "Function enabled.", + "x-example": false + }, + "live": { + "type": "boolean", + "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", + "x-example": false + }, + "runtime": { "type": "string", - "description": "Session expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Function execution and build runtime.", + "x-example": "python-3.8" }, - "provider": { + "deploymentRetention": { + "type": "integer", + "description": "How many days to keep the non-active deployments before they will be automatically deleted.", + "x-example": 7, + "format": "int32" + }, + "deploymentId": { "type": "string", - "description": "Session Provider.", - "x-example": "email" + "description": "Function's active deployment ID.", + "x-example": "5e5ea5c16897e" }, - "providerUid": { + "deploymentCreatedAt": { "type": "string", - "description": "Session Provider User ID.", - "x-example": "user@example.com" + "description": "Active deployment creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerAccessToken": { + "latestDeploymentId": { "type": "string", - "description": "Session Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Function's latest deployment ID.", + "x-example": "5e5ea5c16897e" }, - "providerAccessTokenExpiry": { + "latestDeploymentCreatedAt": { "type": "string", - "description": "The date of when the access token expires in ISO 8601 format.", + "description": "Latest deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerRefreshToken": { + "latestDeploymentStatus": { "type": "string", - "description": "Session Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", + "x-example": "ready" }, - "ip": { + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" + }, + "vars": { + "type": "array", + "description": "Function variables.", + "items": { + "type": "object", + "$ref": "#\/definitions\/variable" + }, + "x-example": [] + }, + "events": { + "type": "array", + "description": "Function trigger events.", + "items": { + "type": "string" + }, + "x-example": "account.create" + }, + "schedule": { "type": "string", - "description": "IP in use when the session was created.", - "x-example": "127.0.0.1" + "description": "Function execution schedule in CRON format.", + "x-example": "5 4 * * *" }, - "osCode": { + "timeout": { + "type": "integer", + "description": "Function execution timeout in seconds.", + "x-example": 300, + "format": "int32" + }, + "entrypoint": { "type": "string", - "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "description": "The entrypoint file used to execute the deployment.", + "x-example": "index.js" }, - "osName": { + "commands": { "type": "string", - "description": "Operating system name.", - "x-example": "Mac" + "description": "The build command used to build the deployment.", + "x-example": "npm install" }, - "osVersion": { + "version": { "type": "string", - "description": "Operating system version.", - "x-example": "Mac" + "description": "Version of Open Runtimes used for the function.", + "x-example": "v2" }, - "clientType": { + "installationId": { "type": "string", - "description": "Client type.", - "x-example": "browser" + "description": "Function VCS (Version Control System) installation id.", + "x-example": "6m40at4ejk5h2u9s1hboo" }, - "clientCode": { + "providerRepositoryId": { "type": "string", - "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "description": "VCS (Version Control System) Repository ID", + "x-example": "appwrite" }, - "clientName": { + "providerBranch": { "type": "string", - "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "description": "VCS (Version Control System) branch name", + "x-example": "main" }, - "clientVersion": { + "providerRootDirectory": { "type": "string", - "description": "Client version.", - "x-example": "84.0" + "description": "Path to function in VCS (Version Control System) repository", + "x-example": "functions\/helloWorld" }, - "clientEngine": { + "providerSilentMode": { + "type": "boolean", + "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", + "x-example": false + }, + "buildSpecification": { "type": "string", - "description": "Client engine name.", - "x-example": "WebKit" + "description": "Machine specification for deployment builds.", + "x-example": "s-1vcpu-512mb" }, - "clientEngineVersion": { + "runtimeSpecification": { "type": "string", - "description": "Client engine name.", - "x-example": "605.1.15" + "description": "Machine specification for executions.", + "x-example": "s-1vcpu-512mb" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "execute", + "name", + "enabled", + "live", + "logging", + "runtime", + "deploymentRetention", + "deploymentId", + "deploymentCreatedAt", + "latestDeploymentId", + "latestDeploymentCreatedAt", + "latestDeploymentStatus", + "scopes", + "vars", + "events", + "schedule", + "timeout", + "entrypoint", + "commands", + "version", + "installationId", + "providerRepositoryId", + "providerBranch", + "providerRootDirectory", + "providerSilentMode", + "buildSpecification", + "runtimeSpecification" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "execute": "users", + "name": "My Function", + "enabled": false, + "live": false, + "logging": false, + "runtime": "python-3.8", + "deploymentRetention": 7, + "deploymentId": "5e5ea5c16897e", + "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentId": "5e5ea5c16897e", + "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", + "latestDeploymentStatus": "ready", + "scopes": "users.read", + "vars": [], + "events": "account.create", + "schedule": "5 4 * * *", + "timeout": 300, + "entrypoint": "index.js", + "commands": "npm install", + "version": "v2", + "installationId": "6m40at4ejk5h2u9s1hboo", + "providerRepositoryId": "appwrite", + "providerBranch": "main", + "providerRootDirectory": "functions\/helloWorld", + "providerSilentMode": false, + "buildSpecification": "s-1vcpu-512mb", + "runtimeSpecification": "s-1vcpu-512mb" + } + }, + "runtime": { + "description": "Runtime", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Runtime ID.", + "x-example": "python-3.8" }, - "deviceName": { + "key": { "type": "string", - "description": "Device name.", - "x-example": "smartphone" + "description": "Parent runtime key.", + "x-example": "python" }, - "deviceBrand": { + "name": { "type": "string", - "description": "Device brand name.", - "x-example": "Google" + "description": "Runtime Name.", + "x-example": "Python" }, - "deviceModel": { + "version": { "type": "string", - "description": "Device model name.", - "x-example": "Nexus 5" + "description": "Runtime version.", + "x-example": "3.8" }, - "countryCode": { + "base": { "type": "string", - "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "description": "Base Docker image used to build the runtime.", + "x-example": "python:3.8-alpine" }, - "countryName": { + "image": { "type": "string", - "description": "Country name.", - "x-example": "United States" + "description": "Image name of Docker Hub.", + "x-example": "appwrite\\\/runtime-for-python:3.8" }, - "current": { - "type": "boolean", - "description": "Returns true if this the current user session.", - "x-example": true + "logo": { + "type": "string", + "description": "Name of the logo image.", + "x-example": "python.png" }, - "factors": { + "supports": { "type": "array", - "description": "Returns a list of active session factors.", + "description": "List of supported architectures.", + "items": { + "type": "string" + }, + "x-example": "amd64" + } + }, + "required": [ + "$id", + "key", + "name", + "version", + "base", + "image", + "logo", + "supports" + ], + "example": { + "$id": "python-3.8", + "key": "python", + "name": "Python", + "version": "3.8", + "base": "python:3.8-alpine", + "image": "appwrite\\\/runtime-for-python:3.8", + "logo": "python.png", + "supports": "amd64" + } + }, + "framework": { + "description": "Framework", + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Framework key.", + "x-example": "sveltekit" + }, + "name": { + "type": "string", + "description": "Framework Name.", + "x-example": "SvelteKit" + }, + "buildRuntime": { + "type": "string", + "description": "Default runtime version.", + "x-example": "node-22" + }, + "runtimes": { + "type": "array", + "description": "List of supported runtime versions.", "items": { "type": "string" }, "x-example": [ - "email" + "static-1", + "node-22" ] }, - "secret": { + "adapters": { + "type": "array", + "description": "List of supported adapters.", + "items": { + "type": "object", + "$ref": "#\/definitions\/frameworkAdapter" + }, + "x-example": [ + { + "key": "static", + "buildRuntime": "node-22", + "buildCommand": "npm run build", + "installCommand": "npm install", + "outputDirectory": ".\/dist" + } + ] + } + }, + "required": [ + "key", + "name", + "buildRuntime", + "runtimes", + "adapters" + ], + "example": { + "key": "sveltekit", + "name": "SvelteKit", + "buildRuntime": "node-22", + "runtimes": [ + "static-1", + "node-22" + ], + "adapters": [ + { + "key": "static", + "buildRuntime": "node-22", + "buildCommand": "npm run build", + "installCommand": "npm install", + "outputDirectory": ".\/dist" + } + ] + } + }, + "frameworkAdapter": { + "description": "Framework Adapter", + "type": "object", + "properties": { + "key": { "type": "string", - "description": "Secret used to authenticate the user. Only included if the request was made with an API key", - "x-example": "5e5bb8c16897e" + "description": "Adapter key.", + "x-example": "static" }, - "mfaUpdatedAt": { + "installCommand": { "type": "string", - "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Default command to download dependencies.", + "x-example": "npm install" + }, + "buildCommand": { + "type": "string", + "description": "Default command to build site into output directory.", + "x-example": "npm run build" + }, + "outputDirectory": { + "type": "string", + "description": "Default output directory of build.", + "x-example": ".\/dist" + }, + "fallbackFile": { + "type": "string", + "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", + "x-example": "index.html" } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "userId", - "expire", - "provider", - "providerUid", - "providerAccessToken", - "providerAccessTokenExpiry", - "providerRefreshToken", - "ip", - "osCode", - "osName", - "osVersion", - "clientType", - "clientCode", - "clientName", - "clientVersion", - "clientEngine", - "clientEngineVersion", - "deviceName", - "deviceBrand", - "deviceModel", - "countryCode", - "countryName", - "current", - "factors", - "secret", - "mfaUpdatedAt" + "key", + "installCommand", + "buildCommand", + "outputDirectory", + "fallbackFile" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5bb8c16897e", - "expire": "2020-10-15T06:38:00.000+00:00", - "provider": "email", - "providerUid": "user@example.com", - "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", - "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "ip": "127.0.0.1", - "osCode": "Mac", - "osName": "Mac", - "osVersion": "Mac", - "clientType": "browser", - "clientCode": "CM", - "clientName": "Chrome Mobile iOS", - "clientVersion": "84.0", - "clientEngine": "WebKit", - "clientEngineVersion": "605.1.15", - "deviceName": "smartphone", - "deviceBrand": "Google", - "deviceModel": "Nexus 5", - "countryCode": "US", - "countryName": "United States", - "current": true, - "factors": [ - "email" - ], - "secret": "5e5bb8c16897e", - "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00" + "key": "static", + "installCommand": "npm install", + "buildCommand": "npm run build", + "outputDirectory": ".\/dist", + "fallbackFile": "index.html" } }, - "identity": { - "description": "Identity", + "deployment": { + "description": "Deployment", "type": "object", "properties": { "$id": { "type": "string", - "description": "Identity ID.", + "description": "Deployment ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Identity creation date in ISO 8601 format.", + "description": "Deployment creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Identity update date in ISO 8601 format.", + "description": "Deployment update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "userId": { + "type": { "type": "string", - "description": "User ID.", - "x-example": "5e5bb8c16897e" + "description": "Type of deployment.", + "x-example": "vcs" }, - "provider": { + "resourceId": { "type": "string", - "description": "Identity Provider.", - "x-example": "email" + "description": "Resource ID.", + "x-example": "5e5ea6g16897e" }, - "providerUid": { + "resourceType": { "type": "string", - "description": "ID of the User in the Identity Provider.", - "x-example": "5e5bb8c16897e" + "description": "Resource type.", + "x-example": "functions" }, - "providerEmail": { + "entrypoint": { "type": "string", - "description": "Email of the User in the Identity Provider.", - "x-example": "user@example.com" + "description": "The entrypoint file to use to execute the deployment code.", + "x-example": "index.js" }, - "providerAccessToken": { + "sourceSize": { + "type": "integer", + "description": "The code size in bytes.", + "x-example": 128, + "format": "int32" + }, + "buildSize": { + "type": "integer", + "description": "The build output size in bytes.", + "x-example": 128, + "format": "int32" + }, + "totalSize": { + "type": "integer", + "description": "The total size in bytes (source and build output).", + "x-example": 128, + "format": "int32" + }, + "buildId": { "type": "string", - "description": "Identity Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "The current build ID.", + "x-example": "5e5ea5c16897e" }, - "providerAccessTokenExpiry": { + "activate": { + "type": "boolean", + "description": "Whether the deployment should be automatically activated.", + "x-example": true + }, + "screenshotLight": { "type": "string", - "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Screenshot with light theme preference file ID.", + "x-example": "5e5ea5c16897e" }, - "providerRefreshToken": { + "screenshotDark": { "type": "string", - "description": "Identity Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "description": "Screenshot with dark theme preference file ID.", + "x-example": "5e5ea5c16897e" + }, + "status": { + "type": "string", + "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", + "x-example": "ready", + "enum": [ + "waiting", + "processing", + "building", + "ready", + "canceled", + "failed" + ] + }, + "buildLogs": { + "type": "string", + "description": "The build logs.", + "x-example": "Compiling source files..." + }, + "buildDuration": { + "type": "integer", + "description": "The current build time in seconds.", + "x-example": 128, + "format": "int32" + }, + "providerRepositoryName": { + "type": "string", + "description": "The name of the vcs provider repository", + "x-example": "database" + }, + "providerRepositoryOwner": { + "type": "string", + "description": "The name of the vcs provider repository owner", + "x-example": "utopia" + }, + "providerRepositoryUrl": { + "type": "string", + "description": "The url of the vcs provider repository", + "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + }, + "providerCommitHash": { + "type": "string", + "description": "The commit hash of the vcs commit", + "x-example": "7c3f25d" + }, + "providerCommitAuthorUrl": { + "type": "string", + "description": "The url of vcs commit author", + "x-example": "https:\/\/github.com\/vermakhushboo" + }, + "providerCommitAuthor": { + "type": "string", + "description": "The name of vcs commit author", + "x-example": "Khushboo Verma" + }, + "providerCommitMessage": { + "type": "string", + "description": "The commit message", + "x-example": "Update index.js" + }, + "providerCommitUrl": { + "type": "string", + "description": "The url of the vcs commit", + "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + }, + "providerBranch": { + "type": "string", + "description": "The branch of the vcs repository", + "x-example": "0.7.x" + }, + "providerBranchUrl": { + "type": "string", + "description": "The branch of the vcs repository", + "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "userId", - "provider", - "providerUid", - "providerEmail", - "providerAccessToken", - "providerAccessTokenExpiry", - "providerRefreshToken" + "type", + "resourceId", + "resourceType", + "entrypoint", + "sourceSize", + "buildSize", + "totalSize", + "buildId", + "activate", + "screenshotLight", + "screenshotDark", + "status", + "buildLogs", + "buildDuration", + "providerRepositoryName", + "providerRepositoryOwner", + "providerRepositoryUrl", + "providerCommitHash", + "providerCommitAuthorUrl", + "providerCommitAuthor", + "providerCommitMessage", + "providerCommitUrl", + "providerBranch", + "providerBranchUrl" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5bb8c16897e", - "provider": "email", - "providerUid": "5e5bb8c16897e", - "providerEmail": "user@example.com", - "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", - "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00", - "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "type": "vcs", + "resourceId": "5e5ea6g16897e", + "resourceType": "functions", + "entrypoint": "index.js", + "sourceSize": 128, + "buildSize": 128, + "totalSize": 128, + "buildId": "5e5ea5c16897e", + "activate": true, + "screenshotLight": "5e5ea5c16897e", + "screenshotDark": "5e5ea5c16897e", + "status": "ready", + "buildLogs": "Compiling source files...", + "buildDuration": 128, + "providerRepositoryName": "database", + "providerRepositoryOwner": "utopia", + "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function", + "providerCommitHash": "7c3f25d", + "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo", + "providerCommitAuthor": "Khushboo Verma", + "providerCommitMessage": "Update index.js", + "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", + "providerBranch": "0.7.x", + "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, - "token": { - "description": "Token", + "execution": { + "description": "Execution", "type": "object", "properties": { "$id": { "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "description": "Execution ID.", + "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Token creation date in ISO 8601 format.", + "description": "Execution creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "userId": { + "$updatedAt": { "type": "string", - "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "description": "Execution update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "secret": { - "type": "string", - "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "$permissions": { + "type": "array", + "description": "Execution roles.", + "items": { + "type": "string" + }, + "x-example": [ + "any" + ] }, - "expire": { + "functionId": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Function ID.", + "x-example": "5e5ea6g16897e" }, - "phrase": { - "type": "string", - "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", - "x-example": "Golden Fox" - } - }, - "required": [ - "$id", - "$createdAt", - "userId", - "secret", - "expire", - "phrase" - ], - "example": { - "$id": "bb8ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c168bb8", - "secret": "", - "expire": "2020-10-15T06:38:00.000+00:00", - "phrase": "Golden Fox" - } - }, - "jwt": { - "description": "JWT", - "type": "object", - "properties": { - "jwt": { + "deploymentId": { "type": "string", - "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" - } - }, - "required": [ - "jwt" - ], - "example": { - "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" - } - }, - "locale": { - "description": "Locale", - "type": "object", - "properties": { - "ip": { + "description": "Function's deployment ID used to create the execution.", + "x-example": "5e5ea5c16897e" + }, + "trigger": { "type": "string", - "description": "User IP address.", - "x-example": "127.0.0.1" + "description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.", + "x-example": "http", + "enum": [ + "http", + "schedule", + "event" + ] }, - "countryCode": { + "status": { "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", - "x-example": "US" + "description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", + "x-example": "processing", + "enum": [ + "waiting", + "processing", + "completed", + "failed", + "scheduled" + ] }, - "country": { + "requestMethod": { "type": "string", - "description": "Country name. This field support localization.", - "x-example": "United States" + "description": "HTTP request method type.", + "x-example": "GET" }, - "continentCode": { + "requestPath": { "type": "string", - "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", - "x-example": "NA" + "description": "HTTP request path and query.", + "x-example": "\/articles?id=5" }, - "continent": { + "requestHeaders": { + "type": "array", + "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", + "items": { + "type": "object", + "$ref": "#\/definitions\/headers" + }, + "x-example": [ + { + "Content-Type": "application\/json" + } + ] + }, + "responseStatusCode": { + "type": "integer", + "description": "HTTP response status code.", + "x-example": 200, + "format": "int32" + }, + "responseBody": { "type": "string", - "description": "Continent name. This field support localization.", - "x-example": "North America" + "description": "HTTP response body. This will return empty unless execution is created as synchronous.", + "x-example": "" }, - "eu": { - "type": "boolean", - "description": "True if country is part of the European Union.", - "x-example": false + "responseHeaders": { + "type": "array", + "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", + "items": { + "type": "object", + "$ref": "#\/definitions\/headers" + }, + "x-example": [ + { + "Content-Type": "application\/json" + } + ] }, - "currency": { + "logs": { "type": "string", - "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", - "x-example": "USD" - } - }, - "required": [ - "ip", - "countryCode", - "country", - "continentCode", - "continent", - "eu", - "currency" - ], - "example": { - "ip": "127.0.0.1", - "countryCode": "US", - "country": "United States", - "continentCode": "NA", - "continent": "North America", - "eu": false, - "currency": "USD" - } - }, - "localeCode": { - "description": "LocaleCode", - "type": "object", - "properties": { - "code": { + "description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" + }, + "errors": { "type": "string", - "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", - "x-example": "en-us" + "description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", + "x-example": "" }, - "name": { + "duration": { + "type": "number", + "description": "Resource(function\/site) execution duration in seconds.", + "x-example": 0.4, + "format": "double" + }, + "scheduledAt": { "type": "string", - "description": "Locale name", - "x-example": "US" + "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", + "x-example": "2020-10-15T06:38:00.000+00:00", + "x-nullable": true } }, "required": [ - "code", - "name" + "$id", + "$createdAt", + "$updatedAt", + "$permissions", + "functionId", + "deploymentId", + "trigger", + "status", + "requestMethod", + "requestPath", + "requestHeaders", + "responseStatusCode", + "responseBody", + "responseHeaders", + "logs", + "errors", + "duration" ], "example": { - "code": "en-us", - "name": "US" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "$permissions": [ + "any" + ], + "functionId": "5e5ea6g16897e", + "deploymentId": "5e5ea5c16897e", + "trigger": "http", + "status": "processing", + "requestMethod": "GET", + "requestPath": "\/articles?id=5", + "requestHeaders": [ + { + "Content-Type": "application\/json" + } + ], + "responseStatusCode": 200, + "responseBody": "", + "responseHeaders": [ + { + "Content-Type": "application\/json" + } + ], + "logs": "", + "errors": "", + "duration": 0.4, + "scheduledAt": "2020-10-15T06:38:00.000+00:00" } }, - "file": { - "description": "File", + "project": { + "description": "Project", "type": "object", "properties": { "$id": { "type": "string", - "description": "File ID.", - "x-example": "5e5ea5c16897e" - }, - "bucketId": { - "type": "string", - "description": "Bucket ID.", + "description": "Project ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "File creation date in ISO 8601 format.", + "description": "Project creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "File update date in ISO 8601 format.", + "description": "Project update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "$permissions": { - "type": "array", - "description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "items": { - "type": "string" - }, - "x-example": [ - "read(\"any\")" - ] - }, "name": { "type": "string", - "description": "File name.", - "x-example": "Pink.png" + "description": "Project name.", + "x-example": "New Project" }, - "signature": { + "description": { "type": "string", - "description": "File MD5 signature.", - "x-example": "5d529fd02b544198ae075bd57c1762bb" + "description": "Project description.", + "x-example": "This is a new project." }, - "mimeType": { + "teamId": { "type": "string", - "description": "File mime type.", - "x-example": "image\/png" + "description": "Project team ID.", + "x-example": "1592981250" }, - "sizeOriginal": { + "logo": { + "type": "string", + "description": "Project logo file ID.", + "x-example": "5f5c451b403cb" + }, + "url": { + "type": "string", + "description": "Project website URL.", + "x-example": "5f5c451b403cb" + }, + "legalName": { + "type": "string", + "description": "Company legal name.", + "x-example": "Company LTD." + }, + "legalCountry": { + "type": "string", + "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", + "x-example": "US" + }, + "legalState": { + "type": "string", + "description": "State name.", + "x-example": "New York" + }, + "legalCity": { + "type": "string", + "description": "City name.", + "x-example": "New York City." + }, + "legalAddress": { + "type": "string", + "description": "Company Address.", + "x-example": "620 Eighth Avenue, New York, NY 10018" + }, + "legalTaxId": { + "type": "string", + "description": "Company Tax ID.", + "x-example": "131102020" + }, + "authDuration": { "type": "integer", - "description": "File original size in bytes.", - "x-example": 17890, + "description": "Session duration in seconds.", + "x-example": 60, "format": "int32" }, - "chunksTotal": { + "authLimit": { "type": "integer", - "description": "Total number of chunks available", - "x-example": 17890, + "description": "Max users allowed. 0 is unlimited.", + "x-example": 100, "format": "int32" }, - "chunksUploaded": { + "authSessionsLimit": { "type": "integer", - "description": "Total number of chunks uploaded", - "x-example": 17890, + "description": "Max sessions allowed per user. 100 maximum.", + "x-example": 10, "format": "int32" }, - "encryption": { + "authPasswordHistory": { + "type": "integer", + "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", + "x-example": 5, + "format": "int32" + }, + "authPasswordDictionary": { "type": "boolean", - "description": "Whether file contents are encrypted at rest.", + "description": "Whether or not to check user's password against most commonly used passwords.", "x-example": true }, - "compression": { - "type": "string", - "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" - } - }, - "required": [ - "$id", - "bucketId", - "$createdAt", - "$updatedAt", - "$permissions", - "name", - "signature", - "mimeType", - "sizeOriginal", - "chunksTotal", - "chunksUploaded", - "encryption", - "compression" - ], - "example": { - "$id": "5e5ea5c16897e", - "bucketId": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "name": "Pink.png", - "signature": "5d529fd02b544198ae075bd57c1762bb", - "mimeType": "image\/png", - "sizeOriginal": 17890, - "chunksTotal": 17890, - "chunksUploaded": 17890, - "encryption": true, - "compression": "gzip" - } - }, - "bucket": { - "description": "Bucket", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" + "authPersonalDataCheck": { + "type": "boolean", + "description": "Whether or not to check the user password for similarity with their personal data.", + "x-example": true }, - "$createdAt": { - "type": "string", - "description": "Bucket creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authDisposableEmails": { + "type": "boolean", + "description": "Whether or not to disallow disposable email addresses during signup and email updates.", + "x-example": true }, - "$updatedAt": { - "type": "string", - "description": "Bucket update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "authCanonicalEmails": { + "type": "boolean", + "description": "Whether or not to require canonical email addresses during signup and email updates.", + "x-example": true }, - "$permissions": { + "authFreeEmails": { + "type": "boolean", + "description": "Whether or not to disallow free email addresses during signup and email updates.", + "x-example": true + }, + "authMockNumbers": { "type": "array", - "description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "An array of mock numbers and their corresponding verification codes (OTPs).", "items": { - "type": "string" + "type": "object", + "$ref": "#\/definitions\/mockNumber" }, "x-example": [ - "read(\"any\")" + {} ] }, - "fileSecurity": { + "authSessionAlerts": { "type": "boolean", - "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "description": "Whether or not to send session alert emails to users.", "x-example": true }, - "name": { - "type": "string", - "description": "Bucket name.", - "x-example": "Documents" + "authMembershipsUserName": { + "type": "boolean", + "description": "Whether or not to show user names in the teams membership response.", + "x-example": true }, - "enabled": { + "authMembershipsUserEmail": { "type": "boolean", - "description": "Bucket enabled.", - "x-example": false + "description": "Whether or not to show user emails in the teams membership response.", + "x-example": true }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size supported.", - "x-example": 100, - "format": "int32" + "authMembershipsMfa": { + "type": "boolean", + "description": "Whether or not to show user MFA status in the teams membership response.", + "x-example": true }, - "allowedFileExtensions": { + "authMembershipsUserId": { + "type": "boolean", + "description": "Whether or not to show user IDs in the teams membership response.", + "x-example": true + }, + "authMembershipsUserPhone": { + "type": "boolean", + "description": "Whether or not to show user phone numbers in the teams membership response.", + "x-example": true + }, + "authInvalidateSessions": { + "type": "boolean", + "description": "Whether or not all existing sessions should be invalidated on password change", + "x-example": true + }, + "oAuthProviders": { "type": "array", - "description": "Allowed file extensions.", + "description": "List of Auth Providers.", "items": { - "type": "string" + "type": "object", + "$ref": "#\/definitions\/authProvider" }, "x-example": [ - "jpg", - "png" + {} ] }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "platforms": { + "type": "array", + "description": "List of Platforms.", + "items": { + "x-anyOf": [ + { + "$ref": "#\/definitions\/platformWeb" + }, + { + "$ref": "#\/definitions\/platformApple" + }, + { + "$ref": "#\/definitions\/platformAndroid" + }, + { + "$ref": "#\/definitions\/platformWindows" + }, + { + "$ref": "#\/definitions\/platformLinux" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "web": "#\/definitions\/platformWeb", + "apple": "#\/definitions\/platformApple", + "android": "#\/definitions\/platformAndroid", + "windows": "#\/definitions\/platformWindows", + "linux": "#\/definitions\/platformLinux" + } + } + }, + "x-example": {} }, - "encryption": { - "type": "boolean", - "description": "Bucket is encrypted.", - "x-example": false + "webhooks": { + "type": "array", + "description": "List of Webhooks.", + "items": { + "type": "object", + "$ref": "#\/definitions\/webhook" + }, + "x-example": {} }, - "antivirus": { - "type": "boolean", - "description": "Virus scanning is enabled.", - "x-example": false + "keys": { + "type": "array", + "description": "List of API Keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/key" + }, + "x-example": {} }, - "transformations": { + "devKeys": { + "type": "array", + "description": "List of dev keys.", + "items": { + "type": "object", + "$ref": "#\/definitions\/devKey" + }, + "x-example": {} + }, + "smtpEnabled": { "type": "boolean", - "description": "Image transformations are enabled.", + "description": "Status for custom SMTP", "x-example": false }, - "totalSize": { - "type": "integer", - "description": "Total size of this bucket in bytes.", - "x-example": 128, - "format": "int32" - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "$permissions", - "fileSecurity", - "name", - "enabled", - "maximumFileSize", - "allowedFileExtensions", - "compression", - "encryption", - "antivirus", - "transformations", - "totalSize" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "read(\"any\")" - ], - "fileSecurity": true, - "name": "Documents", - "enabled": false, - "maximumFileSize": 100, - "allowedFileExtensions": [ - "jpg", - "png" - ], - "compression": "gzip", - "encryption": false, - "antivirus": false, - "transformations": false, - "totalSize": 128 - } - }, - "resourceToken": { - "description": "ResourceToken", - "type": "object", - "properties": { - "$id": { + "smtpSenderName": { "type": "string", - "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "description": "SMTP sender name", + "x-example": "John Appwrite" }, - "$createdAt": { + "smtpSenderEmail": { "type": "string", - "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "SMTP sender email", + "x-example": "john@appwrite.io" }, - "resourceId": { + "smtpReplyToName": { "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" + "description": "SMTP reply to name", + "x-example": "Support Team" }, - "resourceType": { + "smtpReplyToEmail": { "type": "string", - "description": "Resource type.", - "x-example": "files" + "description": "SMTP reply to email", + "x-example": "support@appwrite.io" }, - "expire": { + "smtpHost": { "type": "string", - "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "SMTP server host name", + "x-example": "mail.appwrite.io" }, - "secret": { + "smtpPort": { + "type": "integer", + "description": "SMTP server port", + "x-example": 25, + "format": "int32" + }, + "smtpUsername": { "type": "string", - "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "description": "SMTP server username", + "x-example": "emailuser" }, - "accessedAt": { + "smtpPassword": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "description": "SMTP server password. This property is write-only and always returned empty.", + "x-example": "" + }, + "smtpSecure": { + "type": "string", + "description": "SMTP server secure protocol", + "x-example": "tls" + }, + "pingCount": { + "type": "integer", + "description": "Number of times the ping was received for this project.", + "x-example": 1, + "format": "int32" + }, + "pingedAt": { + "type": "string", + "description": "Last ping datetime in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" - } - }, - "required": [ - "$id", - "$createdAt", - "resourceId", - "resourceType", - "expire", - "secret", - "accessedAt" - ], - "example": { - "$id": "bb8ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8", - "resourceType": "files", - "expire": "2020-10-15T06:38:00.000+00:00", - "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", - "accessedAt": "2020-10-15T06:38:00.000+00:00" - } - }, - "team": { - "description": "Team", - "type": "object", - "properties": { - "$id": { + }, + "labels": { + "type": "array", + "description": "Labels for the project.", + "items": { + "type": "string" + }, + "x-example": [ + "vip" + ] + }, + "status": { "type": "string", - "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "description": "Project status", + "x-example": "active" + }, + "authEmailPassword": { + "type": "boolean", + "description": "Email\/Password auth method status", + "x-example": true + }, + "authUsersAuthMagicURL": { + "type": "boolean", + "description": "Magic URL auth method status", + "x-example": true + }, + "authEmailOtp": { + "type": "boolean", + "description": "Email (OTP) auth method status", + "x-example": true + }, + "authAnonymous": { + "type": "boolean", + "description": "Anonymous auth method status", + "x-example": true + }, + "authInvites": { + "type": "boolean", + "description": "Invites auth method status", + "x-example": true + }, + "authJWT": { + "type": "boolean", + "description": "JWT auth method status", + "x-example": true + }, + "authPhone": { + "type": "boolean", + "description": "Phone auth method status", + "x-example": true + }, + "serviceStatusForAccount": { + "type": "boolean", + "description": "Account service status", + "x-example": true + }, + "serviceStatusForAvatars": { + "type": "boolean", + "description": "Avatars service status", + "x-example": true + }, + "serviceStatusForDatabases": { + "type": "boolean", + "description": "Databases (legacy) service status", + "x-example": true }, - "$createdAt": { - "type": "string", - "description": "Team creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "serviceStatusForTablesdb": { + "type": "boolean", + "description": "TablesDB service status", + "x-example": true }, - "$updatedAt": { - "type": "string", - "description": "Team update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "serviceStatusForLocale": { + "type": "boolean", + "description": "Locale service status", + "x-example": true }, - "name": { - "type": "string", - "description": "Team name.", - "x-example": "VIP" + "serviceStatusForHealth": { + "type": "boolean", + "description": "Health service status", + "x-example": true }, - "total": { - "type": "integer", - "description": "Total number of team members.", - "x-example": 7, - "format": "int32" + "serviceStatusForProject": { + "type": "boolean", + "description": "Project service status", + "x-example": true }, - "prefs": { - "type": "object", - "description": "Team preferences as a key-value object", - "x-example": { - "theme": "pink", - "timezone": "UTC" - }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "name", - "total", - "prefs" - ], - "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "VIP", - "total": 7, - "prefs": { - "theme": "pink", - "timezone": "UTC" - } - } - }, - "membership": { - "description": "Membership", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Membership ID.", - "x-example": "5e5ea5c16897e" + "serviceStatusForStorage": { + "type": "boolean", + "description": "Storage service status", + "x-example": true }, - "$createdAt": { - "type": "string", - "description": "Membership creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "serviceStatusForTeams": { + "type": "boolean", + "description": "Teams service status", + "x-example": true }, - "$updatedAt": { - "type": "string", - "description": "Membership update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "serviceStatusForUsers": { + "type": "boolean", + "description": "Users service status", + "x-example": true }, - "userId": { - "type": "string", - "description": "User ID.", - "x-example": "5e5ea5c16897e" + "serviceStatusForVcs": { + "type": "boolean", + "description": "VCS service status", + "x-example": true }, - "userName": { - "type": "string", - "description": "User name. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "John Doe" + "serviceStatusForSites": { + "type": "boolean", + "description": "Sites service status", + "x-example": true }, - "userEmail": { - "type": "string", - "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "john@appwrite.io" + "serviceStatusForFunctions": { + "type": "boolean", + "description": "Functions service status", + "x-example": true }, - "userPhone": { - "type": "string", - "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "+1 555 555 5555" + "serviceStatusForProxy": { + "type": "boolean", + "description": "Proxy service status", + "x-example": true }, - "teamId": { - "type": "string", - "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "serviceStatusForGraphql": { + "type": "boolean", + "description": "GraphQL service status", + "x-example": true }, - "teamName": { - "type": "string", - "description": "Team name.", - "x-example": "VIP" + "serviceStatusForMigrations": { + "type": "boolean", + "description": "Migrations service status", + "x-example": true }, - "invited": { - "type": "string", - "description": "Date, the user has been invited to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "serviceStatusForMessaging": { + "type": "boolean", + "description": "Messaging service status", + "x-example": true }, - "joined": { - "type": "string", - "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "protocolStatusForRest": { + "type": "boolean", + "description": "REST protocol status", + "x-example": true }, - "confirm": { + "protocolStatusForGraphql": { "type": "boolean", - "description": "User confirmation status, true if the user has joined the team or false otherwise.", - "x-example": false + "description": "GraphQL protocol status", + "x-example": true }, - "mfa": { + "protocolStatusForWebsocket": { "type": "boolean", - "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", - "x-example": false + "description": "Websocket protocol status", + "x-example": true }, - "roles": { + "region": { + "type": "string", + "description": "Project region", + "x-example": "fra" + }, + "billingLimits": { + "type": "object", + "description": "Billing limits reached", + "x-example": "", + "items": { + "type": "object", + "$ref": "#\/definitions\/billingLimits" + } + }, + "blocks": { "type": "array", - "description": "User list of roles", + "description": "Project blocks information", "items": { - "type": "string" + "type": "object", + "$ref": "#\/definitions\/block" }, - "x-example": [ - "owner" - ] + "x-example": "" + }, + "consoleAccessedAt": { + "type": "string", + "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", + "x-example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "userId", - "userName", - "userEmail", - "userPhone", + "name", + "description", "teamId", - "teamName", - "invited", - "joined", - "confirm", - "mfa", - "roles" + "logo", + "url", + "legalName", + "legalCountry", + "legalState", + "legalCity", + "legalAddress", + "legalTaxId", + "authDuration", + "authLimit", + "authSessionsLimit", + "authPasswordHistory", + "authPasswordDictionary", + "authPersonalDataCheck", + "authDisposableEmails", + "authCanonicalEmails", + "authFreeEmails", + "authMockNumbers", + "authSessionAlerts", + "authMembershipsUserName", + "authMembershipsUserEmail", + "authMembershipsMfa", + "authMembershipsUserId", + "authMembershipsUserPhone", + "authInvalidateSessions", + "oAuthProviders", + "platforms", + "webhooks", + "keys", + "devKeys", + "smtpEnabled", + "smtpSenderName", + "smtpSenderEmail", + "smtpReplyToName", + "smtpReplyToEmail", + "smtpHost", + "smtpPort", + "smtpUsername", + "smtpPassword", + "smtpSecure", + "pingCount", + "pingedAt", + "labels", + "status", + "authEmailPassword", + "authUsersAuthMagicURL", + "authEmailOtp", + "authAnonymous", + "authInvites", + "authJWT", + "authPhone", + "serviceStatusForAccount", + "serviceStatusForAvatars", + "serviceStatusForDatabases", + "serviceStatusForTablesdb", + "serviceStatusForLocale", + "serviceStatusForHealth", + "serviceStatusForProject", + "serviceStatusForStorage", + "serviceStatusForTeams", + "serviceStatusForUsers", + "serviceStatusForVcs", + "serviceStatusForSites", + "serviceStatusForFunctions", + "serviceStatusForProxy", + "serviceStatusForGraphql", + "serviceStatusForMigrations", + "serviceStatusForMessaging", + "protocolStatusForRest", + "protocolStatusForGraphql", + "protocolStatusForWebsocket", + "region", + "billingLimits", + "blocks", + "consoleAccessedAt" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "userId": "5e5ea5c16897e", - "userName": "John Doe", - "userEmail": "john@appwrite.io", - "userPhone": "+1 555 555 5555", - "teamId": "5e5ea5c16897e", - "teamName": "VIP", - "invited": "2020-10-15T06:38:00.000+00:00", - "joined": "2020-10-15T06:38:00.000+00:00", - "confirm": false, - "mfa": false, - "roles": [ - "owner" - ] + "name": "New Project", + "description": "This is a new project.", + "teamId": "1592981250", + "logo": "5f5c451b403cb", + "url": "5f5c451b403cb", + "legalName": "Company LTD.", + "legalCountry": "US", + "legalState": "New York", + "legalCity": "New York City.", + "legalAddress": "620 Eighth Avenue, New York, NY 10018", + "legalTaxId": "131102020", + "authDuration": 60, + "authLimit": 100, + "authSessionsLimit": 10, + "authPasswordHistory": 5, + "authPasswordDictionary": true, + "authPersonalDataCheck": true, + "authDisposableEmails": true, + "authCanonicalEmails": true, + "authFreeEmails": true, + "authMockNumbers": [ + {} + ], + "authSessionAlerts": true, + "authMembershipsUserName": true, + "authMembershipsUserEmail": true, + "authMembershipsMfa": true, + "authMembershipsUserId": true, + "authMembershipsUserPhone": true, + "authInvalidateSessions": true, + "oAuthProviders": [ + {} + ], + "platforms": {}, + "webhooks": {}, + "keys": {}, + "devKeys": {}, + "smtpEnabled": false, + "smtpSenderName": "John Appwrite", + "smtpSenderEmail": "john@appwrite.io", + "smtpReplyToName": "Support Team", + "smtpReplyToEmail": "support@appwrite.io", + "smtpHost": "mail.appwrite.io", + "smtpPort": 25, + "smtpUsername": "emailuser", + "smtpPassword": "", + "smtpSecure": "tls", + "pingCount": 1, + "pingedAt": "2020-10-15T06:38:00.000+00:00", + "labels": [ + "vip" + ], + "status": "active", + "authEmailPassword": true, + "authUsersAuthMagicURL": true, + "authEmailOtp": true, + "authAnonymous": true, + "authInvites": true, + "authJWT": true, + "authPhone": true, + "serviceStatusForAccount": true, + "serviceStatusForAvatars": true, + "serviceStatusForDatabases": true, + "serviceStatusForTablesdb": true, + "serviceStatusForLocale": true, + "serviceStatusForHealth": true, + "serviceStatusForProject": true, + "serviceStatusForStorage": true, + "serviceStatusForTeams": true, + "serviceStatusForUsers": true, + "serviceStatusForVcs": true, + "serviceStatusForSites": true, + "serviceStatusForFunctions": true, + "serviceStatusForProxy": true, + "serviceStatusForGraphql": true, + "serviceStatusForMigrations": true, + "serviceStatusForMessaging": true, + "protocolStatusForRest": true, + "protocolStatusForGraphql": true, + "protocolStatusForWebsocket": true, + "region": "fra", + "billingLimits": "", + "blocks": "", + "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" } }, - "site": { - "description": "Site", + "webhook": { + "description": "Webhook", "type": "object", "properties": { "$id": { "type": "string", - "description": "Site ID.", + "description": "Webhook ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Site creation date in ISO 8601 format.", + "description": "Webhook creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Site update date in ISO 8601 format.", + "description": "Webhook update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", - "description": "Site name.", - "x-example": "My Site" - }, - "enabled": { - "type": "boolean", - "description": "Site enabled.", - "x-example": false - }, - "live": { - "type": "boolean", - "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false - }, - "framework": { - "type": "string", - "description": "Site framework.", - "x-example": "react" - }, - "deploymentRetention": { - "type": "integer", - "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" - }, - "deploymentId": { - "type": "string", - "description": "Site's active deployment ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentCreatedAt": { - "type": "string", - "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "deploymentScreenshotLight": { - "type": "string", - "description": "Screenshot of active deployment with light theme preference file ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentScreenshotDark": { - "type": "string", - "description": "Screenshot of active deployment with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" - }, - "latestDeploymentId": { - "type": "string", - "description": "Site's latest deployment ID.", - "x-example": "5e5ea5c16897e" - }, - "latestDeploymentCreatedAt": { - "type": "string", - "description": "Latest deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "latestDeploymentStatus": { - "type": "string", - "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" - }, - "vars": { - "type": "array", - "description": "Site variables.", - "items": { - "type": "object", - "$ref": "#\/definitions\/variable" - }, - "x-example": [] - }, - "timeout": { - "type": "integer", - "description": "Site request timeout in seconds.", - "x-example": 300, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "The install command used to install the site dependencies.", - "x-example": "npm install" - }, - "buildCommand": { - "type": "string", - "description": "The build command used to build the site.", - "x-example": "npm run build" - }, - "startCommand": { - "type": "string", - "description": "Custom command to use when starting site runtime.", - "x-example": "node custom-server.mjs" - }, - "outputDirectory": { - "type": "string", - "description": "The directory where the site build output is located.", - "x-example": "build" - }, - "installationId": { - "type": "string", - "description": "Site VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" - }, - "providerRepositoryId": { - "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" - }, - "providerBranch": { - "type": "string", - "description": "VCS (Version Control System) branch name", - "x-example": "main" + "description": "Webhook name.", + "x-example": "My Webhook" }, - "providerRootDirectory": { + "url": { "type": "string", - "description": "Path to site in VCS (Version Control System) repository", - "x-example": "sites\/helloWorld" + "description": "Webhook URL endpoint.", + "x-example": "https:\/\/example.com\/webhook" }, - "providerSilentMode": { + "events": { + "type": "array", + "description": "Webhook trigger events.", + "items": { + "type": "string" + }, + "x-example": [ + "databases.tables.update", + "databases.collections.update" + ] + }, + "tls": { "type": "boolean", - "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "description": "Indicates if SSL \/ TLS certificate verification is enabled.", + "x-example": true }, - "buildSpecification": { + "authUsername": { "type": "string", - "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "description": "HTTP basic authentication username.", + "x-example": "username" }, - "runtimeSpecification": { + "authPassword": { "type": "string", - "description": "Machine specification for SSR executions.", - "x-example": "s-1vcpu-512mb" + "description": "HTTP basic authentication password.", + "x-example": "password" }, - "buildRuntime": { + "secret": { "type": "string", - "description": "Site build runtime.", - "x-example": "node-22" + "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", + "x-example": "ad3d581ca230e2b7059c545e5a" }, - "adapter": { - "type": "string", - "description": "Site framework adapter.", - "x-example": "static" + "enabled": { + "type": "boolean", + "description": "Indicates if this webhook is enabled.", + "x-example": true }, - "fallbackFile": { + "logs": { "type": "string", - "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "description": "Webhook error logs from the most recent failure.", + "x-example": "Failed to connect to remote server." + }, + "attempts": { + "type": "integer", + "description": "Number of consecutive failed webhook attempts.", + "x-example": 10, + "format": "int32" } }, "required": [ @@ -59391,153 +66157,64 @@ "$createdAt", "$updatedAt", "name", + "url", + "events", + "tls", + "authUsername", + "authPassword", + "secret", "enabled", - "live", - "logging", - "framework", - "deploymentRetention", - "deploymentId", - "deploymentCreatedAt", - "deploymentScreenshotLight", - "deploymentScreenshotDark", - "latestDeploymentId", - "latestDeploymentCreatedAt", - "latestDeploymentStatus", - "vars", - "timeout", - "installCommand", - "buildCommand", - "startCommand", - "outputDirectory", - "installationId", - "providerRepositoryId", - "providerBranch", - "providerRootDirectory", - "providerSilentMode", - "buildSpecification", - "runtimeSpecification", - "buildRuntime", - "adapter", - "fallbackFile" + "logs", + "attempts" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My Site", - "enabled": false, - "live": false, - "logging": false, - "framework": "react", - "deploymentRetention": 7, - "deploymentId": "5e5ea5c16897e", - "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "deploymentScreenshotLight": "5e5ea5c16897e", - "deploymentScreenshotDark": "5e5ea5c16897e", - "latestDeploymentId": "5e5ea5c16897e", - "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentStatus": "ready", - "vars": [], - "timeout": 300, - "installCommand": "npm install", - "buildCommand": "npm run build", - "startCommand": "node custom-server.mjs", - "outputDirectory": "build", - "installationId": "6m40at4ejk5h2u9s1hboo", - "providerRepositoryId": "appwrite", - "providerBranch": "main", - "providerRootDirectory": "sites\/helloWorld", - "providerSilentMode": false, - "buildSpecification": "s-1vcpu-512mb", - "runtimeSpecification": "s-1vcpu-512mb", - "buildRuntime": "node-22", - "adapter": "static", - "fallbackFile": "index.html" + "name": "My Webhook", + "url": "https:\/\/example.com\/webhook", + "events": [ + "databases.tables.update", + "databases.collections.update" + ], + "tls": true, + "authUsername": "username", + "authPassword": "password", + "secret": "ad3d581ca230e2b7059c545e5a", + "enabled": true, + "logs": "Failed to connect to remote server.", + "attempts": 10 } }, - "function": { - "description": "Function", + "key": { + "description": "Key", "type": "object", "properties": { "$id": { "type": "string", - "description": "Function ID.", + "description": "Key ID.", "x-example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", - "description": "Function creation date in ISO 8601 format.", + "description": "Key creation date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", - "description": "Function update date in ISO 8601 format.", + "description": "Key update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "execute": { - "type": "array", - "description": "Execution permissions.", - "items": { - "type": "string" - }, - "x-example": "users" - }, "name": { "type": "string", - "description": "Function name.", - "x-example": "My Function" - }, - "enabled": { - "type": "boolean", - "description": "Function enabled.", - "x-example": false - }, - "live": { - "type": "boolean", - "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", - "x-example": false - }, - "runtime": { - "type": "string", - "description": "Function execution and build runtime.", - "x-example": "python-3.8" - }, - "deploymentRetention": { - "type": "integer", - "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" - }, - "deploymentId": { - "type": "string", - "description": "Function's active deployment ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentCreatedAt": { - "type": "string", - "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "latestDeploymentId": { - "type": "string", - "description": "Function's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "description": "Key name.", + "x-example": "My API Key" }, - "latestDeploymentCreatedAt": { + "expire": { "type": "string", - "description": "Latest deployment creation date in ISO 8601 format.", + "description": "Key expiration date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "latestDeploymentStatus": { - "type": "string", - "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" - }, "scopes": { "type": "array", "description": "Allowed permission scopes.", @@ -59546,1666 +66223,2301 @@ }, "x-example": "users.read" }, - "vars": { - "type": "array", - "description": "Function variables.", - "items": { - "type": "object", - "$ref": "#\/definitions\/variable" - }, - "x-example": [] + "secret": { + "type": "string", + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "events": { + "accessedAt": { + "type": "string", + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "sdks": { "type": "array", - "description": "Function trigger events.", + "description": "List of SDK user agents that used this key.", "items": { "type": "string" }, - "x-example": "account.create" - }, - "schedule": { - "type": "string", - "description": "Function execution schedule in CRON format.", - "x-example": "5 4 * * *" - }, - "timeout": { - "type": "integer", - "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" - }, - "entrypoint": { + "x-example": "appwrite:flutter" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "expire", + "scopes", + "secret", + "accessedAt", + "sdks" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "scopes": "users.read", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" + } + }, + "ephemeralKey": { + "description": "Ephemeral Key", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "description": "Key ID.", + "x-example": "5e5ea5c16897e" }, - "commands": { + "$createdAt": { "type": "string", - "description": "The build command used to build the deployment.", - "x-example": "npm install" + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "version": { + "$updatedAt": { "type": "string", - "description": "Version of Open Runtimes used for the function.", - "x-example": "v2" + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "installationId": { + "name": { "type": "string", - "description": "Function VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "description": "Key name.", + "x-example": "My API Key" }, - "providerRepositoryId": { + "expire": { "type": "string", - "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "providerBranch": { - "type": "string", - "description": "VCS (Version Control System) branch name", - "x-example": "main" + "scopes": { + "type": "array", + "description": "Allowed permission scopes.", + "items": { + "type": "string" + }, + "x-example": "users.read" }, - "providerRootDirectory": { + "secret": { "type": "string", - "description": "Path to function in VCS (Version Control System) repository", - "x-example": "functions\/helloWorld" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "buildSpecification": { + "accessedAt": { "type": "string", - "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "runtimeSpecification": { - "type": "string", - "description": "Machine specification for executions.", - "x-example": "s-1vcpu-512mb" + "sdks": { + "type": "array", + "description": "List of SDK user agents that used this key.", + "items": { + "type": "string" + }, + "x-example": "appwrite:flutter" } }, "required": [ "$id", "$createdAt", "$updatedAt", - "execute", "name", - "enabled", - "live", - "logging", - "runtime", - "deploymentRetention", - "deploymentId", - "deploymentCreatedAt", - "latestDeploymentId", - "latestDeploymentCreatedAt", - "latestDeploymentStatus", + "expire", "scopes", - "vars", - "events", - "schedule", - "timeout", - "entrypoint", - "commands", - "version", - "installationId", - "providerRepositoryId", - "providerBranch", - "providerRootDirectory", - "providerSilentMode", - "buildSpecification", - "runtimeSpecification" + "secret", + "accessedAt", + "sdks" ], "example": { "$id": "5e5ea5c16897e", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "execute": "users", - "name": "My Function", - "enabled": false, - "live": false, - "logging": false, - "runtime": "python-3.8", - "deploymentRetention": 7, - "deploymentId": "5e5ea5c16897e", - "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentId": "5e5ea5c16897e", - "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00", - "latestDeploymentStatus": "ready", + "name": "My API Key", + "expire": "2020-10-15T06:38:00.000+00:00", "scopes": "users.read", - "vars": [], - "events": "account.create", - "schedule": "5 4 * * *", - "timeout": 300, - "entrypoint": "index.js", - "commands": "npm install", - "version": "v2", - "installationId": "6m40at4ejk5h2u9s1hboo", - "providerRepositoryId": "appwrite", - "providerBranch": "main", - "providerRootDirectory": "functions\/helloWorld", - "providerSilentMode": false, - "buildSpecification": "s-1vcpu-512mb", - "runtimeSpecification": "s-1vcpu-512mb" + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" } }, - "runtime": { - "description": "Runtime", + "devKey": { + "description": "DevKey", "type": "object", "properties": { "$id": { "type": "string", - "description": "Runtime ID.", - "x-example": "python-3.8" + "description": "Key ID.", + "x-example": "5e5ea5c16897e" }, - "key": { + "$createdAt": { "type": "string", - "description": "Parent runtime key.", - "x-example": "python" + "description": "Key creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "name": { + "$updatedAt": { "type": "string", - "description": "Runtime Name.", - "x-example": "Python" + "description": "Key update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "version": { + "name": { "type": "string", - "description": "Runtime version.", - "x-example": "3.8" + "description": "Key name.", + "x-example": "Dev API Key" }, - "base": { + "expire": { "type": "string", - "description": "Base Docker image used to build the runtime.", - "x-example": "python:3.8-alpine" + "description": "Key expiration date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "image": { + "secret": { "type": "string", - "description": "Image name of Docker Hub.", - "x-example": "appwrite\\\/runtime-for-python:3.8" + "description": "Secret key.", + "x-example": "919c2d18fb5d4...a2ae413da83346ad2" }, - "logo": { + "accessedAt": { "type": "string", - "description": "Name of the logo image.", - "x-example": "python.png" + "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", + "x-example": "2020-10-15T06:38:00.000+00:00" }, - "supports": { + "sdks": { "type": "array", - "description": "List of supported architectures.", + "description": "List of SDK user agents that used this key.", "items": { "type": "string" }, - "x-example": "amd64" + "x-example": "appwrite:flutter" } }, "required": [ "$id", - "key", + "$createdAt", + "$updatedAt", "name", - "version", - "base", - "image", - "logo", - "supports" + "expire", + "secret", + "accessedAt", + "sdks" ], "example": { - "$id": "python-3.8", - "key": "python", - "name": "Python", - "version": "3.8", - "base": "python:3.8-alpine", - "image": "appwrite\\\/runtime-for-python:3.8", - "logo": "python.png", - "supports": "amd64" + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Dev API Key", + "expire": "2020-10-15T06:38:00.000+00:00", + "secret": "919c2d18fb5d4...a2ae413da83346ad2", + "accessedAt": "2020-10-15T06:38:00.000+00:00", + "sdks": "appwrite:flutter" + } + }, + "mockNumber": { + "description": "Mock Number", + "type": "object", + "properties": { + "number": { + "type": "string", + "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", + "x-example": "+1612842323" + }, + "otp": { + "type": "string", + "description": "Mock OTP for the number. ", + "x-example": "123456" + }, + "$createdAt": { + "type": "string", + "description": "Attribute creation date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + }, + "$updatedAt": { + "type": "string", + "description": "Attribute update date in ISO 8601 format.", + "x-example": "2020-10-15T06:38:00.000+00:00" + } + }, + "required": [ + "number", + "otp", + "$createdAt", + "$updatedAt" + ], + "example": { + "number": "+1612842323", + "otp": "123456", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00" } }, - "framework": { - "description": "Framework", + "oAuth2Github": { + "description": "OAuth2GitHub", "type": "object", "properties": { - "key": { + "$id": { "type": "string", - "description": "Framework key.", - "x-example": "sveltekit" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "name": { - "type": "string", - "description": "Framework Name.", - "x-example": "SvelteKit" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "buildRuntime": { + "clientId": { "type": "string", - "description": "Default runtime version.", - "x-example": "node-22" - }, - "runtimes": { - "type": "array", - "description": "List of supported runtime versions.", - "items": { - "type": "string" - }, - "x-example": [ - "static-1", - "node-22" - ] + "description": "GitHub OAuth2 client ID. For GitHub Apps, use the \"App ID\" when both an App ID and client ID are available.", + "x-example": "e4d87900000000540733" }, - "adapters": { - "type": "array", - "description": "List of supported adapters.", - "items": { - "type": "object", - "$ref": "#\/definitions\/frameworkAdapter" - }, - "x-example": [ - { - "key": "static", - "buildRuntime": "node-22", - "buildCommand": "npm run build", - "installCommand": "npm install", - "outputDirectory": ".\/dist" - } - ] + "clientSecret": { + "type": "string", + "description": "GitHub OAuth2 client secret.", + "x-example": "5e07c00000000000000000000000000000198bcc" } }, "required": [ - "key", - "name", - "buildRuntime", - "runtimes", - "adapters" + "$id", + "enabled", + "clientId", + "clientSecret" ], "example": { - "key": "sveltekit", - "name": "SvelteKit", - "buildRuntime": "node-22", - "runtimes": [ - "static-1", - "node-22" - ], - "adapters": [ - { - "key": "static", - "buildRuntime": "node-22", - "buildCommand": "npm run build", - "installCommand": "npm install", - "outputDirectory": ".\/dist" - } - ] + "$id": "github", + "enabled": false, + "clientId": "e4d87900000000540733", + "clientSecret": "5e07c00000000000000000000000000000198bcc" } }, - "frameworkAdapter": { - "description": "Framework Adapter", + "oAuth2Discord": { + "description": "OAuth2Discord", "type": "object", "properties": { - "key": { - "type": "string", - "description": "Adapter key.", - "x-example": "static" - }, - "installCommand": { + "$id": { "type": "string", - "description": "Default command to download dependencies.", - "x-example": "npm install" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "buildCommand": { - "type": "string", - "description": "Default command to build site into output directory.", - "x-example": "npm run build" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "outputDirectory": { + "clientId": { "type": "string", - "description": "Default output directory of build.", - "x-example": ".\/dist" + "description": "Discord OAuth2 client ID.", + "x-example": "950722000000343754" }, - "fallbackFile": { + "clientSecret": { "type": "string", - "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "description": "Discord OAuth2 client secret.", + "x-example": "YmPXnM000000000000000000002zFg5D" } }, "required": [ - "key", - "installCommand", - "buildCommand", - "outputDirectory", - "fallbackFile" + "$id", + "enabled", + "clientId", + "clientSecret" ], "example": { - "key": "static", - "installCommand": "npm install", - "buildCommand": "npm run build", - "outputDirectory": ".\/dist", - "fallbackFile": "index.html" + "$id": "github", + "enabled": false, + "clientId": "950722000000343754", + "clientSecret": "YmPXnM000000000000000000002zFg5D" } }, - "deployment": { - "description": "Deployment", + "oAuth2Figma": { + "description": "OAuth2Figma", "type": "object", "properties": { "$id": { "type": "string", - "description": "Deployment ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Deployment update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Figma OAuth2 client ID.", + "x-example": "byay5H0000000000VtiI40" }, - "type": { + "clientSecret": { "type": "string", - "description": "Type of deployment.", - "x-example": "vcs" - }, - "resourceId": { + "description": "Figma OAuth2 client secret.", + "x-example": "yEpOYn0000000000000000004iIsU5" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "byay5H0000000000VtiI40", + "clientSecret": "yEpOYn0000000000000000004iIsU5" + } + }, + "oAuth2Dropbox": { + "description": "OAuth2Dropbox", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Resource ID.", - "x-example": "5e5ea6g16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "resourceType": { - "type": "string", - "description": "Resource type.", - "x-example": "functions" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "entrypoint": { + "appKey": { "type": "string", - "description": "The entrypoint file to use to execute the deployment code.", - "x-example": "index.js" - }, - "sourceSize": { - "type": "integer", - "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" - }, - "buildSize": { - "type": "integer", - "description": "The build output size in bytes.", - "x-example": 128, - "format": "int32" - }, - "totalSize": { - "type": "integer", - "description": "The total size in bytes (source and build output).", - "x-example": 128, - "format": "int32" + "description": "Dropbox OAuth2 app key.", + "x-example": "jl000000000009t" }, - "buildId": { + "appSecret": { "type": "string", - "description": "The current build ID.", - "x-example": "5e5ea5c16897e" + "description": "Dropbox OAuth2 app secret.", + "x-example": "g200000000000vw" + } + }, + "required": [ + "$id", + "enabled", + "appKey", + "appSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "appKey": "jl000000000009t", + "appSecret": "g200000000000vw" + } + }, + "oAuth2Dailymotion": { + "description": "OAuth2Dailymotion", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "activate": { + "enabled": { "type": "boolean", - "description": "Whether the deployment should be automatically activated.", - "x-example": true - }, - "screenshotLight": { - "type": "string", - "description": "Screenshot with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "screenshotDark": { + "apiKey": { "type": "string", - "description": "Screenshot with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "description": "Dailymotion OAuth2 API key.", + "x-example": "07a9000000000000067f" }, - "status": { + "apiSecret": { "type": "string", - "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", - "x-example": "ready", - "enum": [ - "waiting", - "processing", - "building", - "ready", - "canceled", - "failed" - ] - }, - "buildLogs": { + "description": "Dailymotion OAuth2 API secret.", + "x-example": "a399a90000000000000000000000000000d90639" + } + }, + "required": [ + "$id", + "enabled", + "apiKey", + "apiSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "apiKey": "07a9000000000000067f", + "apiSecret": "a399a90000000000000000000000000000d90639" + } + }, + "oAuth2Bitbucket": { + "description": "OAuth2Bitbucket", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The build logs.", - "x-example": "Compiling source files..." + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "buildDuration": { - "type": "integer", - "description": "The current build time in seconds.", - "x-example": 128, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerRepositoryName": { + "key": { "type": "string", - "description": "The name of the vcs provider repository", - "x-example": "database" + "description": "Bitbucket OAuth2 key.", + "x-example": "Knt70000000000ByRc" }, - "providerRepositoryOwner": { + "secret": { "type": "string", - "description": "The name of the vcs provider repository owner", - "x-example": "utopia" - }, - "providerRepositoryUrl": { + "description": "Bitbucket OAuth2 secret.", + "x-example": "NMfLZJ00000000000000000000TLQdDx" + } + }, + "required": [ + "$id", + "enabled", + "key", + "secret" + ], + "example": { + "$id": "github", + "enabled": false, + "key": "Knt70000000000ByRc", + "secret": "NMfLZJ00000000000000000000TLQdDx" + } + }, + "oAuth2Bitly": { + "description": "OAuth2Bitly", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The url of the vcs provider repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "providerCommitHash": { - "type": "string", - "description": "The commit hash of the vcs commit", - "x-example": "7c3f25d" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerCommitAuthorUrl": { + "clientId": { "type": "string", - "description": "The url of vcs commit author", - "x-example": "https:\/\/github.com\/vermakhushboo" + "description": "Bitly OAuth2 client ID.", + "x-example": "d95151000000000000000000000000000067af9b" }, - "providerCommitAuthor": { + "clientSecret": { "type": "string", - "description": "The name of vcs commit author", - "x-example": "Khushboo Verma" - }, - "providerCommitMessage": { + "description": "Bitly OAuth2 client secret.", + "x-example": "a13e250000000000000000000000000000d73095" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "d95151000000000000000000000000000067af9b", + "clientSecret": "a13e250000000000000000000000000000d73095" + } + }, + "oAuth2Box": { + "description": "OAuth2Box", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "The commit message", - "x-example": "Update index.js" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "providerCommitUrl": { - "type": "string", - "description": "The url of the vcs commit", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "providerBranch": { + "clientId": { "type": "string", - "description": "The branch of the vcs repository", - "x-example": "0.7.x" + "description": "Box OAuth2 client ID.", + "x-example": "deglcs00000000000000000000x2og6y" }, - "providerBranchUrl": { + "clientSecret": { "type": "string", - "description": "The branch of the vcs repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "description": "Box OAuth2 client secret.", + "x-example": "OKM1f100000000000000000000eshEif" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "type", - "resourceId", - "resourceType", - "entrypoint", - "sourceSize", - "buildSize", - "totalSize", - "buildId", - "activate", - "screenshotLight", - "screenshotDark", - "status", - "buildLogs", - "buildDuration", - "providerRepositoryName", - "providerRepositoryOwner", - "providerRepositoryUrl", - "providerCommitHash", - "providerCommitAuthorUrl", - "providerCommitAuthor", - "providerCommitMessage", - "providerCommitUrl", - "providerBranch", - "providerBranchUrl" + "enabled", + "clientId", + "clientSecret" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "type": "vcs", - "resourceId": "5e5ea6g16897e", - "resourceType": "functions", - "entrypoint": "index.js", - "sourceSize": 128, - "buildSize": 128, - "totalSize": 128, - "buildId": "5e5ea5c16897e", - "activate": true, - "screenshotLight": "5e5ea5c16897e", - "screenshotDark": "5e5ea5c16897e", - "status": "ready", - "buildLogs": "Compiling source files...", - "buildDuration": 128, - "providerRepositoryName": "database", - "providerRepositoryOwner": "utopia", - "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function", - "providerCommitHash": "7c3f25d", - "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo", - "providerCommitAuthor": "Khushboo Verma", - "providerCommitMessage": "Update index.js", - "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", - "providerBranch": "0.7.x", - "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "$id": "github", + "enabled": false, + "clientId": "deglcs00000000000000000000x2og6y", + "clientSecret": "OKM1f100000000000000000000eshEif" } }, - "execution": { - "description": "Execution", + "oAuth2Autodesk": { + "description": "OAuth2Autodesk", "type": "object", "properties": { "$id": { "type": "string", - "description": "Execution ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Execution creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Execution update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "$permissions": { - "type": "array", - "description": "Execution roles.", - "items": { - "type": "string" - }, - "x-example": [ - "any" - ] + "description": "Autodesk OAuth2 client ID.", + "x-example": "5zw90v00000000000000000000kVYXN7" }, - "functionId": { + "clientSecret": { "type": "string", - "description": "Function ID.", - "x-example": "5e5ea6g16897e" - }, - "deploymentId": { + "description": "Autodesk OAuth2 client secret.", + "x-example": "7I000000000000MW" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "5zw90v00000000000000000000kVYXN7", + "clientSecret": "7I000000000000MW" + } + }, + "oAuth2Google": { + "description": "OAuth2Google", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Function's deployment ID used to create the execution.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "trigger": { - "type": "string", - "description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.", - "x-example": "http", - "enum": [ - "http", - "schedule", - "event" - ] + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "status": { + "clientId": { "type": "string", - "description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", - "x-example": "processing", - "enum": [ - "waiting", - "processing", - "completed", - "failed", - "scheduled" - ] + "description": "Google OAuth2 client ID.", + "x-example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" }, - "requestMethod": { + "clientSecret": { "type": "string", - "description": "HTTP request method type.", - "x-example": "GET" - }, - "requestPath": { + "description": "Google OAuth2 client secret.", + "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", + "clientSecret": "GOCSPX-2k8gsR0000000000000000VNahJj" + } + }, + "oAuth2Zoom": { + "description": "OAuth2Zoom", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "HTTP request path and query.", - "x-example": "\/articles?id=5" - }, - "requestHeaders": { - "type": "array", - "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", - "items": { - "type": "object", - "$ref": "#\/definitions\/headers" - }, - "x-example": [ - { - "Content-Type": "application\/json" - } - ] + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "responseStatusCode": { - "type": "integer", - "description": "HTTP response status code.", - "x-example": 200, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "responseBody": { + "clientId": { "type": "string", - "description": "HTTP response body. This will return empty unless execution is created as synchronous.", - "x-example": "" - }, - "responseHeaders": { - "type": "array", - "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", - "items": { - "type": "object", - "$ref": "#\/definitions\/headers" - }, - "x-example": [ - { - "Content-Type": "application\/json" - } - ] + "description": "Zoom OAuth2 client ID.", + "x-example": "QMAC00000000000000w0AQ" }, - "logs": { + "clientSecret": { "type": "string", - "description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "description": "Zoom OAuth2 client secret.", + "x-example": "GAWsG4000000000000000000007U01ON" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "QMAC00000000000000w0AQ", + "clientSecret": "GAWsG4000000000000000000007U01ON" + } + }, + "oAuth2Zoho": { + "description": "OAuth2Zoho", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "errors": { + "clientId": { "type": "string", - "description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" - }, - "duration": { - "type": "number", - "description": "Resource(function\/site) execution duration in seconds.", - "x-example": 0.4, - "format": "double" + "description": "Zoho OAuth2 client ID.", + "x-example": "1000.83C178000000000000000000RPNX0B" }, - "scheduledAt": { + "clientSecret": { "type": "string", - "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", - "x-example": "2020-10-15T06:38:00.000+00:00", - "x-nullable": true + "description": "Zoho OAuth2 client secret.", + "x-example": "fb5cac000000000000000000000000000000a68f6e" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "$permissions", - "functionId", - "deploymentId", - "trigger", - "status", - "requestMethod", - "requestPath", - "requestHeaders", - "responseStatusCode", - "responseBody", - "responseHeaders", - "logs", - "errors", - "duration" + "enabled", + "clientId", + "clientSecret" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "$permissions": [ - "any" - ], - "functionId": "5e5ea6g16897e", - "deploymentId": "5e5ea5c16897e", - "trigger": "http", - "status": "processing", - "requestMethod": "GET", - "requestPath": "\/articles?id=5", - "requestHeaders": [ - { - "Content-Type": "application\/json" - } - ], - "responseStatusCode": 200, - "responseBody": "", - "responseHeaders": [ - { - "Content-Type": "application\/json" - } - ], - "logs": "", - "errors": "", - "duration": 0.4, - "scheduledAt": "2020-10-15T06:38:00.000+00:00" + "$id": "github", + "enabled": false, + "clientId": "1000.83C178000000000000000000RPNX0B", + "clientSecret": "fb5cac000000000000000000000000000000a68f6e" } }, - "project": { - "description": "Project", + "oAuth2Yandex": { + "description": "OAuth2Yandex", "type": "object", "properties": { "$id": { "type": "string", - "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "$createdAt": { - "type": "string", - "description": "Project creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "$updatedAt": { + "clientId": { "type": "string", - "description": "Project update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Yandex OAuth2 client ID.", + "x-example": "6a8a6a0000000000000000000091483c" }, - "name": { + "clientSecret": { "type": "string", - "description": "Project name.", - "x-example": "New Project" - }, - "description": { + "description": "Yandex OAuth2 client secret.", + "x-example": "bbf98500000000000000000000c75a63" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "6a8a6a0000000000000000000091483c", + "clientSecret": "bbf98500000000000000000000c75a63" + } + }, + "oAuth2X": { + "description": "OAuth2X", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Project description.", - "x-example": "This is a new project." + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "teamId": { - "type": "string", - "description": "Project team ID.", - "x-example": "1592981250" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "logo": { + "customerKey": { "type": "string", - "description": "Project logo file ID.", - "x-example": "5f5c451b403cb" + "description": "X OAuth2 customer key.", + "x-example": "slzZV0000000000000NFLaWT" }, - "url": { + "secretKey": { "type": "string", - "description": "Project website URL.", - "x-example": "5f5c451b403cb" - }, - "legalName": { + "description": "X OAuth2 secret key.", + "x-example": "tkEPkp00000000000000000000000000000000000000FTxbI9" + } + }, + "required": [ + "$id", + "enabled", + "customerKey", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "customerKey": "slzZV0000000000000NFLaWT", + "secretKey": "tkEPkp00000000000000000000000000000000000000FTxbI9" + } + }, + "oAuth2WordPress": { + "description": "OAuth2WordPress", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Company legal name.", - "x-example": "Company LTD." + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "legalCountry": { - "type": "string", - "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.", - "x-example": "US" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "legalState": { + "clientId": { "type": "string", - "description": "State name.", - "x-example": "New York" + "description": "WordPress OAuth2 client ID.", + "x-example": "130005" }, - "legalCity": { + "clientSecret": { "type": "string", - "description": "City name.", - "x-example": "New York City." - }, - "legalAddress": { + "description": "WordPress OAuth2 client secret.", + "x-example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "130005", + "clientSecret": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" + } + }, + "oAuth2Twitch": { + "description": "OAuth2Twitch", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Company Address.", - "x-example": "620 Eighth Avenue, New York, NY 10018" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "legalTaxId": { + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "clientId": { "type": "string", - "description": "Company Tax ID.", - "x-example": "131102020" + "description": "Twitch OAuth2 client ID.", + "x-example": "vvi0in000000000000000000ikmt9p" }, - "authDuration": { - "type": "integer", - "description": "Session duration in seconds.", - "x-example": 60, - "format": "int32" + "clientSecret": { + "type": "string", + "description": "Twitch OAuth2 client secret.", + "x-example": "pmapue000000000000000000zylw3v" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "vvi0in000000000000000000ikmt9p", + "clientSecret": "pmapue000000000000000000zylw3v" + } + }, + "oAuth2Stripe": { + "description": "OAuth2Stripe", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authLimit": { - "type": "integer", - "description": "Max users allowed. 0 is unlimited.", - "x-example": 100, - "format": "int32" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authSessionsLimit": { - "type": "integer", - "description": "Max sessions allowed per user. 100 maximum.", - "x-example": 10, - "format": "int32" + "clientId": { + "type": "string", + "description": "Stripe OAuth2 client ID.", + "x-example": "ca_UKibXX0000000000000000000006byvR" }, - "authPasswordHistory": { - "type": "integer", - "description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.", - "x-example": 5, - "format": "int32" + "apiSecretKey": { + "type": "string", + "description": "Stripe OAuth2 API secret key.", + "x-example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "apiSecretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "ca_UKibXX0000000000000000000006byvR", + "apiSecretKey": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + } + }, + "oAuth2Spotify": { + "description": "OAuth2Spotify", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authPasswordDictionary": { + "enabled": { "type": "boolean", - "description": "Whether or not to check user's password against most commonly used passwords.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authPersonalDataCheck": { - "type": "boolean", - "description": "Whether or not to check the user password for similarity with their personal data.", - "x-example": true + "clientId": { + "type": "string", + "description": "Spotify OAuth2 client ID.", + "x-example": "6ec271000000000000000000009beace" }, - "authDisposableEmails": { - "type": "boolean", - "description": "Whether or not to disallow disposable email addresses during signup and email updates.", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Spotify OAuth2 client secret.", + "x-example": "db068a000000000000000000008b5b9f" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "6ec271000000000000000000009beace", + "clientSecret": "db068a000000000000000000008b5b9f" + } + }, + "oAuth2Slack": { + "description": "OAuth2Slack", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authCanonicalEmails": { + "enabled": { "type": "boolean", - "description": "Whether or not to require canonical email addresses during signup and email updates.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authFreeEmails": { - "type": "boolean", - "description": "Whether or not to disallow free email addresses during signup and email updates.", - "x-example": true + "clientId": { + "type": "string", + "description": "Slack OAuth2 client ID.", + "x-example": "23000000089.15000000000023" }, - "authMockNumbers": { - "type": "array", - "description": "An array of mock numbers and their corresponding verification codes (OTPs).", - "items": { - "type": "object", - "$ref": "#\/definitions\/mockNumber" - }, - "x-example": [ - {} - ] + "clientSecret": { + "type": "string", + "description": "Slack OAuth2 client secret.", + "x-example": "81656000000000000000000000f3d2fd" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "23000000089.15000000000023", + "clientSecret": "81656000000000000000000000f3d2fd" + } + }, + "oAuth2Podio": { + "description": "OAuth2Podio", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authSessionAlerts": { + "enabled": { "type": "boolean", - "description": "Whether or not to send session alert emails to users.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authMembershipsUserName": { - "type": "boolean", - "description": "Whether or not to show user names in the teams membership response.", - "x-example": true + "clientId": { + "type": "string", + "description": "Podio OAuth2 client ID.", + "x-example": "appwrite-oauth-test-app" }, - "authMembershipsUserEmail": { - "type": "boolean", - "description": "Whether or not to show user emails in the teams membership response.", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Podio OAuth2 client secret.", + "x-example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "appwrite-oauth-test-app", + "clientSecret": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + } + }, + "oAuth2Notion": { + "description": "OAuth2Notion", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authMembershipsMfa": { + "enabled": { "type": "boolean", - "description": "Whether or not to show user MFA status in the teams membership response.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authMembershipsUserId": { - "type": "boolean", - "description": "Whether or not to show user IDs in the teams membership response.", - "x-example": true + "oauthClientId": { + "type": "string", + "description": "Notion OAuth2 client ID.", + "x-example": "341d8700-0000-0000-0000-000000446ee3" }, - "authMembershipsUserPhone": { - "type": "boolean", - "description": "Whether or not to show user phone numbers in the teams membership response.", - "x-example": true + "oauthClientSecret": { + "type": "string", + "description": "Notion OAuth2 client secret.", + "x-example": "secret_dLUr4b000000000000000000000000000000lFHAa9" + } + }, + "required": [ + "$id", + "enabled", + "oauthClientId", + "oauthClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "oauthClientId": "341d8700-0000-0000-0000-000000446ee3", + "oauthClientSecret": "secret_dLUr4b000000000000000000000000000000lFHAa9" + } + }, + "oAuth2Salesforce": { + "description": "OAuth2Salesforce", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authInvalidateSessions": { + "enabled": { "type": "boolean", - "description": "Whether or not all existing sessions should be invalidated on password change", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "oAuthProviders": { - "type": "array", - "description": "List of Auth Providers.", - "items": { - "type": "object", - "$ref": "#\/definitions\/authProvider" - }, - "x-example": [ - {} - ] + "customerKey": { + "type": "string", + "description": "Salesforce OAuth2 consumer key.", + "x-example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" }, - "platforms": { - "type": "array", - "description": "List of Platforms.", - "items": { - "x-anyOf": [ - { - "$ref": "#\/definitions\/platformWeb" - }, - { - "$ref": "#\/definitions\/platformApple" - }, - { - "$ref": "#\/definitions\/platformAndroid" - }, - { - "$ref": "#\/definitions\/platformWindows" - }, - { - "$ref": "#\/definitions\/platformLinux" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "web": "#\/definitions\/platformWeb", - "apple": "#\/definitions\/platformApple", - "android": "#\/definitions\/platformAndroid", - "windows": "#\/definitions\/platformWindows", - "linux": "#\/definitions\/platformLinux" - } - } - }, - "x-example": {} + "customerSecret": { + "type": "string", + "description": "Salesforce OAuth2 consumer secret.", + "x-example": "3w000000000000e2" + } + }, + "required": [ + "$id", + "enabled", + "customerKey", + "customerSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "customerKey": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", + "customerSecret": "3w000000000000e2" + } + }, + "oAuth2Yahoo": { + "description": "OAuth2Yahoo", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "webhooks": { - "type": "array", - "description": "List of Webhooks.", - "items": { - "type": "object", - "$ref": "#\/definitions\/webhook" - }, - "x-example": {} + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "keys": { - "type": "array", - "description": "List of API Keys.", - "items": { - "type": "object", - "$ref": "#\/definitions\/key" - }, - "x-example": {} + "clientId": { + "type": "string", + "description": "Yahoo OAuth2 client ID.", + "x-example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" }, - "devKeys": { - "type": "array", - "description": "List of dev keys.", - "items": { - "type": "object", - "$ref": "#\/definitions\/devKey" - }, - "x-example": {} + "clientSecret": { + "type": "string", + "description": "Yahoo OAuth2 client secret.", + "x-example": "cf978f0000000000000000000000000000c5e2e9" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", + "clientSecret": "cf978f0000000000000000000000000000c5e2e9" + } + }, + "oAuth2Linkedin": { + "description": "OAuth2Linkedin", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpEnabled": { + "enabled": { "type": "boolean", - "description": "Status for custom SMTP", + "description": "OAuth2 provider is active and can be used to create sessions.", "x-example": false }, - "smtpSenderName": { + "clientId": { "type": "string", - "description": "SMTP sender name", - "x-example": "John Appwrite" + "description": "LinkedIn OAuth2 client ID.", + "x-example": "770000000000dv" }, - "smtpSenderEmail": { + "primaryClientSecret": { "type": "string", - "description": "SMTP sender email", - "x-example": "john@appwrite.io" - }, - "smtpReplyToName": { + "description": "LinkedIn OAuth2 primary client secret.", + "x-example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "primaryClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "770000000000dv", + "primaryClientSecret": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + } + }, + "oAuth2Disqus": { + "description": "OAuth2Disqus", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "SMTP reply to name", - "x-example": "Support Team" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpReplyToEmail": { - "type": "string", - "description": "SMTP reply to email", - "x-example": "support@appwrite.io" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "smtpHost": { + "publicKey": { "type": "string", - "description": "SMTP server host name", - "x-example": "mail.appwrite.io" - }, - "smtpPort": { - "type": "integer", - "description": "SMTP server port", - "x-example": 25, - "format": "int32" + "description": "Disqus OAuth2 public key.", + "x-example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" }, - "smtpUsername": { + "secretKey": { + "type": "string", + "description": "Disqus OAuth2 secret key.", + "x-example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + } + }, + "required": [ + "$id", + "enabled", + "publicKey", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "publicKey": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", + "secretKey": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + } + }, + "oAuth2Amazon": { + "description": "OAuth2Amazon", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "SMTP server username", - "x-example": "emailuser" + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "smtpPassword": { - "type": "string", - "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "smtpSecure": { + "clientId": { "type": "string", - "description": "SMTP server secure protocol", - "x-example": "tls" - }, - "pingCount": { - "type": "integer", - "description": "Number of times the ping was received for this project.", - "x-example": 1, - "format": "int32" + "description": "Amazon OAuth2 client ID.", + "x-example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" }, - "pingedAt": { + "clientSecret": { "type": "string", - "description": "Last ping datetime in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Amazon OAuth2 client secret.", + "x-example": "79ffe4000000000000000000000000000000000000000000000000000002de55" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2", + "clientSecret": "79ffe4000000000000000000000000000000000000000000000000000002de55" + } + }, + "oAuth2Etsy": { + "description": "OAuth2Etsy", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "labels": { - "type": "array", - "description": "Labels for the project.", - "items": { - "type": "string" - }, - "x-example": [ - "vip" - ] + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "status": { + "keyString": { "type": "string", - "description": "Project status", - "x-example": "active" + "description": "Etsy OAuth2 keystring.", + "x-example": "nsgzxh0000000000008j85a2" }, - "authEmailPassword": { - "type": "boolean", - "description": "Email\/Password auth method status", - "x-example": true + "sharedSecret": { + "type": "string", + "description": "Etsy OAuth2 shared secret.", + "x-example": "tp000000ru" + } + }, + "required": [ + "$id", + "enabled", + "keyString", + "sharedSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "keyString": "nsgzxh0000000000008j85a2", + "sharedSecret": "tp000000ru" + } + }, + "oAuth2Facebook": { + "description": "OAuth2Facebook", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authUsersAuthMagicURL": { + "enabled": { "type": "boolean", - "description": "Magic URL auth method status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authEmailOtp": { - "type": "boolean", - "description": "Email (OTP) auth method status", - "x-example": true + "appId": { + "type": "string", + "description": "Facebook OAuth2 app ID.", + "x-example": "260600000007694" }, - "authAnonymous": { - "type": "boolean", - "description": "Anonymous auth method status", - "x-example": true + "appSecret": { + "type": "string", + "description": "Facebook OAuth2 app secret.", + "x-example": "2d0b2800000000000000000000d38af4" + } + }, + "required": [ + "$id", + "enabled", + "appId", + "appSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "appId": "260600000007694", + "appSecret": "2d0b2800000000000000000000d38af4" + } + }, + "oAuth2Tradeshift": { + "description": "OAuth2Tradeshift", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "authInvites": { + "enabled": { "type": "boolean", - "description": "Invites auth method status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authJWT": { - "type": "boolean", - "description": "JWT auth method status", - "x-example": true + "oauth2ClientId": { + "type": "string", + "description": "Tradeshift OAuth2 client ID.", + "x-example": "appwrite-test-org.appwrite-test-app" }, - "authPhone": { - "type": "boolean", - "description": "Phone auth method status", - "x-example": true + "oauth2ClientSecret": { + "type": "string", + "description": "Tradeshift OAuth2 client secret.", + "x-example": "7cb52700-0000-0000-0000-000000ca5b83" + } + }, + "required": [ + "$id", + "enabled", + "oauth2ClientId", + "oauth2ClientSecret" + ], + "example": { + "$id": "github", + "enabled": false, + "oauth2ClientId": "appwrite-test-org.appwrite-test-app", + "oauth2ClientSecret": "7cb52700-0000-0000-0000-000000ca5b83" + } + }, + "oAuth2Paypal": { + "description": "OAuth2Paypal", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForAccount": { + "enabled": { "type": "boolean", - "description": "Account service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForAvatars": { - "type": "boolean", - "description": "Avatars service status", - "x-example": true + "clientId": { + "type": "string", + "description": "PayPal OAuth2 client ID.", + "x-example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" }, - "serviceStatusForDatabases": { - "type": "boolean", - "description": "Databases (legacy) service status", - "x-example": true + "secretKey": { + "type": "string", + "description": "PayPal OAuth2 secret key.", + "x-example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "secretKey" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "secretKey": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + } + }, + "oAuth2Gitlab": { + "description": "OAuth2Gitlab", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForTablesdb": { + "enabled": { "type": "boolean", - "description": "TablesDB service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForLocale": { - "type": "boolean", - "description": "Locale service status", - "x-example": true + "applicationId": { + "type": "string", + "description": "GitLab OAuth2 application ID.", + "x-example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" }, - "serviceStatusForHealth": { - "type": "boolean", - "description": "Health service status", - "x-example": true + "secret": { + "type": "string", + "description": "GitLab OAuth2 secret.", + "x-example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" }, - "serviceStatusForProject": { - "type": "boolean", - "description": "Project service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "GitLab OAuth2 endpoint URL. Defaults to https:\/\/gitlab.com for self-hosted instances.", + "x-example": "https:\/\/gitlab.com" + } + }, + "required": [ + "$id", + "enabled", + "applicationId", + "secret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "applicationId": "d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "secret": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "endpoint": "https:\/\/gitlab.com" + } + }, + "oAuth2Authentik": { + "description": "OAuth2Authentik", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForStorage": { + "enabled": { "type": "boolean", - "description": "Storage service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForTeams": { - "type": "boolean", - "description": "Teams service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Authentik OAuth2 client ID.", + "x-example": "dTKOPa0000000000000000000000000000e7G8hv" }, - "serviceStatusForUsers": { - "type": "boolean", - "description": "Users service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Authentik OAuth2 client secret.", + "x-example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" }, - "serviceStatusForVcs": { - "type": "boolean", - "description": "VCS service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Authentik OAuth2 endpoint domain.", + "x-example": "example.authentik.com" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "dTKOPa0000000000000000000000000000e7G8hv", + "clientSecret": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", + "endpoint": "example.authentik.com" + } + }, + "oAuth2Auth0": { + "description": "OAuth2Auth0", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForSites": { + "enabled": { "type": "boolean", - "description": "Sites service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForFunctions": { - "type": "boolean", - "description": "Functions service status", - "x-example": true + "clientId": { + "type": "string", + "description": "Auth0 OAuth2 client ID.", + "x-example": "OaOkIA000000000000000000005KLSYq" }, - "serviceStatusForProxy": { - "type": "boolean", - "description": "Proxy service status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "Auth0 OAuth2 client secret.", + "x-example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" }, - "serviceStatusForGraphql": { - "type": "boolean", - "description": "GraphQL service status", - "x-example": true + "endpoint": { + "type": "string", + "description": "Auth0 OAuth2 endpoint domain.", + "x-example": "example.us.auth0.com" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "OaOkIA000000000000000000005KLSYq", + "clientSecret": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", + "endpoint": "example.us.auth0.com" + } + }, + "oAuth2FusionAuth": { + "description": "OAuth2FusionAuth", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "serviceStatusForMigrations": { + "enabled": { "type": "boolean", - "description": "Migrations service status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "serviceStatusForMessaging": { - "type": "boolean", - "description": "Messaging service status", - "x-example": true + "clientId": { + "type": "string", + "description": "FusionAuth OAuth2 client ID.", + "x-example": "b2222c00-0000-0000-0000-000000862097" }, - "protocolStatusForRest": { - "type": "boolean", - "description": "REST protocol status", - "x-example": true + "clientSecret": { + "type": "string", + "description": "FusionAuth OAuth2 client secret.", + "x-example": "Jx4s0C0000000000000000000000000000000wGqLsc" }, - "protocolStatusForGraphql": { - "type": "boolean", - "description": "GraphQL protocol status", - "x-example": true + "endpoint": { + "type": "string", + "description": "FusionAuth OAuth2 endpoint domain.", + "x-example": "example.fusionauth.io" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "endpoint" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "b2222c00-0000-0000-0000-000000862097", + "clientSecret": "Jx4s0C0000000000000000000000000000000wGqLsc", + "endpoint": "example.fusionauth.io" + } + }, + "oAuth2Keycloak": { + "description": "OAuth2Keycloak", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "protocolStatusForWebsocket": { + "enabled": { "type": "boolean", - "description": "Websocket protocol status", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "region": { + "clientId": { "type": "string", - "description": "Project region", - "x-example": "fra" + "description": "Keycloak OAuth2 client ID.", + "x-example": "appwrite-o0000000st-app" }, - "billingLimits": { - "type": "object", - "description": "Billing limits reached", - "x-example": "", - "items": { - "type": "object", - "$ref": "#\/definitions\/billingLimits" - } + "clientSecret": { + "type": "string", + "description": "Keycloak OAuth2 client secret.", + "x-example": "jdjrJd00000000000000000000HUsaZO" }, - "blocks": { - "type": "array", - "description": "Project blocks information", - "items": { - "type": "object", - "$ref": "#\/definitions\/block" - }, - "x-example": "" + "endpoint": { + "type": "string", + "description": "Keycloak OAuth2 endpoint domain.", + "x-example": "keycloak.example.com" }, - "consoleAccessedAt": { + "realmName": { "type": "string", - "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Keycloak OAuth2 realm name.", + "x-example": "appwrite-realm" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "description", - "teamId", - "logo", - "url", - "legalName", - "legalCountry", - "legalState", - "legalCity", - "legalAddress", - "legalTaxId", - "authDuration", - "authLimit", - "authSessionsLimit", - "authPasswordHistory", - "authPasswordDictionary", - "authPersonalDataCheck", - "authDisposableEmails", - "authCanonicalEmails", - "authFreeEmails", - "authMockNumbers", - "authSessionAlerts", - "authMembershipsUserName", - "authMembershipsUserEmail", - "authMembershipsMfa", - "authMembershipsUserId", - "authMembershipsUserPhone", - "authInvalidateSessions", - "oAuthProviders", - "platforms", - "webhooks", - "keys", - "devKeys", - "smtpEnabled", - "smtpSenderName", - "smtpSenderEmail", - "smtpReplyToName", - "smtpReplyToEmail", - "smtpHost", - "smtpPort", - "smtpUsername", - "smtpPassword", - "smtpSecure", - "pingCount", - "pingedAt", - "labels", - "status", - "authEmailPassword", - "authUsersAuthMagicURL", - "authEmailOtp", - "authAnonymous", - "authInvites", - "authJWT", - "authPhone", - "serviceStatusForAccount", - "serviceStatusForAvatars", - "serviceStatusForDatabases", - "serviceStatusForTablesdb", - "serviceStatusForLocale", - "serviceStatusForHealth", - "serviceStatusForProject", - "serviceStatusForStorage", - "serviceStatusForTeams", - "serviceStatusForUsers", - "serviceStatusForVcs", - "serviceStatusForSites", - "serviceStatusForFunctions", - "serviceStatusForProxy", - "serviceStatusForGraphql", - "serviceStatusForMigrations", - "serviceStatusForMessaging", - "protocolStatusForRest", - "protocolStatusForGraphql", - "protocolStatusForWebsocket", - "region", - "billingLimits", - "blocks", - "consoleAccessedAt" + "enabled", + "clientId", + "clientSecret", + "endpoint", + "realmName" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "New Project", - "description": "This is a new project.", - "teamId": "1592981250", - "logo": "5f5c451b403cb", - "url": "5f5c451b403cb", - "legalName": "Company LTD.", - "legalCountry": "US", - "legalState": "New York", - "legalCity": "New York City.", - "legalAddress": "620 Eighth Avenue, New York, NY 10018", - "legalTaxId": "131102020", - "authDuration": 60, - "authLimit": 100, - "authSessionsLimit": 10, - "authPasswordHistory": 5, - "authPasswordDictionary": true, - "authPersonalDataCheck": true, - "authDisposableEmails": true, - "authCanonicalEmails": true, - "authFreeEmails": true, - "authMockNumbers": [ - {} - ], - "authSessionAlerts": true, - "authMembershipsUserName": true, - "authMembershipsUserEmail": true, - "authMembershipsMfa": true, - "authMembershipsUserId": true, - "authMembershipsUserPhone": true, - "authInvalidateSessions": true, - "oAuthProviders": [ - {} - ], - "platforms": {}, - "webhooks": {}, - "keys": {}, - "devKeys": {}, - "smtpEnabled": false, - "smtpSenderName": "John Appwrite", - "smtpSenderEmail": "john@appwrite.io", - "smtpReplyToName": "Support Team", - "smtpReplyToEmail": "support@appwrite.io", - "smtpHost": "mail.appwrite.io", - "smtpPort": 25, - "smtpUsername": "emailuser", - "smtpPassword": "", - "smtpSecure": "tls", - "pingCount": 1, - "pingedAt": "2020-10-15T06:38:00.000+00:00", - "labels": [ - "vip" - ], - "status": "active", - "authEmailPassword": true, - "authUsersAuthMagicURL": true, - "authEmailOtp": true, - "authAnonymous": true, - "authInvites": true, - "authJWT": true, - "authPhone": true, - "serviceStatusForAccount": true, - "serviceStatusForAvatars": true, - "serviceStatusForDatabases": true, - "serviceStatusForTablesdb": true, - "serviceStatusForLocale": true, - "serviceStatusForHealth": true, - "serviceStatusForProject": true, - "serviceStatusForStorage": true, - "serviceStatusForTeams": true, - "serviceStatusForUsers": true, - "serviceStatusForVcs": true, - "serviceStatusForSites": true, - "serviceStatusForFunctions": true, - "serviceStatusForProxy": true, - "serviceStatusForGraphql": true, - "serviceStatusForMigrations": true, - "serviceStatusForMessaging": true, - "protocolStatusForRest": true, - "protocolStatusForGraphql": true, - "protocolStatusForWebsocket": true, - "region": "fra", - "billingLimits": "", - "blocks": "", - "consoleAccessedAt": "2020-10-15T06:38:00.000+00:00" + "$id": "github", + "enabled": false, + "clientId": "appwrite-o0000000st-app", + "clientSecret": "jdjrJd00000000000000000000HUsaZO", + "endpoint": "keycloak.example.com", + "realmName": "appwrite-realm" } }, - "webhook": { - "description": "Webhook", + "oAuth2Oidc": { + "description": "OAuth2Oidc", "type": "object", "properties": { "$id": { "type": "string", - "description": "Webhook ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "github" + }, + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "clientId": { + "type": "string", + "description": "OpenID Connect OAuth2 client ID.", + "x-example": "qibI2x0000000000000000000000000006L2YFoG" }, - "$createdAt": { + "clientSecret": { "type": "string", - "description": "Webhook creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "OpenID Connect OAuth2 client secret.", + "x-example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" }, - "$updatedAt": { + "wellKnownURL": { "type": "string", - "description": "Webhook update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "OpenID Connect well-known configuration URL. When set, authorization, token, and user info endpoints can be discovered automatically.", + "x-example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" }, - "name": { + "authorizationURL": { "type": "string", - "description": "Webhook name.", - "x-example": "My Webhook" + "description": "OpenID Connect authorization endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" }, - "url": { + "tokenUrl": { "type": "string", - "description": "Webhook URL endpoint.", - "x-example": "https:\/\/example.com\/webhook" + "description": "OpenID Connect token endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/token" }, - "events": { - "type": "array", - "description": "Webhook trigger events.", - "items": { - "type": "string" - }, - "x-example": [ - "databases.tables.update", - "databases.collections.update" - ] + "userInfoUrl": { + "type": "string", + "description": "OpenID Connect user info endpoint URL.", + "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "wellKnownURL", + "authorizationURL", + "tokenUrl", + "userInfoUrl" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "qibI2x0000000000000000000000000006L2YFoG", + "clientSecret": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", + "wellKnownURL": "https:\/\/myoauth.com\/.well-known\/openid-configuration", + "authorizationURL": "https:\/\/myoauth.com\/oauth2\/authorize", + "tokenUrl": "https:\/\/myoauth.com\/oauth2\/token", + "userInfoUrl": "https:\/\/myoauth.com\/oauth2\/userinfo" + } + }, + "oAuth2Okta": { + "description": "OAuth2Okta", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "tls": { + "enabled": { "type": "boolean", - "description": "Indicates if SSL \/ TLS certificate verification is enabled.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "authUsername": { + "clientId": { "type": "string", - "description": "HTTP basic authentication username.", - "x-example": "username" + "description": "Okta OAuth2 client ID.", + "x-example": "0oa00000000000000698" }, - "authPassword": { + "clientSecret": { "type": "string", - "description": "HTTP basic authentication password.", - "x-example": "password" + "description": "Okta OAuth2 client secret.", + "x-example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" }, - "secret": { + "domain": { "type": "string", - "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", - "x-example": "ad3d581ca230e2b7059c545e5a" + "description": "Okta OAuth2 domain.", + "x-example": "trial-6400025.okta.com" + }, + "authorizationServerId": { + "type": "string", + "description": "Okta OAuth2 authorization server ID.", + "x-example": "aus000000000000000h7z" + } + }, + "required": [ + "$id", + "enabled", + "clientId", + "clientSecret", + "domain", + "authorizationServerId" + ], + "example": { + "$id": "github", + "enabled": false, + "clientId": "0oa00000000000000698", + "clientSecret": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "domain": "trial-6400025.okta.com", + "authorizationServerId": "aus000000000000000h7z" + } + }, + "oAuth2Kick": { + "description": "OAuth2Kick", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, "enabled": { "type": "boolean", - "description": "Indicates if this webhook is enabled.", - "x-example": true + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "logs": { + "clientId": { "type": "string", - "description": "Webhook error logs from the most recent failure.", - "x-example": "Failed to connect to remote server." + "description": "Kick OAuth2 client ID.", + "x-example": "01KQ7C00000000000001MFHS32" }, - "attempts": { - "type": "integer", - "description": "Number of consecutive failed webhook attempts.", - "x-example": 10, - "format": "int32" + "clientSecret": { + "type": "string", + "description": "Kick OAuth2 client secret.", + "x-example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "url", - "events", - "tls", - "authUsername", - "authPassword", - "secret", "enabled", - "logs", - "attempts" + "clientId", + "clientSecret" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My Webhook", - "url": "https:\/\/example.com\/webhook", - "events": [ - "databases.tables.update", - "databases.collections.update" - ], - "tls": true, - "authUsername": "username", - "authPassword": "password", - "secret": "ad3d581ca230e2b7059c545e5a", - "enabled": true, - "logs": "Failed to connect to remote server.", - "attempts": 10 + "$id": "github", + "enabled": false, + "clientId": "01KQ7C00000000000001MFHS32", + "clientSecret": "34ac5600000000000000000000000000000000000000000000000000e830c8b" } }, - "key": { - "description": "Key", + "oAuth2Apple": { + "description": "OAuth2Apple", "type": "object", "properties": { "$id": { "type": "string", - "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "description": "OAuth2 provider ID.", + "x-example": "apple" }, - "$createdAt": { + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false + }, + "serviceId": { "type": "string", - "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Apple OAuth2 service ID.", + "x-example": "ip.appwrite.app.web" }, - "$updatedAt": { + "keyId": { "type": "string", - "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Apple OAuth2 key ID.", + "x-example": "P4000000N8" }, - "name": { + "teamId": { "type": "string", - "description": "Key name.", - "x-example": "My API Key" + "description": "Apple OAuth2 team ID.", + "x-example": "D4000000R6" }, - "expire": { + "p8File": { "type": "string", - "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.", + "x-example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" + } + }, + "required": [ + "$id", + "enabled", + "serviceId", + "keyId", + "teamId", + "p8File" + ], + "example": { + "$id": "apple", + "enabled": false, + "serviceId": "ip.appwrite.app.web", + "keyId": "P4000000N8", + "teamId": "D4000000R6", + "p8File": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" + } + }, + "oAuth2Microsoft": { + "description": "OAuth2Microsoft", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "OAuth2 provider ID.", + "x-example": "github" }, - "scopes": { - "type": "array", - "description": "Allowed permission scopes.", - "items": { - "type": "string" - }, - "x-example": "users.read" + "enabled": { + "type": "boolean", + "description": "OAuth2 provider is active and can be used to create sessions.", + "x-example": false }, - "secret": { + "applicationId": { "type": "string", - "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "description": "Microsoft OAuth2 application ID.", + "x-example": "00001111-aaaa-2222-bbbb-3333cccc4444" }, - "accessedAt": { + "applicationSecret": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Microsoft OAuth2 application secret.", + "x-example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" }, - "sdks": { + "tenant": { + "type": "string", + "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID.", + "x-example": "common" + } + }, + "required": [ + "$id", + "enabled", + "applicationId", + "applicationSecret", + "tenant" + ], + "example": { + "$id": "github", + "enabled": false, + "applicationId": "00001111-aaaa-2222-bbbb-3333cccc4444", + "applicationSecret": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", + "tenant": "common" + } + }, + "oAuth2ProviderList": { + "description": "OAuth2 Providers List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of OAuth2 providers in the given project.", + "x-example": 5, + "format": "int32" + }, + "providers": { "type": "array", - "description": "List of SDK user agents that used this key.", + "description": "List of OAuth2 providers.", "items": { - "type": "string" + "x-anyOf": [ + { + "$ref": "#\/definitions\/oAuth2Github" + }, + { + "$ref": "#\/definitions\/oAuth2Discord" + }, + { + "$ref": "#\/definitions\/oAuth2Figma" + }, + { + "$ref": "#\/definitions\/oAuth2Dropbox" + }, + { + "$ref": "#\/definitions\/oAuth2Dailymotion" + }, + { + "$ref": "#\/definitions\/oAuth2Bitbucket" + }, + { + "$ref": "#\/definitions\/oAuth2Bitly" + }, + { + "$ref": "#\/definitions\/oAuth2Box" + }, + { + "$ref": "#\/definitions\/oAuth2Autodesk" + }, + { + "$ref": "#\/definitions\/oAuth2Google" + }, + { + "$ref": "#\/definitions\/oAuth2Zoom" + }, + { + "$ref": "#\/definitions\/oAuth2Zoho" + }, + { + "$ref": "#\/definitions\/oAuth2Yandex" + }, + { + "$ref": "#\/definitions\/oAuth2X" + }, + { + "$ref": "#\/definitions\/oAuth2WordPress" + }, + { + "$ref": "#\/definitions\/oAuth2Twitch" + }, + { + "$ref": "#\/definitions\/oAuth2Stripe" + }, + { + "$ref": "#\/definitions\/oAuth2Spotify" + }, + { + "$ref": "#\/definitions\/oAuth2Slack" + }, + { + "$ref": "#\/definitions\/oAuth2Podio" + }, + { + "$ref": "#\/definitions\/oAuth2Notion" + }, + { + "$ref": "#\/definitions\/oAuth2Salesforce" + }, + { + "$ref": "#\/definitions\/oAuth2Yahoo" + }, + { + "$ref": "#\/definitions\/oAuth2Linkedin" + }, + { + "$ref": "#\/definitions\/oAuth2Disqus" + }, + { + "$ref": "#\/definitions\/oAuth2Amazon" + }, + { + "$ref": "#\/definitions\/oAuth2Etsy" + }, + { + "$ref": "#\/definitions\/oAuth2Facebook" + }, + { + "$ref": "#\/definitions\/oAuth2Tradeshift" + }, + { + "$ref": "#\/definitions\/oAuth2Paypal" + }, + { + "$ref": "#\/definitions\/oAuth2Gitlab" + }, + { + "$ref": "#\/definitions\/oAuth2Authentik" + }, + { + "$ref": "#\/definitions\/oAuth2Auth0" + }, + { + "$ref": "#\/definitions\/oAuth2FusionAuth" + }, + { + "$ref": "#\/definitions\/oAuth2Keycloak" + }, + { + "$ref": "#\/definitions\/oAuth2Oidc" + }, + { + "$ref": "#\/definitions\/oAuth2Apple" + }, + { + "$ref": "#\/definitions\/oAuth2Okta" + }, + { + "$ref": "#\/definitions\/oAuth2Kick" + }, + { + "$ref": "#\/definitions\/oAuth2Microsoft" + } + ], + "x-discriminator": { + "propertyName": "$id", + "mapping": { + "github": "#\/definitions\/oAuth2Github", + "discord": "#\/definitions\/oAuth2Discord", + "figma": "#\/definitions\/oAuth2Figma", + "dropbox": "#\/definitions\/oAuth2Dropbox", + "dailymotion": "#\/definitions\/oAuth2Dailymotion", + "bitbucket": "#\/definitions\/oAuth2Bitbucket", + "bitly": "#\/definitions\/oAuth2Bitly", + "box": "#\/definitions\/oAuth2Box", + "autodesk": "#\/definitions\/oAuth2Autodesk", + "google": "#\/definitions\/oAuth2Google", + "zoom": "#\/definitions\/oAuth2Zoom", + "zoho": "#\/definitions\/oAuth2Zoho", + "yandex": "#\/definitions\/oAuth2Yandex", + "x": "#\/definitions\/oAuth2X", + "wordpress": "#\/definitions\/oAuth2WordPress", + "twitch": "#\/definitions\/oAuth2Twitch", + "stripe": "#\/definitions\/oAuth2Stripe", + "spotify": "#\/definitions\/oAuth2Spotify", + "slack": "#\/definitions\/oAuth2Slack", + "podio": "#\/definitions\/oAuth2Podio", + "notion": "#\/definitions\/oAuth2Notion", + "salesforce": "#\/definitions\/oAuth2Salesforce", + "yahoo": "#\/definitions\/oAuth2Yahoo", + "linkedin": "#\/definitions\/oAuth2Linkedin", + "disqus": "#\/definitions\/oAuth2Disqus", + "amazon": "#\/definitions\/oAuth2Amazon", + "etsy": "#\/definitions\/oAuth2Etsy", + "facebook": "#\/definitions\/oAuth2Facebook", + "tradeshift": "#\/definitions\/oAuth2Tradeshift", + "tradeshiftBox": "#\/definitions\/oAuth2Tradeshift", + "paypal": "#\/definitions\/oAuth2Paypal", + "paypalSandbox": "#\/definitions\/oAuth2Paypal", + "gitlab": "#\/definitions\/oAuth2Gitlab", + "authentik": "#\/definitions\/oAuth2Authentik", + "auth0": "#\/definitions\/oAuth2Auth0", + "fusionauth": "#\/definitions\/oAuth2FusionAuth", + "keycloak": "#\/definitions\/oAuth2Keycloak", + "oidc": "#\/definitions\/oAuth2Oidc", + "apple": "#\/definitions\/oAuth2Apple", + "okta": "#\/definitions\/oAuth2Okta", + "kick": "#\/definitions\/oAuth2Kick", + "microsoft": "#\/definitions\/oAuth2Microsoft" + } + } }, - "x-example": "appwrite:flutter" + "x-example": "" } }, "required": [ - "$id", - "$createdAt", - "$updatedAt", - "name", - "expire", - "scopes", - "secret", - "accessedAt", - "sdks" + "total", + "providers" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "My API Key", - "expire": "2020-10-15T06:38:00.000+00:00", - "scopes": "users.read", - "secret": "919c2d18fb5d4...a2ae413da83346ad2", - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "sdks": "appwrite:flutter" + "total": 5, + "providers": "" } }, - "devKey": { - "description": "DevKey", + "policyPasswordDictionary": { + "description": "Policy Password Dictionary", "type": "object", "properties": { "$id": { "type": "string", - "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "$createdAt": { + "enabled": { + "type": "boolean", + "description": "Whether password dictionary policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policyPasswordHistory": { + "description": "Policy Password History", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "$updatedAt": { + "total": { + "type": "integer", + "description": "Password history length. A value of 0 means the policy is disabled.", + "x-example": 5, + "format": "int32" + } + }, + "required": [ + "$id", + "total" + ], + "example": { + "$id": "password-dictionary", + "total": 5 + } + }, + "policyPasswordPersonalData": { + "description": "Policy Password Personal Data", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "name": { + "enabled": { + "type": "boolean", + "description": "Whether password personal data policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionAlert": { + "description": "Policy Session Alert", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key name.", - "x-example": "Dev API Key" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "expire": { + "enabled": { + "type": "boolean", + "description": "Whether session alert policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionDuration": { + "description": "Policy Session Duration", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "secret": { + "duration": { + "type": "integer", + "description": "Session duration in seconds.", + "x-example": 3600, + "format": "int32" + } + }, + "required": [ + "$id", + "duration" + ], + "example": { + "$id": "password-dictionary", + "duration": 3600 + } + }, + "policySessionInvalidation": { + "description": "Policy Session Invalidation", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "accessedAt": { + "enabled": { + "type": "boolean", + "description": "Whether session invalidation policy is enabled.", + "x-example": true + } + }, + "required": [ + "$id", + "enabled" + ], + "example": { + "$id": "password-dictionary", + "enabled": true + } + }, + "policySessionLimit": { + "description": "Policy Session Limit", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "sdks": { - "type": "array", - "description": "List of SDK user agents that used this key.", - "items": { - "type": "string" - }, - "x-example": "appwrite:flutter" + "total": { + "type": "integer", + "description": "Maximum number of sessions allowed per user. A value of 0 means the policy is disabled.", + "x-example": 10, + "format": "int32" } }, "required": [ "$id", - "$createdAt", - "$updatedAt", - "name", - "expire", - "secret", - "accessedAt", - "sdks" + "total" ], "example": { - "$id": "5e5ea5c16897e", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "Dev API Key", - "expire": "2020-10-15T06:38:00.000+00:00", - "secret": "919c2d18fb5d4...a2ae413da83346ad2", - "accessedAt": "2020-10-15T06:38:00.000+00:00", - "sdks": "appwrite:flutter" + "$id": "password-dictionary", + "total": 10 } }, - "mockNumber": { - "description": "Mock Number", + "policyUserLimit": { + "description": "Policy User Limit", "type": "object", "properties": { - "phone": { + "$id": { "type": "string", - "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", - "x-example": "+1612842323" + "description": "Policy ID.", + "x-example": "password-dictionary" }, - "otp": { + "total": { + "type": "integer", + "description": "Maximum number of users allowed in the project. A value of 0 means the policy is disabled.", + "x-example": 100, + "format": "int32" + } + }, + "required": [ + "$id", + "total" + ], + "example": { + "$id": "password-dictionary", + "total": 100 + } + }, + "policyMembershipPrivacy": { + "description": "Policy Membership Privacy", + "type": "object", + "properties": { + "$id": { "type": "string", - "description": "Mock OTP for the number. ", - "x-example": "123456" + "description": "Policy ID.", + "x-example": "password-dictionary" + }, + "userId": { + "type": "boolean", + "description": "Whether user ID is visible in memberships.", + "x-example": true + }, + "userEmail": { + "type": "boolean", + "description": "Whether user email is visible in memberships.", + "x-example": true + }, + "userPhone": { + "type": "boolean", + "description": "Whether user phone is visible in memberships.", + "x-example": true + }, + "userName": { + "type": "boolean", + "description": "Whether user name is visible in memberships.", + "x-example": true + }, + "userMFA": { + "type": "boolean", + "description": "Whether user MFA status is visible in memberships.", + "x-example": true } }, "required": [ - "phone", - "otp" + "$id", + "userId", + "userEmail", + "userPhone", + "userName", + "userMFA" ], "example": { - "phone": "+1612842323", - "otp": "123456" + "$id": "password-dictionary", + "userId": true, + "userEmail": true, + "userPhone": true, + "userName": true, + "userMFA": true } }, "authProvider": { @@ -61229,8 +68541,8 @@ }, "secret": { "type": "string", - "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.", - "x-example": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ" + "description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration. This property is write-only and always returned empty.", + "x-example": "" }, "enabled": { "type": "boolean", @@ -61249,7 +68561,7 @@ "key": "github", "name": "GitHub", "appId": "259125845563242502", - "secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ", + "secret": "", "enabled": "" } }, @@ -63229,19 +70541,54 @@ "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", "x-example": "2020-10-15T06:38:00.000+00:00", "x-nullable": true + }, + "projectName": { + "type": "string", + "description": "Name of the project this block applies to.", + "x-example": "My Project" + }, + "region": { + "type": "string", + "description": "Region of the project this block applies to.", + "x-example": "fra" + }, + "organizationName": { + "type": "string", + "description": "Name of the organization that owns the project.", + "x-example": "Acme Inc." + }, + "organizationId": { + "type": "string", + "description": "ID of the organization that owns the project.", + "x-example": "5e5ea5c16897e" + }, + "billingPlan": { + "type": "string", + "description": "Billing plan of the organization that owns the project.", + "x-example": "pro" } }, "required": [ "$createdAt", "resourceType", - "resourceId" + "resourceId", + "projectName", + "region", + "organizationName", + "organizationId", + "billingPlan" ], "example": { "$createdAt": "2020-10-15T06:38:00.000+00:00", "resourceType": "project", "resourceId": "5e5ea5c16897e", "reason": "Payment overdue", - "expiredAt": "2020-10-15T06:38:00.000+00:00" + "expiredAt": "2020-10-15T06:38:00.000+00:00", + "projectName": "My Project", + "region": "fra", + "organizationName": "Acme Inc.", + "organizationId": "5e5ea5c16897e", + "billingPlan": "pro" } }, "backupPolicy": {