Skip to content

feat: API specs update for version latest#52

Closed
appwrite-specs[bot] wants to merge 1 commit intomainfrom
feat-latest-specs
Closed

feat: API specs update for version latest#52
appwrite-specs[bot] wants to merge 1 commit intomainfrom
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 Apr 16, 2026

Greptile Summary

Adds discriminator support to the listRepositories VCS endpoint response schema, introducing a required type field to providerRepositoryFrameworkList and providerRepositoryRuntimeList so consumers can distinguish between the two oneOf variants. The Swagger 2 spec uses the equivalent x-discriminator vendor extension, consistent with its existing x-oneOf approach.

Confidence Score: 5/5

Safe to merge; changes are well-formed and both specs are internally consistent.

Only finding is a P2 suggestion to add an enum constraint to the discriminator property in both schemas — no blocking issues.

No files require special attention.

Important Files Changed

Filename Overview
specs/latest/open-api3-latest-console.json Adds discriminator (propertyName: "type") to the listRepositories oneOf response schema, and adds a required type field to providerRepositoryFrameworkList and providerRepositoryRuntimeList schemas. The type property lacks an enum constraint.
specs/latest/swagger2-latest-console.json Adds x-discriminator vendor extension alongside the existing x-oneOf for the listRepositories response, consistent with Swagger 2's vendor-extension approach. Same type field additions without enum constraints mirroring the OpenAPI 3 changes.

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

Comment on lines +71428 to 71432
"type": {
"type": "string",
"description": "Provider repository list type.",
"x-example": "framework"
}
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 Missing enum constraint on discriminator property

The type field is used as the discriminator property but is declared as an unconstrained string. Each schema should restrict the discriminator to exactly the value it represents so validators and code generators can enforce the mapping. The same applies to providerRepositoryRuntimeList.type.

Suggested change
"type": {
"type": "string",
"description": "Provider repository list type.",
"x-example": "framework"
}
"type": {
"type": "string",
"description": "Provider repository list type.",
"enum": ["framework"],
"x-example": "framework"
}

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