Skip to content

Commit

Permalink
Update README and gemspec
Browse files Browse the repository at this point in the history
  • Loading branch information
Zuzanna Stolińska committed Mar 30, 2017
1 parent 5358a06 commit 7e2a4f5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ end

It will look for you main doc file under `/public/api_docs` path.

## Config options
Config Name | Swagger parameter name | Description
--- | --- | ---
config.swagger_url | url | The url pointing to `swagger.json` (Swagger 2.0) or the resource listing (earlier versions) as per [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification/).
config.doc_expansion | docExpansion | Controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details).
config.model_rendering | defaultModelRendering | Controls how models are shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Model Schema' links.) It can be set to 'model' or 'schema', and the default is 'schema'.
config.request_headers | showRequestHeaders | Whether or not to show the headers that were sent when making a request via the 'Try it out!' option. Defaults to `false`.
config.json_editor | jsonEditor | Enables a graphical view for editing complex bodies. Defaults to `false`.

### Edit your json/yaml files

Use [Swagger editor](https://github.com/swagger-api/swagger-editor).
Expand Down
4 changes: 2 additions & 2 deletions swagger_ui_engine.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Gem::Specification.new do |s|
s.authors = ['ZuzannaSt']
s.email = ['[email protected]']
s.homepage = 'https://github.com/ZuzannaSt/swagger_ui_engine'
s.summary = 'Mount swagger-ui as rails engine.'
s.description = 'Api docs inside your rails project.'
s.summary = 'Mount Swagger-Ui as Rails engine.'
s.description = 'Swagger API docs and web console for your rails project.'
s.license = 'MIT'

s.files = Dir['{app,config,db,lib}/**/*', 'MIT-LICENSE', 'Rakefile', 'README.rdoc']
Expand Down

0 comments on commit 7e2a4f5

Please sign in to comment.