Skip to content

Commit

Permalink
Update readme with version support notice
Browse files Browse the repository at this point in the history
  • Loading branch information
@richhollis
richhollis committed Jan 13, 2016
1 parent 36dd4bb commit 885e53d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 10,11 @@ Generates swagger-ui json files for rails apps with APIs. You add the swagger DS
[gemnasium]: https://gemnasium.com/richhollis/swagger-docs
[coveralls]: https://coveralls.io/r/richhollis/swagger-docs

## Swagger Version Specification Support

This project supports elements of the v1.2 swagger specification. It *does not* support the v2 specification. If you are looking for support for the newer specification the please see the [swagger-blocks](https://github.com/fotinakis/swagger-blocks/) project. I don't currently have any plans to add support for v2.0 at this time.

## Example usage

Here is an extract of the DSL from a user controller API class:

Expand Down

0 comments on commit 885e53d

Please sign in to comment.