ruby-grape / ruby-grape/grape-swagger
can not create documentation without namespace
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
I am trying to create documentation for this
desc 'Returns your public timeline.' do
summary 'summary'
detail 'more details'
named 'My named route'
headers XAuthToken: {
description: 'Validates your identity',
required: true
},
XOptionalHeader: {
description: 'Not really needed',
required: false
}
hidden false
deprecated false
is_array true
nickname 'nickname'
produces ['application/json']
consumes ['application/json']
tags ['tag1', 'tag2']
end
post '/:name.json' do
end
As I understand It does not work with routes like /:test and only works with namespaces or resources
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
Reproduce the Ruby Grape example with a parameterized route such as /:test, then compare documentation generation with the namespace or resource cases described in the issue. Trace the route documentation entry point and verify that the generated Swagger or OpenAPI documentation includes the route without requiring a namespace or resource.
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
- Mostly clear
- Newbie friendliness
- 42/100