diff options
| author |  Johannes Christ <[email protected]> | 2019-01-09 20:53:43 +0100 |
|---|---|---|
| committer | Johannes Christ <[email protected]> | 2019-01-09 20:53:43 +0100 |
| commit | b23c262b8fd01310cc3a503d8e531d980d818d30 (patch) | |
| tree | d13ba1af874d2d5917b77dc9d4d1d71827089c7d | |
| parent | Use proper test case name. (diff) | |
Document format query parameter.
| -rw-r--r-- | api/views.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/api/views.py b/api/views.py index 6a269618..75209c36 100644 --- a/api/views.py +++ b/api/views.py @@ -44,7 +44,9 @@ class RulesView(APIView): Since some of the the rules require links, this view gives you the option to return rules in either Markdown - or HTML format by specifying the `format`. + or HTML format by specifying the `link_format` query parameter + as either `md` or `html`. Specifying a different value than + `md` or `html` will return 400. ## Authentication Does not require any authentication nor permissions. |