From 52d91ef35b038277432830536271b0a0e273095b Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Sat, 3 Apr 2021 23:55:47 -0400 Subject: [PATCH] Add enpoint docs to Queue --- docs/api/Queues.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/api/Queues.md b/docs/api/Queues.md index 4501f34..0ef4ce9 100644 --- a/docs/api/Queues.md +++ b/docs/api/Queues.md @@ -2,6 +2,26 @@ A collection of [Items](/api/Items/). +## Endpoint +``` +GET /api/{queue} +``` +### Parameters +Name | Value +- | - +`queue` | The name of the queue. + +### Query String Options +Name | Description | Possible Values +- | - | - +`headersOnly` | When `"True"`, only meta data will be loaded. When `"False"` content will be parsed. (Defaults to `"False"`.) | `"True"` \| `"True"` + +### Return Codes +Code | Description +- | - +`200 - Ok` | On success. +`500 - Internal Service Error` | On failure. + ## Properties ### `Queue.name`