ruby-grape / ruby-grape/grape-swagger
Namespace parameters not getting documented
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
Adding some required parameters as part of a namespace (as shown here) takes effect in Grape itself but those parameters do not get exposed via Swagger Json.
For example
As a workaround, I could move the params block to every route but do not know if this is a limitation of the current system or I am doing something wrong?
Thanks,
Miguel
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 source file, test, or entry point. Reproduce the namespace validation example and compare the generated Swagger JSON with the route-level workaround; the work is done when required namespace parameters appear in the generated 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