Skip to content

Commit

Permalink
Set default format to be .json.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sunny Juneja committed May 20, 2015
1 parent c2d74ff commit 728af34
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* [#225](https://github.com/tim-vandecasteele/grape-swagger/pull/225): Fixed `param_type` to have it read from parameter's documentation hash - [@zsxking](https://github.com/zsxking).
* [#235](https://github.com/tim-vandecasteele/grape-swagger/pull/235): Fixed nested entity names in parameters and as `$ref` in models - [@frodrigo](https://github.com/frodrigo).
* [#206](https://github.com/tim-vandecasteele/grape-swagger/pull/206): Fixed 'is_array' in the return entity being ignored - [@igormoochnick](https://github.com/igormoochnick).
* [#245](https://github.com/tim-vandecasteele/grape-swagger/pull/245): Fixed requiring format: :json with add_swagger_documentation for grape-swagger-rails.

### 0.10.1 (March 11, 2015)

Expand Down
11 changes: 11 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
Upgrading Grape-swagger
=======================

### Upgrading to >= 0.10.2

Previously, grape-swagger hide the format in the URL by default. This conflicted
with grape-swagger-rails that required grape-swagger to specify the format (see
below). Now, grape-swagger will now assume the `format :json` by default. To
revert, `add_swagger_documentation(format: nil)`

#### Grape-Swagger-Rails

You will no longer need to specify `add_swagger_documentation(format: :json).`

### Upgrading to >= 0.9.0

#### Grape-Swagger-Rails
Expand Down
2 changes: 1 addition & 1 deletion lib/grape-swagger/doc_methods.rb
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ def setup(options)
markdown: nil,
hide_documentation_path: false,
hide_format: false,
format: nil,
format: :json,
models: [],
info: {},
authorizations: nil,
Expand Down

0 comments on commit 728af34

Please sign in to comment.