1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
|
.. swagger spec validator documentation master file, created by
sphinx-quickstart on Fri May 13 14:16:02 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Swagger Spec Validator
**********************
Introduction
============
Swagger Spec Validator is a Python library that validates *Swagger Specs*
against the `Swagger 1.2`_ or `Swagger 2.0`_ specification. The validator
aims to check for full compliance with the Specification.
Frequently Asked Questions
==========================
Is the API stable?
------------------
Probably not. However, it is currently very simple, so it shouldn't be hard to
upgrade code if there's a non backwards-compatible change.
API
===
.. currentmodule:: swagger_spec_validator
.. autoclass:: SwaggerValidationError
.. autofunction:: validate_spec_url
.. toctree::
:maxdepth: 1
changelog
.. _Swagger 1.2: https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md
.. _Swagger 2.0: https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md
|