From 15a669759fe794d0763ba3554c64b14d7c715703 Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Mon, 21 Jun 2021 15:15:42 -0400 Subject: [PATCH] Update Queue endpoint and params docs --- docs/api/Queues.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/api/Queues.md b/docs/api/Queues.md index 0ef4ce9..03a94e0 100644 --- a/docs/api/Queues.md +++ b/docs/api/Queues.md @@ -4,7 +4,7 @@ A collection of [Items](/api/Items/). ## Endpoint ``` -GET /api/{queue} +GET /api/data/{queue} ``` ### Parameters Name | Value @@ -14,12 +14,13 @@ Name | Value ### 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"` +`headers_only` | When `"True"`, only meta data will be loaded. When `"False"` content will be parsed. (Defaults to `"True"`.) | `"True"` \| `"True"` ### Return Codes Code | Description - | - `200 - Ok` | On success. +`404 - Not Found` | When the Queue does not exist. `500 - Internal Service Error` | On failure. ## Properties @@ -36,6 +37,18 @@ Type | Description "ce" ``` +### `Queue.path` +Type | Description +- | - +`String` | The absolute file path to the Queue. + +!!! example + ```js + console.log(Queue.path) + // Expected Output + "/home/pier/e/queue/Mail/ce" + ``` + ### `Queue.items` Type | Description - | -