Merge pull request #1199 from getsentry/docs/document-full-param

ref(api-docs): Document full param
getsentry · Sep 5, 2019 · 800b6e0 · 800b6e0
2 parents 04c5cbc + 78a6484
commit 800b6e0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/src/collections/_documentation/api/events/get-group-events.md b/src/collections/_documentation/api/events/get-group-events.md
@@ -16,7 +16,13 @@
       "type": "string"
     }
   ], 
-  "query_parameters": null, 
+  "query_parameters": [
+    {
+      "description": "if this is set to true, then the event payload will include the full event body, including the stack trace. Set to 1 to enable.", 
+      "name": "full", 
+      "type": "boolean"
+    }
+  ],  
   "sidebar_order": 9, 
   "title": "List an Issue's Events", 
   "warning": null

diff --git a/src/collections/_documentation/api/events/get-project-events.md b/src/collections/_documentation/api/events/get-project-events.md
@@ -21,7 +21,13 @@
       "type": "string"
     }
   ], 
-  "query_parameters": null, 
+  "query_parameters": [
+    {
+      "description": "if this is set to true, then the event payload will include the full event body, including the stack trace. Set to 1 to enable.", 
+      "name": "full", 
+      "type": "boolean"
+    }
+  ],  
   "sidebar_order": 1, 
   "title": "List a Project's Events", 
   "warning": null