mirror of
https://git.asonix.dog/asonix/pict-rs
synced 2024-12-22 19:31:35 +00:00
Add more JSON to readme
This commit is contained in:
parent
7c0a407568
commit
bc8b19d8b6
1 changed files with 17 additions and 0 deletions
17
README.md
17
README.md
|
@ -134,10 +134,27 @@ A secure API key can be generated by any password generator.
|
|||
files associated with the query.
|
||||
- `?file=asdf.png` purge by filename
|
||||
- `?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
|
||||
- `?file={filename}` get aliases by filename
|
||||
- `?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
|
||||
This endpoint returns the following JSON
|
||||
```json
|
||||
{
|
||||
"msg": "ok",
|
||||
"filename": "asdf.png"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Contributing
|
||||
|
|
Loading…
Reference in a new issue