Add enpoint docs to Queue

ECN · Apr 4, 2021 · 52d91ef · 52d91ef
1 parent e1bea81
commit 52d91ef
Showing 1 changed file with 20 additions and 0 deletions.
diff --git 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`