From: Dessalines <dessalines@users.noreply.github.com>
Date: Mon, 26 Oct 2020 11:07:23 +0000 (-0400)
Subject: Adding image endpoints to docs. Fixes #1226 (#1232)
X-Git-Url: http://these/git/%7B%27/docs/static/%24%7Bsubmission.url%7D?a=commitdiff_plain;h=6337762ec71ff9c1f966934a3ce7947de8e7a8ce;p=lemmy.git

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

diff --git a/docs/src/contributing_websocket_http_api.md b/docs/src/contributing_websocket_http_api.md
index 8a81b6c3..04a89cb9 100644
--- a/docs/src/contributing_websocket_http_api.md
+++ b/docs/src/contributing_websocket_http_api.md
@@ -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}`
+