Skip to content

Commit

Permalink
doc: give generatiors.rest list the space it wants and deserves (#914)
Browse files Browse the repository at this point in the history
  • Loading branch information
leondz authored Sep 13, 2024
2 parents 1a17cf6 + 4788527 commit 784546f
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/garak.generators.rest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ garak.generators.rest
Flexible connector for REST-based APIs.

Uses the following options from ``_config.plugins.generators["rest.RestGenerator"]``:

* ``uri`` - (optional) the URI of the REST endpoint; this can also be passed in --model_name
* ``name`` - a short name for this service; defaults to the uri
* ``key_env_var`` - (optional) the name of the environment variable holding an API key, by default ``REST_API_KEY``
Expand Down

0 comments on commit 784546f

Please sign in to comment.