ruby-grape / ruby-grape/grape-swagger
Is the default value of format option really :json?
Open
Nobody has claimed this yet.
bug?
discuss!
needs work/investigation
swagger-1.2
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
According to https://github.com/tim-vandecasteele/grape-swagger/blob/master/lib/grape-swagger.rb#L336 it looks like the default value of the option format is not :json but nil.
It'd be great if this could be clarified.
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 at lib/grape-swagger.rb around line 336 and inspect the documentation for the format option. Clarify whether its documented default is nil or :json, then update the relevant wording so the stated default matches the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100