ruby-grape / ruby-grape/grape-swagger
Invalid Swagger Schema - Delete
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
The following example method creates an invalid schema:
params do
options :test_ids, type: Array[String], documentation: { param_type: 'body' }
options :rest_ids, type: Array[String], documentation: { param_type: 'body' }
end
delete do
# ...
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
Start by reproducing the example in the issue and inspecting the generated Swagger schema for the DELETE endpoint. Trace the schema-generation entry point that handles body parameters and array types. Done means the example produces a valid schema for both test_ids and rest_ids.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100