Skip to content

feat: API specs update for version 1.9.x - #97

Merged
ChiragAgg5k merged 2 commits into
mainfrom
feat-1.9.x-specs
Aug 19, 2026
Merged

feat: API specs update for version 1.9.x#97
ChiragAgg5k merged 2 commits into
mainfrom
feat-1.9.x-specs

Conversation

@ChiragAgg5k

Copy link
Copy Markdown
Member

What does this PR do?

Regenerates the 1.9.x client, server, and console OpenAPI specs with official schema fields:

  • nullable replaces x-nullable
  • example replaces x-example
  • array, object, numeric, and boolean examples use native JSON values
  • absent examples are omitted instead of emitted as null

JSON response properties declared as arrays now emit array schemas with object items. This includes migration report data and Cloud JSON-array models such as WAF conditions, dedicated database rows, plan estimation entries, and app installation authorization details.

Generated from appwrite-labs/cloud#5374. This PR remains a draft until appwrite/appwrite#13279 is merged and the Cloud lock is refreshed, after which the workflow output will be verified against this branch.

SDK examples are intentionally unchanged until appwrite/sdk-generator#1812 is ready to consume the newly published standard fields.

Validation

  • Zero x-example occurrences
  • Zero x-nullable occurrences
  • Zero example: null values
  • Every schema example matches its declared type, including nested array items
  • Swagger Validator: zero errors and warnings for client, server, and console
  • Byte-identical platform specs to the corresponding latest regeneration

@ChiragAgg5k
ChiragAgg5k marked this pull request as ready for review August 19, 2026 09:39
@greptile-apps

greptile-apps Bot commented Aug 19, 2026

Copy link
Copy Markdown

Greptile Summary

The PR regenerates all three 1.9.x OpenAPI variants to use standard example and nullable fields, native JSON example values, and corrected array representations.

  • Replaces legacy x-example and x-nullable schema extensions.
  • Omits absent examples instead of emitting null values.
  • Preserves empty-array examples for array schemas.
  • Applies the regenerated contracts consistently across client, console, and server specifications.

Confidence Score: 5/5

The PR appears safe to merge because no concrete schema, compatibility, or validation failure was identified.

The changes consistently modernize generated OpenAPI metadata and examples across all three specification variants, while the examined array-example changes preserve existing array contracts.

Important Files Changed

Filename Overview
specs/1.9.x/open-api3-1.9.x-client.json Regenerates the client specification with standard schema keywords and correctly typed examples; no actionable defect was identified.
specs/1.9.x/open-api3-1.9.x-console.json Regenerates the console specification, including Cloud-specific array models, without an identified contract inconsistency.
specs/1.9.x/open-api3-1.9.x-server.json Regenerates the server specification and restores empty-array examples on existing array schemas; no actionable defect was identified.

Reviews (1): Last reviewed commit: "fix: preserve empty array examples" | Re-trigger Greptile

@ChiragAgg5k
ChiragAgg5k merged commit 6b98726 into main Aug 19, 2026
2 checks passed
@ChiragAgg5k
ChiragAgg5k deleted the feat-1.9.x-specs branch August 19, 2026 09:42
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