We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Example:
class MyApi < Grape::API route_param :account_id, type: String, desc: 'id of account', documentation: { desc: 'another-desc' } do mount AccountsApi get '/another-list' do [] end end add_swagger_documentation end class AccountsApi < Grape::API get '/list' do [] end end
Resulting documentation:
"/{account_id}/list": { "get": { "parameters": [ { "in": "path", "name": "account_id", "type": "integer", "format": "int32", "required": true } ], } }, "/{account_id}/another-list": { "get": { "parameters": [ { "in": "path", "name": "account_id", "type": "string", "required": true } ], } }
account_id
/list
/another-list
The text was updated successfully, but these errors were encountered:
fix: Grape::Endpoint#merge_params now returns correct object (ruby-gr…
7ac816d
…ape#942)
4894fa6
Successfully merging a pull request may close this issue.
Example:
Resulting documentation:
account_id
param of/list
type is incorrect, description and documentation is ignoredaccount_id
param of/another-list
type is correct, but description and documentation is still ignoredThe text was updated successfully, but these errors were encountered: