ruby-grape / ruby-grape/grape-swagger
Does not handle file Parameters
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
As per the OpenAPI v2 documentation, If type is "file", the [consumes](https://swagger.io/specification/v2/#operationConsumes) MUST be either "multipart/form-data", " application/x-www-form-urlencoded" or both and the parameter MUST be [in](https://swagger.io/specification/v2/#parameterIn) "formData".
Currently, grape-swagger processes file parameters normally and does not enforce these requirements, leading to invalid OpenAPI v2 output.
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 grape-swagger's processing of file parameters and compare it with the linked OpenAPI v2 requirements for consumes and formData. Done means file parameters enforce those requirements and the generated OpenAPI v2 output is valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100