summaryrefslogtreecommitdiff
path: root/docs/api.md
diff options
context:
space:
mode:
authorOwen Jacobson <owen@grimoire.ca>2024-10-08 22:10:04 -0400
committerOwen Jacobson <owen@grimoire.ca>2024-10-09 11:45:31 -0400
commit653e2de752a97e377fc9963ba60d9408e7089528 (patch)
treea707919c0c0cb3c84ec3ea624ae8cd87059f28ac /docs/api.md
parentdd62b823e01934a0f841256fdb17b551091896bf (diff)
Flatten nested `channel` and `message` structs in events and API responses.
This structure didn't accomplish anything and made certain refactorings harder.
Diffstat (limited to 'docs/api.md')
-rw-r--r--docs/api.md22
1 files changed, 8 insertions, 14 deletions
diff --git a/docs/api.md b/docs/api.md
index 91485f3..13e71c7 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -36,10 +36,8 @@ Returns information needed to boot the client. Also the recommended way to check
"id": "L1234abcd",
"name": "example username"
},
- "message": {
- "id": "M1312acab",
- "body": "beep"
- }
+ "id": "M1312acab",
+ "body": "beep"
}
]
}
@@ -204,10 +202,8 @@ id: 1233
data: {
data: "type": "created",
data: "at": "2024-09-27T23:18:10.208147Z",
-data: "channel": {
-data: "id": "C9876cyyz",
-data: "name": "example channel 2"
-data: }
+data: "id": "C9876cyyz",
+data: "name": "example channel 2"
data: }
id: 1234
@@ -222,10 +218,8 @@ data: "sender": {
data: "id": "L1234abcd",
data: "name": "example username"
data: },
-data: "message": {
-data: "id": "M1312acab",
-data: "body": "beep"
-data: }
+data: "id": "M1312acab",
+data: "body": "beep"
data: }
id: 1235
@@ -236,14 +230,14 @@ data: "id": "C9876cyyz",
data: "name": "example channel 2"
data: },
data: "type": "message_deleted",
-data: "message": "M1312acab"
+data: "id": "M1312acab"
data: }
id: 1236
data: {
data: "at": "2024-09-28T03:40:25.384318Z",
data: "type": "deleted",
-data: "channel": "C9876cyyz"
+data: "id": "C9876cyyz"
data: }
```