Add endpoints for deleting channels and messages.

It is deliberate that the expire() functions do not use them. To avoid races, the transactions must be committed before events get sent, in both cases, which makes them structurally pretty different.

1 files changed, 28 insertions, 0 deletions

diff --git a/docs/api.md b/docs/api.md
index 5adf28d..ef211bc 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -151,6 +151,34 @@ Once the message is accepted, this will return a 202 Accepted response. The mess
 
 If the channel ID is not valid, this will return a 404 Not Found response.
 
+### `DELETE /api/channels/:channel`
+
+Deletes a channel (and all messages in it).
+
+The `:channel` placeholder must be a channel ID, as returned by `GET /api/channels` or `POST /api/channels`.
+
+#### On success
+
+This will return a 202 Accepted response on success, and delete the channel.
+
+#### Invalid channel ID
+
+If the channel ID is not valid, this will return a 404 Not Found response.
+
+### `DELETE /api/messages/:message`
+
+Deletes a message.
+
+The `:message` placeholder must be a message ID, as returned from the event stream or from a list of messages.
+
+#### On success
+
+This will return a 202 Accepted response on success, and delete the message.
+
+#### Invalid message ID
+
+If the message ID is not valid, this will return a 404 Not Found response.
+
 ### `GET /api/events`
 
 Subscribes to events. This endpoint returns an `application/event-stream` response, and is intended for use with the `EventSource` browser API. Events will be delivered on this stream as they occur, and the request will remain open to deliver events.