LemmyNet
/
pict-rs
mirror of https://git.asonix.dog/asonix/pict-rs
2
0
Fork 0
Code Releases Activity

Make referencing endpoints more consistent

This commit is contained in:
Aode (lion) 2022-04-08 12:08:15 -05:00
parent 55d5e43cd2
commit 300fcdac05
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -259,10 +259,10 @@ pict-rs offers the following endpoints:
} }
``` ```
- `GET /image/download?url={url}&backgrounded=(true|false)&ephemeral=(true|false)` Download an image - `GET /image/download?url={url}&backgrounded=(true|false)&ephemeral=(true|false)` Download an image
from a remote server, returning the same JSON payload as the `POST` endpoint by default. from a remote server, returning the same JSON payload as the `POST /image` endpoint by default.
if `backgrounded` is set to `true`, then the ingest processing will be queued for later and the if `backgrounded` is set to `true`, then the ingest processing will be queued for later and the
response json will be the same as the `/image/backgrounded` endpoint. response json will be the same as the `POST /image/backgrounded` endpoint.
if `ephemeral` is set to true, the downloaded image will be marked as a "cached" image, and if `ephemeral` is set to true, the downloaded image will be marked as a "cached" image, and
automatically removed from pict-rs N hours after its last access. The duration is configurable automatically removed from pict-rs N hours after its last access. The duration is configurable