LemmyNet/pict-rs
2
0
Fork 0
mirror of https://git.asonix.dog/asonix/pict-rs synced 2024-12-22 19:31:35 +00:00
Code Releases Activity

Add more JSON to readme

Browse source
This commit is contained in:
asonix 2020-07-11 17:26:41 -05:00
parent 7c0a407568
commit bc8b19d8b6
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -134,10 +134,27 @@ A secure API key can be generated by any password generator.
files associated with the query. files associated with the query.
- `?file=asdf.png` purge by filename - `?file=asdf.png` purge by filename
- `?alias=asdf.png` purge by alias - `?alias=asdf.png` purge by alias
This endpoint returns the following JSON
```json
{
"msg": "ok",
"aliases": ["asdf.png"]
}
```
- `GET /internal/aliases?...` Get the aliases for a file by it's filename or alias - `GET /internal/aliases?...` Get the aliases for a file by it's filename or alias
- `?file={filename}` get aliases by filename - `?file={filename}` get aliases by filename
- `?alias={alias}` get aliases by alias - `?alias={alias}` get aliases by alias
This endpiont returns the same JSON as the purge endpoint
- `GET /internal/filename?alias={alias}` Get the filename for a file by it's alias - `GET /internal/filename?alias={alias}` Get the filename for a file by it's alias
This endpoint returns the following JSON
```json
{
"msg": "ok",
"filename": "asdf.png"
}
```
## Contributing ## Contributing