From a32fdf1521515506d4bb64fa2d706d2070595003 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Thu, 16 Aug 2018 20:53:38 +0200 Subject: Small documentation fixes. --- api/viewsets.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'api/viewsets.py') diff --git a/api/viewsets.py b/api/viewsets.py index 97b0f552..5e38bdc9 100644 --- a/api/viewsets.py +++ b/api/viewsets.py @@ -11,7 +11,7 @@ class SnakeNameViewSet(ViewSet): ## Routes ### GET /bot/snake-names - By default, return a single random snake name in the following format: + By default, return a single random snake name as JSON in the following format: >>> { ... 'name': "Python", @@ -27,6 +27,9 @@ class SnakeNameViewSet(ViewSet): ... {'name': "Python 3", 'scientific': "Langus greatus"}, ... {'name': "Python 2", 'scientific': "Langus decentus"} ... ] + + ## Authentication + Requires a API token. """ serializer_class = SnakeNameSerializer -- cgit v1.2.3