chore: generate examples from the canonical OpenAPI document - #1882
Merged
Conversation
appwrite/specs now publishes one open-api3-<version>.json per current version and the generator selects the platform from it since 4.8.0; the per-platform OpenAPI 3 files are gone for 2.0.x and latest. Swagger 2 documents stay per platform.
Contributor
Greptile SummaryThe PR updates example generation to consume the canonical OpenAPI 3 document while retaining platform-specific Swagger 2 URLs and explicitly selecting the SDK platform.
Confidence Score: 5/5The PR appears safe to merge, with no outstanding correctness or repository-rule violations identified. The README now passes the selected platform to the SDK, resolving the previously identified platform-filtering problem. That thread was manually resolved without explanation. Important Files Changed
Reviews (3): Last reviewed commit: "docs: select the platform in the README ..." | Re-trigger Greptile |
encoding_rs 0.8.40 requires edition 2024, which cargo 1.83 cannot parse, and cargo 1.83 does not resolve dependencies against rust-version. Pin it below 0.8.40 like the other transitive crates held back for the MSRV.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
appwrite/specs now publishes one
open-api3-<version>.jsonper current version (appwrite/specs#105, #106), and the generator has selected its platform from that document since 4.8.0. The per-platform OpenAPI 3 files are being removed for 2.0.x and latest, soexample.phpfetches the canonical file. Swagger 2 documents remain per platform and that path is unchanged. AGENTS.md and README updated to match.Validation
php example.php web consoleandphp example.php node serveragainst the published canonical document: generation succeeds; the Node server example foraccount.getconfiguressetSession()and the Web console example configures the project only, matching the previous per-platform output.Related to CLO-4377.