Skip to content

Commit

Permalink
Add compatibility notes for #9
Browse files Browse the repository at this point in the history
  • Loading branch information
jfinkhaeuser committed Nov 8, 2017
1 parent ae89347 commit d0291e3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,25 @@ Largely, that's it. There is a whole slew of utility code that you may
or may not find useful, too. Look at the `full documentation
<https://jfinkhaeuser.github.io/prance/#api-modules>`__ for details.


Compatibility
-------------

As of version 0.8, we're using `flex <https://github.com/pipermerriam/flex>` as the default validation backend.
The previous `swagger-spec-validator <https://github.com/Yelp/swagger_spec_validator>` still works, if you
installed with the `ssv` dependencies.

You can select the backend in the constructor of the parser(s):

.. code:: python
parser = ResolvingParser('http://petstore.swagger.io/v2/swagger.json', backend = 'swagger-spec-validator')
Note that the `flex` validator simply accepts integer status codes, despite them not being valid JSON.
See `issue #5 <https://github.com/jfinkhaeuser/prance/issues/5>` for details. Therefore, `flex` also
does not support the `strict` option.


Contributing
============

Expand Down

0 comments on commit d0291e3

Please sign in to comment.