update docstring

wilberh · Aug 30, 2023 · 5d81667 · 5d81667
1 parent 445b702
commit 5d81667
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/core/api/views.py b/core/api/views.py
@@ -23,10 +23,17 @@ class GoogleTrendApiDetail(APIView):
     :returns: JSON response based API body/payload request
 
     Example of API body/payload:
-        {"task": "quote", "ticker": "AAPL"
-            [OPTIONAL: ,"strt_dt": "2023-06-29", "end_dt": "2023-07-28"]}
-        {"task": "trend", "company": "Apple", "country": "us"
-            [OPTIONAL: ,"strt_dt": "2023-06-29", "end_dt": "2023-07-28"]}
+        - Stock quote:
+            {   "task": "quote", 
+                "ticker": "AAPL"
+                [OPTIONAL: ,"strt_dt": "2023-06-29", "end_dt": "2023-07-28"]
+            }
+        - Trending News Titles with Sentiment Analysis Score:
+            {   "task": "trend", 
+                "company": "Apple", 
+                "country": "us"
+                [OPTIONAL: ,"strt_dt": "2023-06-29", "end_dt": "2023-07-28"]
+            }
     """
     def post(self, request):
         data = request.data