ruby-grape / ruby-grape/grape-swagger
class level hidden field to hide api
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
Now we can hide an endpoint using the following syntex. desc 'Hide this endpoint', hidden: true
How to do the same in class level. Like the following, so we can hide multiple endpoints.
module APIv2
class Deposits < Grape::API
hidden: true
helpers ::APIv2::NamedParams
desc 'description 1'
desc 'description 2'
end
end
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
Search the code for the existing endpoint-level hidden: true handling and trace how endpoint descriptions are incorporated into the generated API documentation. Determine where a class-level option could apply to all endpoints in the class, then add coverage showing that those endpoints are omitted when the option is enabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100