swagger-api / swagger-api/swagger-ui
Validate my examples against the corresponding model
Open
Nobody has claimed this yet.
cat: try-it-out
type: feature
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Is it possible to validate my examples by using the corresponding models?
Sometimes I forget to edit the examples after I did some changes to the models.
Another question, can I by default show the models instead of the examples in swagger-ui?
Thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Begin by locating Swagger UI's example/model rendering and schema-validation areas, then define acceptance criteria for validating examples against models and choosing models as the default view before proposing tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100