OpenAPITools / OpenAPITools/openapi-generator
[REQ] Response examples for endpoints.
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
I want to have examples for responses for specific endpoint in documentation like in swagger documentation.
Describe the solution you'd like
I want to provide examples of responses in yml file for specific end point and see these responses in html documentation.
Describe alternatives you've considered
No alternatives.
Additional context
Please check this
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
No file, test, or entry point is named. Start by reviewing how the project accepts YAML OpenAPI definitions and generates HTML documentation, then compare the requested response examples with the referenced Swagger documentation. Done means response examples can be declared for a specific endpoint and appear in the generated HTML documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100