aboutsummaryrefslogtreecommitdiff
path: root/RESTAPI.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2021-05-11 13:05:39 +0200
committerStefan Boberg <[email protected]>2021-05-11 13:05:39 +0200
commitf8d9ac5d13dd37b8b57af0478e77ba1e75c813aa (patch)
tree1daf7621e110d48acd5e12e3073ce48ef0dd11b2 /RESTAPI.md
downloadzen-f8d9ac5d13dd37b8b57af0478e77ba1e75c813aa.tar.xz
zen-f8d9ac5d13dd37b8b57af0478e77ba1e75c813aa.zip
Adding zenservice code
Diffstat (limited to 'RESTAPI.md')
-rw-r--r--RESTAPI.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/RESTAPI.md b/RESTAPI.md
new file mode 100644
index 000000000..6b072d188
--- /dev/null
+++ b/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/`