Skip to content

chore: keep only the canonical OpenAPI document for 2.0.x and latest - #107

Merged
ChiragAgg5k merged 2 commits into
mainfrom
chore/remove-platform-specs
Sep 7, 2026
Merged

chore: keep only the canonical OpenAPI document for 2.0.x and latest#107
ChiragAgg5k merged 2 commits into
mainfrom
chore/remove-platform-specs

Conversation

@ChiragAgg5k

Copy link
Copy Markdown
Member

Summary

open-api3-2.0.x.json and open-api3-latest.json (#105, #106) cover client, server and console in one document; each operation, alias and security scheme lists its platforms under x-appwrite.platforms, and x-appwrite.auth is keyed by platform. The three per-platform files in those two folders were exact subsets of it and are removed. Versions up to 1.9.x keep their per-platform files. README updated.

Consumers

  • sdk-generator selects the platform from the canonical document since 4.8.0 and reads keyed auth since 4.9.0; chore: generate examples from the canonical OpenAPI document sdk-generator#1882 switches its example generation to the canonical URL.
  • appwrite-labs/cloud's specs workflow now publishes only the canonical file (branch feat/canonical-openapi-document), so a rerun will not re-add the platform files.
  • Anything else reading open-api3-2.0.x-<platform>.json or open-api3-latest-<platform>.json must switch to the canonical file and filter by x-appwrite.platforms.

Related to CLO-4377.

Both versions now ship open-api3-<version>.json covering client, server and console; the per-platform copies were exact subsets of it. Versions up to 1.9.x keep their per-platform files.
@greptile-apps

greptile-apps Bot commented Sep 7, 2026

Copy link
Copy Markdown

Greptile Summary

This PR consolidates the 2.0.x and latest OpenAPI distributions around their canonical, multi-platform documents.

  • Removes the six redundant client, server, and Console subset files.
  • Documents the canonical artifact layout while retaining the older per-platform naming convention through 1.9.x.
  • Updates the SDK-generation example to filter the canonical document by x-appwrite.platforms before invoking openapi-generator.

Confidence Score: 5/5

The PR appears safe to merge; the revised README example correctly limits generated SDK operations to the selected platform.

No actionable new defects or repository-rule violations remain. The prior mixed-platform generation thread was manually resolved after the README gained an explicit platform-filtering step.

Important Files Changed

Filename Overview
README.md Documents the canonical OpenAPI layout and now filters operations to the selected platform before SDK generation.
specs/2.0.x/open-api3-2.0.x-client.json Removes the redundant 2.0.x client-specific subset.
specs/2.0.x/open-api3-2.0.x-console.json Removes the redundant 2.0.x Console-specific subset.
specs/2.0.x/open-api3-2.0.x-server.json Removes the redundant 2.0.x server-specific subset.
specs/latest/open-api3-latest-client.json Removes the redundant latest client-specific subset.
specs/latest/open-api3-latest-console.json Removes the redundant latest Console-specific subset.
specs/latest/open-api3-latest-server.json Removes the redundant latest server-specific subset.

Reviews (2): Last reviewed commit: "docs: filter the canonical document by p..." | Re-trigger Greptile

Comment thread README.md Outdated
@ChiragAgg5k

Copy link
Copy Markdown
Member Author

Added a jq step to the README example that keeps only the operations whose x-appwrite.platforms include the chosen platform before running openapi-generator; verified it yields the 783 server operations from the canonical document.

@greptile review

@ChiragAgg5k
ChiragAgg5k merged commit 3619221 into main Sep 7, 2026
2 checks passed
@ChiragAgg5k
ChiragAgg5k deleted the chore/remove-platform-specs branch September 7, 2026 10:32
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