Skip to content

Commit

Permalink
Update readme, add scoping section
Browse files Browse the repository at this point in the history
  • Loading branch information
adrian-gomez committed Nov 30, 2015
1 parent 7ea05b2 commit 4aec79e
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,22 @@ You can configure it as follows:

Even if you provide a authentication_value you can later change it from the ui.

Documentation Scoping
---------------------
Its possible to only generate Swagger documentation for a subset of your application controllers
to do this you just need to use the `controllers_path` config option.
For instance to only generate documentation for the controllers under `app/controllers/api` you
need do this:

# config/initializers/swaggard.rb
Swaggard.configure do |config|
...
config.controllers_path = "#{Rails.root}/app/controllers/api/**/*.rb"
...
end

The default value for `controllers_path` is `"#{Rails.root}/app/controllers/**/*.rb"`.

More Information
-----------------

Expand Down

0 comments on commit 4aec79e

Please sign in to comment.