Skip to content

feat: API specs update for version 1.9.x#76

Merged
ChiragAgg5k merged 1 commit into
mainfrom
feat-1.9.x-specs
Jun 10, 2026
Merged

feat: API specs update for version 1.9.x#76
ChiragAgg5k merged 1 commit into
mainfrom
feat-1.9.x-specs

Conversation

@appwrite-specs

@appwrite-specs appwrite-specs Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

This PR contains API specification updates for version 1.9.x.

@greptile-apps

greptile-apps Bot commented Jun 9, 2026

Copy link
Copy Markdown

Greptile Summary

This PR updates the 1.9.x API specs (OpenAPI 3 and Swagger 2, across client/console/server variants) and their accompanying code examples. Two categories of changes are bundled: OAuth2 application metadata fields (description, clientUri, logoUri, privacyPolicyUrl, termsUrl, contacts) and a compute/database model refactor (removing region, consolidating high-availability into replicas, replacing specification with dedicatedDatabaseId, adding an api ownership field).

  • OAuth2 app fields: New optional consent-screen metadata fields added consistently across all six spec files and the relevant console-web and server examples.
  • Database model changes: highAvailability + highAvailabilityReplicaCount collapsed into a single replicas field; region removed; specification replaced by dedicatedDatabaseId on tablesdb/documentsdb/vectorsdb create endpoints; sqlApiAllowedStatements enum expanded.
  • Service tag cleanup: Duplicate/legacy tags (documentsDB, tablesDB, vectorsDB, webhooks, tokens, presences) removed from server specs.

Confidence Score: 3/5

Two defects in the spec files should be fixed before merging: leading whitespace in backup-policy descriptions will corrupt rendered documentation, and the idGenerator: ID.unique annotation on dedicatedDatabaseId will cause SDK generators to auto-fill a non-existent database ID.

The backup-policy description strings in open-api3-1.9.x-console.json and swagger2-1.9.x-console.json each have 4 leading spaces — any tool that renders these specs will display or expose that whitespace in user-facing docs. More critically, dedicatedDatabaseId across three locations in open-api3-1.9.x-server.json carries idGenerator: ID.unique, an annotation that tells SDK generators to suggest calling ID.unique() for this field. Because dedicatedDatabaseId is a reference to an already-provisioned database rather than a new resource being created, an SDK user following that default would submit a freshly generated random string that matches no existing database, causing the operation to fail.

specs/1.9.x/open-api3-1.9.x-server.json (all three dedicatedDatabaseId blocks), specs/1.9.x/open-api3-1.9.x-console.json and specs/1.9.x/swagger2-1.9.x-console.json (backup-policy descriptions), and the corresponding swagger2-1.9.x-server.json mirror.

Important Files Changed

Filename Overview
specs/1.9.x/open-api3-1.9.x-console.json Adds OAuth2 app metadata fields and compute database schema changes. Two backup-policy endpoint descriptions have 4 leading spaces, producing whitespace-prefixed text in all rendered documentation.
specs/1.9.x/open-api3-1.9.x-server.json Adds OAuth2 app metadata fields, replaces specification with dedicatedDatabaseId on tablesdb/documentsdb/vectorsdb create endpoints, and cleans up removed service tags. All three dedicatedDatabaseId fields carry idGenerator: ID.unique, which is incorrect for a reference field and will mislead SDK generators.
specs/1.9.x/open-api3-1.9.x-client.json Adds OAuth2 app metadata fields to create/update request bodies and switches OAuth2 endpoints from ProjectQuery to ProjectPath auth scheme. No new issues found.
specs/1.9.x/swagger2-1.9.x-console.json Mirror of open-api3 console changes in Swagger 2.0 format. Same leading-whitespace defect on two backup-policy descriptions (lines 10791 and 10860).
specs/1.9.x/swagger2-1.9.x-server.json Mirror of open-api3 server changes in Swagger 2.0 format. Likely carries the same idGenerator: ID.unique annotation on dedicatedDatabaseId.
specs/1.9.x/swagger2-1.9.x-client.json Adds OAuth2 app metadata fields and switches OAuth2 endpoints to ProjectPath auth. No new issues found.
examples/1.9.x/console-web/examples/compute/create-database.md Removes region and highAvailability/highAvailabilityReplicaCount params, adds replicas and api to match updated spec. Example is consistent with spec changes.
examples/1.9.x/console-web/examples/apps/create.md Adds the new optional OAuth2 consent metadata parameters to the create-app example. Consistent with spec additions.

Reviews (3): Last reviewed commit: "chore: update API specs and SDK examples" | Re-trigger Greptile

Comment thread specs/1.9.x/open-api3-1.9.x-client.json
@ChiragAgg5k ChiragAgg5k merged commit 6747182 into main Jun 10, 2026
2 checks passed
@ChiragAgg5k ChiragAgg5k deleted the feat-1.9.x-specs branch June 10, 2026 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant