ruby-grape / ruby-grape/grape-swagger
Feature request: set Swagger defaultValue without needing to set a grape default
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 grape "default" field is used to populate the swagger defaultValue field.
The expectations of these two parameters is slightly different. In Swagger, defaultValue pre-populates the field only, but in Grape, it will use the default to fill in a missing parameter.
It would be great to be able to set values like these directly with the "documentation" hash that grape lets you pass.
Will submit a PR some time next week
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 the documentation hash maps Grape parameter defaults to Swagger output. Verify that a Swagger defaultValue can be supplied independently of Grape's runtime default, without changing missing-parameter behavior. No file or test is named in the issue, so the relevant mapping code and its existing documentation tests must be located first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, 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