ruby-grape / ruby-grape/grape-swagger
Adding Request & Response example
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
I would like to add an array of example requests and corresponding responses for my API. Swagger provides a way to add those examples as defined in the link below.
But I couldn't figure out how the same can be achieved in grape-swagger
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 concerns grape-swagger and Swagger's Adding Examples guide; start by reviewing grape-swagger's documented configuration and generated API documentation. Determine how request and response examples should be represented, with completion defined as examples appearing in the generated Swagger/OpenAPI output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100