diff options
Diffstat (limited to 'docs/RESTAPI.md')
| -rw-r--r-- | docs/RESTAPI.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/RESTAPI.md b/docs/RESTAPI.md index 6b072d188..d3ec04d07 100644 --- a/docs/RESTAPI.md +++ b/docs/RESTAPI.md @@ -1,5 +1,9 @@ # REST API +The REST interface exposed is considered a private implementation detail and +is going to evolve. We do not recommend that you interface with it other than +for testing purposes. + ## Test Service Intended to be used for basic connectivity testing. Allows the client to fetch @@ -7,10 +11,15 @@ various kinds of payloads via well-known URIs HTTP endpoint: `/test` -`/test/size/{size}` - verbs: (`GET`) +`/test/{size}` - verbs: (`GET`/`HEAD`) + +Examples: `/test/1K` `/test/1M` `/test/1G`, `/test/1M_1k`, `/test/1G_1k` ## Cache Service HTTP endpoint: `/cache` `/cache/` + +## Status Service + |