The API Reference
=================

.. module:: req

This part of the documentation covers req's Python interfaces.

Endpoints
---------

Use Endpoints and Methods to declare *how* to get to your data.

.. autoclass:: Endpoint
   :members: build_uri, flatten
   :undoc-members:
.. autoclass:: Method
   :members:
   :undoc-members:

Adapters
^^^^^^^^

.. autoclass:: req.adapter.EndpointAdapter
   :members: build
   :undoc-members:
.. autoclass:: req.adapter.DictionaryAdapter
   :members: build
   :undoc-members:
.. autoclass:: req.adapter.SwaggerAdapter
   :members: build
   :undoc-members:

Schema
------

Use Schemas to declare the *shape* of your data.

.. autoclass:: req.schema.SchemaLike
   :members: validate, update, materialize
   :undoc-members:
.. autoclass:: req.schema.Schema
   :show-inheritance:
   :members: validate, update, materialize
   :undoc-members:
.. autoclass:: req.schema.Property
   :show-inheritance:
   :members: _validate, validate, update, materialize
   :undoc-members:

.. autofunction:: req.schema.Alternative

Properties
^^^^^^^^^^

.. autoclass:: req.schema.Boolean
.. autoclass:: req.schema.Number
.. autoclass:: req.schema.Integer
.. autoclass:: req.schema.String
.. autoclass:: req.schema.DateTime
.. autoclass:: req.schema.Email
.. autoclass:: req.schema.URI
.. autoclass:: req.schema.Regexp
.. autoclass:: req.schema.IPv4
.. autoclass:: req.schema.IPv6
.. autoclass:: req.schema.List
.. autoclass:: req.schema.Tuple
.. autoclass:: req.schema.Dictionary
.. autoclass:: req.schema.ValueDictionary
.. autoclass:: req.schema.Or

.. autofunction:: req.schema.Lazy

Exceptions
^^^^^^^^^^

.. autoexception:: req.schema.ValidationError

Adapters
^^^^^^^^

.. autoclass:: req.schema.adapter.SchemaAdapter
   :members: build
   :undoc-members:
.. autoclass:: req.schema.adapter.JSONSchemaAdapter
   :members: build
   :undoc-members:

Falcon Integration
------------------

.. autofunction:: req.falcon.register

Decorators
^^^^^^^^^^

.. autofunction:: req.falcon.decorators.exposespec
.. autofunction:: req.falcon.decorators.jsonrequest
.. autofunction:: req.falcon.decorators.jsonresponse
.. autofunction:: req.falcon.decorators.jsonhandler
.. autofunction:: req.falcon.decorators.queryrequest
.. autofunction:: req.falcon.decorators.entityrequest
.. autofunction:: req.falcon.decorators.entityresponse
.. autofunction:: req.falcon.decorators.entityhandler
.. autofunction:: req.falcon.decorators.listingrequest
.. autofunction:: req.falcon.decorators.listingresponse
.. autofunction:: req.falcon.decorators.listinghandler

Webapp2 Integration
-------------------

.. autofunction:: req.webapp2.register

Decorators
^^^^^^^^^^

.. autofunction:: req.webapp2.decorators.exposespec
.. autofunction:: req.webapp2.decorators.jsonrequest
.. autofunction:: req.webapp2.decorators.jsonresponse
.. autofunction:: req.webapp2.decorators.jsonhandler
.. autofunction:: req.webapp2.decorators.queryrequest
.. autofunction:: req.webapp2.decorators.entityrequest
.. autofunction:: req.webapp2.decorators.entityresponse
.. autofunction:: req.webapp2.decorators.entityhandler
.. autofunction:: req.webapp2.decorators.listingrequest
.. autofunction:: req.webapp2.decorators.listingresponse
.. autofunction:: req.webapp2.decorators.listinghandler

Wask Integration
-------------------

.. autofunction:: req.wask.register

Decorators
^^^^^^^^^^

.. autofunction:: req.wask.decorators.exposespec
.. autofunction:: req.wask.decorators.jsonrequest
.. autofunction:: req.wask.decorators.jsonresponse
.. autofunction:: req.wask.decorators.jsonhandler
.. autofunction:: req.wask.decorators.entityresponse