interaction.rst

 .. _interaction.json#/:

interaction
===========

.. container:: title

 Interaction Schema

:type: ``object``

:schema: ``http://json-schema.org/draft-04/schema#``

:Required: :ref:`request`


.. _interaction.json#/definitions:

definitions
***********


.. _interaction.json#/definitions/Headers:

Headers
+++++++

:type: ``object``


.. _interaction.json#/definitions/Headers/patternProperties:

patternProperties
-----------------


.. _interaction.json#/definitions/Headers/patternProperties/.*:

.*
##

:type: ``array``

.. container:: sub-title

 Every element of **.***  is:

:type: ``string``


.. _interaction.json#/definitions/MatchFields:

MatchFields
+++++++++++

**Allowed values:** 

- uri
- method
- body
- headers


.. _interaction.json#/definitions/Methods:

Methods
+++++++

**Allowed values:** 

- GET
- POST
- DELETE
- PUT
- HEAD
- TRACE
- OPTIONS
- CONNECT
- PATCH


.. _interaction.json#/definitions/Request:

Request
+++++++

:type: ``object``


.. _interaction.json#/definitions/Request/patternProperties:

patternProperties
-----------------


.. _interaction.json#/definitions/Request/patternProperties/body:

body
####


.. _interaction.json#/definitions/Request/patternProperties/body/type:

type
~~~~


.. _interaction.json#/definitions/Request/patternProperties/body/type/null:

null
>>>>


.. _interaction.json#/definitions/Request/patternProperties/body/type/string:

string
>>>>>>


.. _interaction.json#/definitions/Request/patternProperties/headers:

headers
#######

:Reference: :ref:`Headers#/`


.. _interaction.json#/definitions/Request/patternProperties/method:

method
######

:Reference: :ref:`Methods#/`


.. _interaction.json#/definitions/Request/patternProperties/uri:

uri
###

:type: ``string``

:Required: :ref:`body`, :ref:`method`


.. _interaction.json#/definitions/Response:

Response
++++++++

:type: ``object``

:Required: :ref:`headers`, :ref:`status`

**Properties:** :ref:`interaction.json#/definitions/Response/properties/body`, :ref:`interaction.json#/definitions/Response/properties/headers`, :ref:`interaction.json#/definitions/Response/properties/status`


.. _interaction.json#/definitions/Response/properties/body:

body
####

:type: ``string``


.. _interaction.json#/definitions/Response/properties/headers:

headers
#######

:Reference: :ref:`Headers#/`


.. _interaction.json#/definitions/Response/properties/status:

status
######

:type: ``object``

:Required: :ref:`code`

**Properties:** :ref:`interaction.json#/definitions/Response/properties/status/properties/code`, :ref:`interaction.json#/definitions/Response/properties/status/properties/message`


.. _interaction.json#/definitions/Response/properties/status/properties/code:

code
>>>>

:type: ``integer``


.. _interaction.json#/definitions/Response/properties/status/properties/message:

message
>>>>>>>

:type: ``string``

**Properties:** :ref:`interaction.json#/properties/callbacks`, :ref:`interaction.json#/properties/match`, :ref:`interaction.json#/properties/request`, :ref:`interaction.json#/properties/response`


.. _interaction.json#/properties/callbacks:

callbacks
+++++++++

:type: ``array``

:additionalItems: ``False``

:Required: :ref:`request`

.. container:: sub-title

 Every element of **callbacks**  is:

:type: ``object``

**Properties:** :ref:`interaction.json#/properties/callbacks/items/properties/delay`, :ref:`interaction.json#/properties/callbacks/items/properties/request`


.. _interaction.json#/properties/callbacks/items/properties/delay:

delay
#####

:type: ``number``


.. _interaction.json#/properties/callbacks/items/properties/request:

request
#######

:Reference: :ref:`Request#/`


.. _interaction.json#/properties/match:

match
+++++

:type: ``object``

:minProperties: ``1``

**Properties:** :ref:`interaction.json#/properties/match/properties/exact`, :ref:`interaction.json#/properties/match/properties/regex`


.. _interaction.json#/properties/match/properties/exact:

exact
#####

:type: ``array``

:additionalItems: ``False``

.. container:: sub-title

 Every element of **exact**  is:

:Reference: :ref:`MatchFields#/`


.. _interaction.json#/properties/match/properties/regex:

regex
#####

:type: ``object``


.. _interaction.json#/properties/match/properties/regex/patternProperties:

patternProperties
~~~~~~~~~~~~~~~~~


.. _interaction.json#/properties/match/properties/regex/patternProperties/.*:

.*
>>

:type: ``string``


.. _interaction.json#/properties/match/properties/regex/propertyNames:

propertyNames
~~~~~~~~~~~~~

:Reference: :ref:`MatchFields#/`


.. _interaction.json#/properties/request:

request
+++++++

:Reference: :ref:`Request#/`


.. _interaction.json#/properties/response:

response
++++++++

:Reference: :ref:`Response#/`