Skip to content
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

Update UPGRADING.md #462

Closed
wants to merge 1 commit into from
Closed

Update UPGRADING.md #462

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
12 changes: 12 additions & 0 deletions UPGRADING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ gem 'grape-swagger'
gem 'grape-swagger-entity'
```

`add_swagger_documentation` has changed from
``` ruby
add_swagger_documentation \
api_version: 'v1'
```
to

``` ruby
add_swagger_documentation \
version: 'v1'
Copy link
Member

@LeFnord LeFnord Jun 23, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you tried it? think this isn't possible anymore here, cause the API version should be specified in grape,
and not by grape-swagger, to be consistent and to have one place for it, here one could only add doc_version

Copy link
Author

@ZeroInputCtrl ZeroInputCtrl Jun 23, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what i'm currently using in my project and if that's the case it looks like it forwards it on.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can overwrite the API version sets by grape?
If yes, please write a spec to document it → 👍

```

### Upgrading to >= 0.10.2

With grape >= 0.12.0, support for `notes` is replaced by passing a block `detail` option specified. For future compatibility, update your code:
Expand Down