aboutsummaryrefslogtreecommitdiff
path: root/docs/RESTAPI.md
diff options
context:
space:
mode:
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/`