Skip to content

Commit

Permalink
Update docs for $RESPONSE changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
cdent committed Feb 5, 2015
1 parent 5d9d0d4 commit 07bc402
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions docs/source/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,19 @@ reference to the state of a current test or the one just prior. These
are replaced with real values during test processing.

* ``$SCHEME``: The current scheme (usually ``http`` or ``https``).
Available in field ``response_headers``.
* ``$NETLOC``: The host and potentially port of the request.
Available in field ``response_headers``.
* ``$LOCATION``: The location header returned in the prior response.
Availble in field ``url``.
* ``$RESPONSE['<json path>']``: A JSONPath query into the prior
response.
response. Available in fields ``url``, ``response_strings`` and
``response_json_paths``

With these it ought to be possible to traverse an API without any
explicit statements about the URLs being used.
explicit statements about the URLs being used. If you need a
replacement on a field that is not currently supported please raise
an issue or provide a patch.

As all of these features needed to be tested in the development of
gabbi itself, `the gabbi tests`_ are a good source of examples on how
Expand Down
2 changes: 1 addition & 1 deletion gabbi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
# under the License.
"""See gabbi.driver and gabbbi.case."""

__version__ = '0.5.1'
__version__ = '0.6.0'

0 comments on commit 07bc402

Please sign in to comment.