Skip to content

Commit

Permalink
Add more explanation for doc_expansion option
Browse files Browse the repository at this point in the history
  • Loading branch information
maruware committed Sep 17, 2015
1 parent 6786a3b commit 7b7165c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Upgraded swagger-ui to v2.1.1 - [@dblock](https://github.com/dblock).
* Grape-swagger 0.7.2 is no longer supported - [@dblock](https://github.com/dblock).
* Implemented RuboCop, Ruby-style linter - [@dblock](https://github.com/dblock).
* Support Swagger-UI docExpansion option - [@maruware](https://github.com/maruware).
* [#31](https://github.com/ruby-grape/grape-swagger-rails/pull/31): Support Swagger-UI docExpansion option - [@maruware](https://github.com/maruware).
* Your contribution here.

### 0.1.0 (February 5, 2015)
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ You can specify additional headers to add to each request:
GrapeSwaggerRails.options.headers['Special-Header'] = 'Some Secret Value'
```

You can set docExpansion with "none" or "list" or "full", default is "none"
You can set docExpansion with "none" or "list" or "full", default is "none".
See the official Swagger-UI documentation about [SwaggerUi Parameters](https://github.com/swagger-api/swagger-ui#parameters).

```ruby
GrapeSwaggerRails.options.doc_expansion = 'list'
Expand Down

0 comments on commit 7b7165c

Please sign in to comment.