Skip to content

feat: API specs update for version latest#67

Merged
ChiragAgg5k merged 1 commit into
mainfrom
feat-latest-specs
May 27, 2026
Merged

feat: API specs update for version latest#67
ChiragAgg5k merged 1 commit into
mainfrom
feat-latest-specs

Conversation

@appwrite-specs
Copy link
Copy Markdown

This PR contains API specification updates for version latest.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 26, 2026

Greptile Summary

This automated spec update introduces a full dedicated-database management API surface (compute/* endpoints) in the console specs, adds organization-scoped key and project management endpoints to the server spec, and migrates all six spec files from the old <REGION> URL placeholder to the proper OpenAPI 3.0 server-variable syntax ({region}).

  • Compute API (console): ~40 new endpoints covering database CRUD, backups, branches, connections, credentials rotation, SQL execution, schema previews, HA failover, migrations, PITR, pooler, metrics, and query explanation — all console-only with appropriate databases.read/databases.write scopes.
  • Organization API (server): New GET/POST /organization/keys and GET/PATCH/DELETE /organization/keys/{keyId} plus matching /organization/projects endpoints, dual-listed under console+server platforms with organization.keys.* / organization.projects.* scopes.
  • Housekeeping: weight fields removed from all x-appwrite extension blocks; empty x-enum-keys: [] arrays cleaned up; default values added to several optional parameters.

Confidence Score: 4/5

  • Safe to merge with one spec correctness fix: the bindings field type declaration will break SDK generation for positional SQL bindings.
  • The bindings field in computeCreateDatabaseExecution is declared as "type": "object" while the description explicitly documents that array (positional) bindings are also valid. Generated SDKs and validators will silently block positional-parameter usage. Everything else — the server URL migration, the new compute and organization endpoints, and the housekeeping removals — looks structurally consistent across all six spec files.
  • specs/latest/open-api3-latest-console.json and specs/latest/swagger2-latest-console.json — the bindings schema type in computeCreateDatabaseExecution needs to be widened to cover both arrays and objects.

Important Files Changed

Filename Overview
specs/latest/open-api3-latest-console.json Large restructure: replaces many existing console/databases endpoints with new compute/* dedicated-database API surface; server URL upgraded from to proper OAS3 server variables; bindings field in computeCreateDatabaseExecution has a type/description mismatch
specs/latest/open-api3-latest-server.json Adds new organization key and project management endpoints; removes weight fields from all x-appwrite extensions; migrates server URL to OAS3 variable syntax; adds default values to several optional params
specs/latest/open-api3-latest-client.json Minor updates: server URL migrated to OAS3 server variables, weight fields removed, default values added to optional params; no new endpoints
specs/latest/swagger2-latest-console.json Swagger2 mirror of the console OAS3 changes; same compute/* endpoint additions; bindings field has extra default: {} not present in OAS3 counterpart
specs/latest/swagger2-latest-server.json Swagger2 mirror of the server OAS3 changes; same organization endpoint additions, weight field removals, and server URL updates
specs/latest/swagger2-latest-client.json Swagger2 mirror of the client OAS3 changes; server URL updates, weight field removals, and default values added

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

Comment on lines +20 to +30
"url": "https:\/\/cloud.appwrite.io\/v1",
"description": "Appwrite Cloud endpoint."
},
{
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
"url": "https:\/\/{region}.cloud.appwrite.io\/v1",
"description": "Appwrite Cloud regional endpoint. Replace `{region}` with your project region.",
"variables": {
"region": {
"default": "fra",
"description": "Appwrite Cloud region."
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 endpointDocs URL uses old <REGION> placeholder while server URL uses {region}

The server object's second URL was correctly migrated to the OpenAPI 3.0 server-variable syntax ({region}), but the new x-appwrite.endpointDocs extension field still uses the old angle-bracket format (<REGION>). Any tooling or SDK generator that reads endpointDocs to construct URLs will produce a malformed string rather than a valid regional endpoint.

This same inconsistency appears in all six spec files (open-api3-latest-client.json, swagger2-latest-server.json, etc.).

@appwrite-specs appwrite-specs Bot force-pushed the feat-latest-specs branch 4 times, most recently from cb40a17 to 86ebe03 Compare May 26, 2026 05:48
@appwrite-specs appwrite-specs Bot force-pushed the feat-latest-specs branch from 86ebe03 to d48bae0 Compare May 26, 2026 05:55
@ChiragAgg5k ChiragAgg5k merged commit 1b6cc28 into main May 27, 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