✨ Add OpenAPI examples to speed up integration and contributor onboar…#663
Merged
Merged
Conversation
|
@datagerl is attempting to deploy a commit to the Cedarich's projects Team on Vercel. A member of the Team first needs to authorize it. |
Cedarich
approved these changes
Jun 27, 2026
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
2 participants
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.
his PR adds comprehensive OpenAPI examples to all API schemas including:
AnchorMetadata examples in all requests/responses
Success case examples
Error case examples (like 422 validation errors)
This will make Swagger UI much more user-friendly for contributors and integrators! 🎉
Changes made :
Added model_config with json_schema_extra.examples to all schemas
Added Field(examples=[...]) to individual fields
closes #620