luna/akkoma
1
0
Fork 0
forked from AkkomaGang/akkoma
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: Unify parameters in examples.

Browse source
This commit is contained in:
lain 2020-06-06 10:35:38 +02:00
parent 4e8c0eecd5
commit c5e3f2454c
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/API/chats.md
View file

@ -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) To create or get an existing Chat for a certain recipient (identified by Account ID)
you can call: 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 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 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 This will return all messages, sorted by most recent to least recent. The usual
pagination options are implemented. pagination options are implemented.
@ -177,7 +177,7 @@ Returned data:
Posting a chat message for given Chat id works like this: 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: Parameters:
- content: The text content of the message. Optional if media is attached. - 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: 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. Returned data is the deleted message.