Skip to content

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

Merged
ChiragAgg5k merged 1 commit into
mainfrom
feat-1.9.x-specs
May 29, 2026
Merged

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

Conversation

@appwrite-specs
Copy link
Copy Markdown

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

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 28, 2026

Greptile Summary

This PR updates the Appwrite 1.9.x API specs across OpenAPI3 and Swagger2 formats for all platforms (client, console, server), adding new dedicated database backup policy endpoints, a manager cache-deletion endpoint, and presence metadata support, alongside several scope and schema changes.

  • New GET/POST /compute/databases/{databaseId}/backups/policies endpoints are introduced for dedicated database backup policies, but they reuse the generic backupPolicy schema — which lacks the type field (full/incremental) accepted by the create request, and requires services/resources arrays that are meaningless in this database-scoped context.
  • presences/update and presences/upsert gain console platform support; the metadata field is promoted from an additionalProperties pattern to an explicit named property; userId is removed from required parameters.
  • User-target endpoint scopes change from targets.read/write to users.read/write; usageGauge schema gains required resourceType and resourceId fields.

Confidence Score: 3/5

The dedicated database backup policy endpoints reuse a generic schema that drops the type field from responses and imposes irrelevant required fields, which will affect SDK code generators and response validation.

The console spec introduces new backup policy endpoints that reference the wrong response schema — the type field (full/incremental) is silently absent from every create response, and the schema requires services/resources fields that have no meaning for database-scoped policies. This pattern appears in both the OpenAPI3 and Swagger2 console specs. The rest of the changes (presence metadata, scope renames, platform expansions) are self-consistent across both spec formats.

specs/1.9.x/open-api3-1.9.x-console.json and specs/1.9.x/swagger2-1.9.x-console.json — specifically the new /compute/databases/{databaseId}/backups/policies endpoints and their schema reference.

Important Files Changed

Filename Overview
specs/1.9.x/open-api3-1.9.x-console.json Major structural changes: new /compute/databases/{databaseId}/backups/policies endpoints (GET+POST), /manager/cache DELETE, metrics endpoint swap, maintenance window PATCH; reuses wrong backupPolicy schema for dedicated DB backup policies (missing type field, has irrelevant required fields); scope changes for several user-target endpoints.
specs/1.9.x/open-api3-1.9.x-server.json Presence endpoints now platform-expanded to include console; metadata field added as proper named property (replacing additionalProperties pattern); scope changed from targets.* to users.* for user-target endpoints; dedicatedDatabases added to resource type enums; usageGauge schema gains required resourceType/resourceId fields.
specs/1.9.x/open-api3-1.9.x-client.json Presence endpoints now include console platform; metadata field added as explicit named property; minor presence update/upsert operation changes consistent with server spec.
specs/1.9.x/swagger2-1.9.x-console.json Mirrors the OpenAPI3 console changes including new backup policy endpoints (reusing generic backupPolicy schema), manager/cache delete, and scope/method changes; same schema mismatch issue for dedicated database backup policies.
specs/1.9.x/swagger2-1.9.x-server.json Mirrors OpenAPI3 server changes: dedicatedDatabases in resource type enums, presence platform expansion, scope changes, usageGauge required fields update.
specs/1.9.x/swagger2-1.9.x-client.json Mirrors OpenAPI3 client changes for presence endpoints and metadata schema refactor.

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

Comment thread specs/1.9.x/open-api3-1.9.x-server.json
Comment thread specs/1.9.x/open-api3-1.9.x-console.json
@appwrite-specs appwrite-specs Bot force-pushed the feat-1.9.x-specs branch from efd490c to 70d2be5 Compare May 29, 2026 08:56
Comment thread specs/1.9.x/open-api3-1.9.x-console.json
@appwrite-specs appwrite-specs Bot force-pushed the feat-1.9.x-specs branch from 70d2be5 to b8063c7 Compare May 29, 2026 10:36
@appwrite-specs appwrite-specs Bot force-pushed the feat-1.9.x-specs branch from b8063c7 to 3bb4355 Compare May 29, 2026 10:42
@ChiragAgg5k ChiragAgg5k merged commit 570c9de into main May 29, 2026
2 checks passed
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