diff options
| author | lain <lain@soykaf.club> | 2020-06-06 10:35:38 +0200 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2020-06-06 10:35:38 +0200 |
| commit | c5e3f2454c736e09de5c433a2bf578e8eb0e70c3 (patch) | |
| tree | 11dfb29778525879c71f9e5b461d6ef2f77d7abb | |
| parent | 4e8c0eecd5179428a47795380a9da1ab0419e024 (diff) | |
| download | pleroma-c5e3f2454c736e09de5c433a2bf578e8eb0e70c3.tar.gz pleroma-c5e3f2454c736e09de5c433a2bf578e8eb0e70c3.zip | |
Docs: Unify parameters in examples.
| -rw-r--r-- | docs/API/chats.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/API/chats.md b/docs/API/chats.md index abeee698f..761047336 100644 --- a/docs/API/chats.md +++ b/docs/API/chats.md @@ -41,7 +41,7 @@ This is the overview of using the API. The API is also documented via OpenAPI, s To create or get an existing Chat for a certain recipient (identified by Account ID) you can call: -`POST /api/v1/pleroma/chats/by-account-id/{account_id}` +`POST /api/v1/pleroma/chats/by-account-id/:account_id` The account id is the normal FlakeId of the user ``` @@ -136,7 +136,7 @@ The usual pagination options are implemented. For a given Chat id, you can get the associated messages with -`GET /api/v1/pleroma/chats/{id}/messages` +`GET /api/v1/pleroma/chats/:id/messages` This will return all messages, sorted by most recent to least recent. The usual pagination options are implemented. @@ -177,7 +177,7 @@ Returned data: Posting a chat message for given Chat id works like this: -`POST /api/v1/pleroma/chats/{id}/messages` +`POST /api/v1/pleroma/chats/:id/messages` Parameters: - content: The text content of the message. Optional if media is attached. @@ -210,7 +210,7 @@ Returned data: Deleting a chat message for given Chat id works like this: -`DELETE /api/v1/pleroma/chats/{chat_id}/messages/{message_id}` +`DELETE /api/v1/pleroma/chats/:chat_id/messages/:message_id` Returned data is the deleted message. |