[api] add event delete api docs for shell

samanthadrago · samanthadrago · commit 36a9b08cca0d · 2016-07-22T14:39:46.000-04:00
diff --git a/code_snippets/api-events-delete.py b/code_snippets/api-events-delete.py
@@ -0,0 +1,2 @@
+# Deleting events is not yet implemented in the Python
+# library. The docs will be updated when it has been implemented.
diff --git a/code_snippets/api-events-delete.rb b/code_snippets/api-events-delete.rb
@@ -0,0 +1,2 @@
+# Deleting events is not yet implemented in the Ruby
+# library. The docs will be updated when it has been implemented.
diff --git a/code_snippets/api-events-delete.sh b/code_snippets/api-events-delete.sh
@@ -0,0 +1,5 @@
+api_key=9775a026f1ca7d1c6c5af9d94d9595a4
+app_key=87ce4a24b5553d2e482ea8a8500e71b8ad4554ff
+event_id=1377281704830403917
+
+curl -X DELETE "https://app.datadoghq.com/api/v1/events/${event_id}?api_key=${api_key}&application_key=${app_key}"
diff --git a/code_snippets/results/result.api-events-delete.py b/code_snippets/results/result.api-events-delete.py
@@ -0,0 +1,2 @@
+## Deleting events is not yet implemented in the Python
+# library. The docs will be updated when it has been implemented.
diff --git a/code_snippets/results/result.api-events-delete.rb b/code_snippets/results/result.api-events-delete.rb
@@ -0,0 +1,2 @@
+# Deleting events is not yet implemented in the Ruby
+# library. The docs will be updated when it has been implemented.
diff --git a/code_snippets/results/result.api-events-delete.sh b/code_snippets/results/result.api-events-delete.sh
@@ -0,0 +1 @@
+{"deleted_event_id": "1377281704830403917"}
diff --git a/content/api/index.html b/content/api/index.html
@@ -306,6 +306,29 @@ <h5>Example Response</h5>
       </div>
     </div>
 
+    <div class="int-anchor" id="events-delete"></div><a href="#events-delete"><h4>Delete an Event</h4></a>
+    <div class="row">
+      <%= left_side_div %>
+        <p>
+          This end point allows you to delete an event.
+        </p>
+        <h5>Arguments</h5>
+        <%= no_args %>
+      </div>
+      <%= right_side_div %>
+        <h5>Signature</h5>
+        <code>DELETE /api/v1/events/:event_id</code>
+        <h5>Example Request</h5>
+        <%= snippet_code_block "api-events-delete.py" %>
+        <%= snippet_code_block "api-events-delete.sh" %>
+        <%= snippet_code_block "api-events-delete.rb" %>
+        <h5>Example Response</h5>
+        <%= snippet_result_code_block "api-events-delete.py" %>
+        <%= snippet_result_code_block "api-events-delete.sh" %>
+        <%= snippet_result_code_block "api-events-delete.rb" %>
+      </div>
+    </div>
+
     <div class="int-anchor" id="events-get-all"></div><a href="#events-get-all"><h4>Query the Event Stream</h4></a>
     <div class="row">
       <%= left_side_div %>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Deleting events is not yet implemented in the Python`
	`2`	`+# library. The docs will be updated when it has been implemented.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+## Deleting events is not yet implemented in the Python`
	`2`	`+# library. The docs will be updated when it has been implemented.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"deleted_event_id": "1377281704830403917"}`