ruby-grape / ruby-grape/grape-swagger
Custom filter for swagger docs
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
Unable to hide unwanted resources. It loads all resources with all endpoints in JSON format (which later converted to swaggrUI by grape-swagger). There is no control over how swagger_doc is generated (i.e, deciding which resources and which endpoints should be visible).
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 swagger_doc is generated from Grape resources and endpoints, then review the JSON output that is converted to Swagger UI. Define how callers would select visible resources and endpoints, and verify that the generated documentation omits everything excluded by the filter.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100