aboutsummaryrefslogtreecommitdiff
path: root/docs/RESTAPI.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2023-05-02 10:01:47 +0200
committerGitHub <[email protected]>2023-05-02 10:01:47 +0200
commit075d17f8ada47e990fe94606c3d21df409223465 (patch)
treee50549b766a2f3c354798a54ff73404217b4c9af /docs/RESTAPI.md
parentfix: bundle shouldn't append content zip to zen (diff)
downloadzen-075d17f8ada47e990fe94606c3d21df409223465.tar.xz
zen-075d17f8ada47e990fe94606c3d21df409223465.zip
moved source directories into `/src` (#264)
* moved source directories into `/src` * updated bundle.lua for new `src` path * moved some docs, icon * removed old test trees
Diffstat (limited to 'docs/RESTAPI.md')
-rw-r--r--docs/RESTAPI.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/RESTAPI.md b/docs/RESTAPI.md
new file mode 100644
index 000000000..6b072d188
--- /dev/null
+++ b/docs/RESTAPI.md
@@ -0,0 +1,16 @@
+# REST API
+
+## Test Service
+
+Intended to be used for basic connectivity testing. Allows the client to fetch
+various kinds of payloads via well-known URIs
+
+HTTP endpoint: `/test`
+
+`/test/size/{size}` - verbs: (`GET`)
+
+## Cache Service
+
+HTTP endpoint: `/cache`
+
+`/cache/`