ruby-grape / ruby-grape/grape-swagger
Override Grape Entity Model Description
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
Right now, the description of the model is automatically written as "{MODEL_NAME} Model" and put in the swagger docs. How do we override that?
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 files or tests. Start by locating the code that generates the model description for Grape Entity resources, then inspect how Swagger or OpenAPI documentation options are configured. Done means the supported override is identified and documented, with generated API documentation showing the custom description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100