ruby-grape / ruby-grape/grape-swagger
Add example to path param
Open
Nobody has claimed this yet.
bug?
swagger-1.2
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
I have been adding examples to some of my parameters, but up to this point they have not been path params. I tried to do it with the following but it doesn't show up.
route_param :id, desc: "User ID", documentation: { example: User.first.id } do
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
Start by tracing how route_param documentation is converted into the generated Swagger or OAPI path-parameter definition. Reproduce the example from the issue with User.first.id and compare it with an existing non-path parameter example. Done means the path parameter's example appears in the generated API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100