From bc8b19d8b611cdf3c7aafdd0a8e9d1c9d090bb96 Mon Sep 17 00:00:00 2001 From: asonix Date: Sat, 11 Jul 2020 17:26:41 -0500 Subject: [PATCH] Add more JSON to readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 0547658b..8a71e858 100644 --- a/README.md +++ b/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