Adding image endpoints to docs. Fixes #1226 (#1232)

This commit is contained in:
Dessalines 2020-10-26 07:07:23 -04:00 committed by GitHub
parent 4f0059198e
commit 6337762ec7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 42 additions and 0 deletions

View File

@ -262,6 +262,12 @@
+ [All](#all)
+ [Community](#community-1)
+ [User](#user)
* [Images](#images)
+ [Get](#get)
+ [Create](#create)
- [Request](#request-58)
- [Response](#response-58)
+ [Delete](#delete)
<!-- tocstop -->
@ -2032,3 +2038,39 @@ Only the recipient can do this.
`/feeds/u/user-name.xml?sort=Hot`
### Images
Lemmy forwards image requests to a locally running Pictrs.
#### Get
*Format and thumbnail are optional.*
`GET /pictrs/image/{filename}?format={webp, jpg, ...}&thumbnail={96}`
#### Create
##### Request
Uploaded content must be valid multipart/form-data with an image array located within the images[] key.
`POST /pictrs/image`
##### Response
```
{
"files": [
{
"delete_token": "{token}",
"file": "{file}.jpg"
}
],
"msg": "ok"
}
```
#### Delete
`GET /pictrs/image/delete/{delete_token}/{file}`