Demonstrate a difference in docstring treatment (#39)

openedx · May 20, 2020 · 152a197 · 152a197
1 parent 54a0c81
commit 152a197
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 3 deletions.
diff --git a/example/views.py b/example/views.py
@@ -159,6 +159,23 @@ def get(self, request):
         Get information about the Hedgehog API.
 
         Returns a object with keys and values describing the API.
+
+        Args:
+            request: a Request.
+
+        """
+        raise EndpointNotImplemented()
+
+    def put(self, request):
+        """
+        Not really an endpoint at all, but has no @schema decorator.
+
+        This is to show the difference in treatment.  This is a second
+        paragraph which will be included in the docs.
+
+        Args:
+            request: a Request.
+
         """
         raise EndpointNotImplemented()
 

diff --git a/tests/expected_schema.json b/tests/expected_schema.json
@@ -231,7 +231,7 @@
         },
         "/hedgehog/v0/info": {
             "get": {
-                "description": "Returns a object with keys and values describing the API.",
+                "description": "Returns a object with keys and values describing the API.\n\nArgs:\n    request: a Request.",
                 "operationId": "hedgehog_v0_info_list",
                 "parameters": [],
                 "responses": {
@@ -244,7 +244,21 @@
                     "hedgehog"
                 ]
             },
-            "parameters": []
+            "parameters": [],
+            "put": {
+                "description": "This is to show the difference in treatment.  This is a second\nparagraph which will be included in the docs.",
+                "operationId": "hedgehog_v0_info_update",
+                "parameters": [],
+                "responses": {
+                    "200": {
+                        "description": ""
+                    }
+                },
+                "summary": "Not really an endpoint at all, but has no @schema decorator.",
+                "tags": [
+                    "hedgehog"
+                ]
+            }
         }
     },
     "produces": [
@@ -264,4 +278,4 @@
         }
     },
     "swagger": "2.0"
-}
+}