From 9ac2b71de2318211f8b395ff9b7480a5b3a7aec3 Mon Sep 17 00:00:00 2001 From: Jeffrey Martin Date: Thu, 16 Jan 2025 15:15:31 -0600 Subject: [PATCH] clearer doc statement --- docs/source/garak.generators.rest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/garak.generators.rest.rst b/docs/source/garak.generators.rest.rst index 65da65613..6a789ea73 100644 --- a/docs/source/garak.generators.rest.rst +++ b/docs/source/garak.generators.rest.rst @@ -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`_. +* ``proxies`` - dict passed to ``requests`` method call. See `required format`_. * ``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