Skip to content

Commit

Permalink
clearer doc statement
Browse files Browse the repository at this point in the history
  • Loading branch information
jmartin-tech committed Jan 16, 2025
1 parent 3727e0c commit 9ac2b71
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/garak.generators.rest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Uses the following options from ``_config.plugins.generators["rest.RestGenerator
* ``req_template_json_object`` - (optional) the request template as a Python object, to be serialised as a JSON string before replacements
* ``method`` - a string describing the HTTP method, to be passed to the requests module; default "post".
* ``headers`` - dict describing HTTP headers to be sent with the request
* ``proxies`` - dict passed to ``requests`` method call see `required format<https://requests.readthedocs.io/en/latest/user/advanced/#proxies">`_.
* ``proxies`` - dict passed to ``requests`` method call. See `required format<https://requests.readthedocs.io/en/latest/user/advanced/#proxies">`_.
* ``response_json`` - Is the response in JSON format? (bool)
* ``response_json_field`` - (optional) Which field of the response JSON should be used as the output string? Default ``text``. Can also be a JSONPath value, and ``response_json_field`` is used as such if it starts with ``$``.
* ``request_timeout`` - How many seconds should we wait before timing out? Default 20
Expand Down

0 comments on commit 9ac2b71

Please sign in to comment.