Skip to content

added extra information for DSL method "consume" #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added extra information for DSL method "consume" #157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ class Api::V1::UserController < Api::V1::BaseController
response :not_acceptable
response :unprocessable_entity
end

swagger_api :update do |api|
summary "Update an existing User item"
Api::V1::UserController::add_common_params(api)
Expand Down Expand Up @@ -324,6 +324,11 @@ end
<td>Takes a symbol or status code and passes it to `Rack::Utils.status_code`. The current list of status codes can be seen here: https://github.com/rack/rack/blob/master/lib/rack/utils.rb. An optional message can be added.</td>
</tr>

<tr>
<td>consumes</td>
<td>Custom list of MIME types the API can consume. This overrides global settings for the specific API call.</td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -384,7 +389,7 @@ end
```

If you want swagger to find controllers in `Rails.application` and/or multiple
engines you can override `base_application` to return an array.
engines you can override `base_application` to return an array.

```ruby
class Swagger::Docs::Config
Expand Down