diff options
| author | lain <lain@soykaf.club> | 2020-11-04 11:47:41 +0100 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2020-11-04 11:47:41 +0100 |
| commit | c7bcbfbc1d5d34463634e44979a77a2c47e35dbc (patch) | |
| tree | a9d947e8f3c82b7c5cd1764d98be46cf95b7e085 /docs/API | |
| parent | 1cc8e945064319014300de5880a326d1100bf43e (diff) | |
| parent | ba3f3a5a56d4a5ac05443fd30b5864778ad1131e (diff) | |
| download | pleroma-c7bcbfbc1d5d34463634e44979a77a2c47e35dbc.tar.gz | |
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into feature/local-only-scope
Diffstat (limited to 'docs/API')
| -rw-r--r-- | docs/API/chats.md | 5 | ||||
| -rw-r--r-- | docs/API/pleroma_api.md | 38 |
2 files changed, 42 insertions, 1 deletions
diff --git a/docs/API/chats.md b/docs/API/chats.md index aa6119670..9857aac67 100644 --- a/docs/API/chats.md +++ b/docs/API/chats.md @@ -173,11 +173,14 @@ Returned data: "created_at": "2020-04-21T15:06:45.000Z", "emojis": [], "id": "12", - "unread": false + "unread": false, + "idempotency_key": "75442486-0874-440c-9db1-a7006c25a31f" } ] ``` +- idempotency_key: The copy of the `idempotency-key` HTTP request header that can be used for optimistic message sending. Included only during the first few minutes after the message creation. + ### Posting a chat message Posting a chat message for given Chat id works like this: diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md index 3fd141bd2..7a0a80dad 100644 --- a/docs/API/pleroma_api.md +++ b/docs/API/pleroma_api.md @@ -615,3 +615,41 @@ Emoji reactions work a lot like favourites do. They make it possible to react to {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]} ] ``` + +## `POST /api/v1/pleroma/backups` +### Create a user backup archive + +* Method: `POST` +* Authentication: required +* Params: none +* Response: JSON +* Example response: + +```json +[{ + "content_type": "application/zip", + "file_size": 0, + "inserted_at": "2020-09-10T16:18:03.000Z", + "processed": false, + "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip" +}] +``` + +## `GET /api/v1/pleroma/backups` +### Lists user backups + +* Method: `GET` +* Authentication: not required +* Params: none +* Response: JSON +* Example response: + +```json +[{ + "content_type": "application/zip", + "file_size": 55457, + "inserted_at": "2020-09-10T16:18:03.000Z", + "processed": true, + "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip" +}] +``` |