From c631dc58ced61f9775baa34d3e1837766c25654a Mon Sep 17 00:00:00 2001 From: Felix Ableitner Date: Thu, 5 Nov 2020 13:16:34 +0100 Subject: [PATCH] Add missing docs for community deletion/removal (fixes #1250) --- docs/src/contributing_apub_api_outline.md | 50 +++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/docs/src/contributing_apub_api_outline.md b/docs/src/contributing_apub_api_outline.md index 0556e484d..f5c7a5951 100644 --- a/docs/src/contributing_apub_api_outline.md +++ b/docs/src/contributing_apub_api_outline.md @@ -559,6 +559,56 @@ Sent to: User |---|---|---| | `object` | yes | Any `Create`, `Update`, `Like`, `Dislike`, `Delete` `Remove` or `Undo` activity as described above | +### Remove or Delete Community + +```json +{ + "@context": "https://www.w3.org/ns/activitystreams", + "id": "http://ds9.lemmy.ml/activities/remove/e4ca7688-af9d-48b7-864f-765e7f9f3591", + "type": "Remove", + "actor": "http://ds9.lemmy.ml/c/some_community", + "cc": [ + "http://ds9.lemmy.ml/c/some_community/followers" + ], + "to": "https://www.w3.org/ns/activitystreams#Public", + "object": "http://ds9.lemmy.ml/c/some_community" +} +``` + +| Field Name | Mandatory | Description | +|---|---|---| +| `type` | yes | Either `Remove` or `Delete` | + +### Restore Removed or Deleted Community + +```json +{ + "@context": "https://www.w3.org/ns/activitystreams", + "id": "http://ds9.lemmy.ml/activities/like/0703668c-8b09-4a85-aa7a-f93621936901", + "type": "Undo", + "actor": "http://ds9.lemmy.ml/c/some_community", + "to": "https://www.w3.org/ns/activitystreams#Public", + "cc": [ + "http://ds9.lemmy.ml/c/testcom/followers" + ], + "object": { + "@context": "https://www.w3.org/ns/activitystreams", + "id": "http://ds9.lemmy.ml/activities/remove/1062b5e0-07e8-44fc-868c-854209935bdd", + "type": "Remove", + "actor": "http://ds9.lemmy.ml/c/some_community", + "object": "http://ds9.lemmy.ml/c/testcom", + "to": "https://www.w3.org/ns/activitystreams#Public", + "cc": [ + "http://ds9.lemmy.ml/c/testcom/followers" + ] + } +} + +``` +| Field Name | Mandatory | Description | +|---|---|---| +| `object.type` | yes | Either `Remove` or `Delete` | + ### Create or Update Private message Creates a new private message between two users.