From b23c262b8fd01310cc3a503d8e531d980d818d30 Mon Sep 17 00:00:00 2001
From: Johannes Christ <jc@jchri.st>
Date: Wed, 9 Jan 2019 20:53:43 +0100
Subject: Document format query parameter.

---
 api/views.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

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.
-- 
cgit v1.2.3