Update Queue endpoint and params docs

ECN · Jun 21, 2021 · 15a6697 · 15a6697
1 parent 2b026ee
commit 15a6697
Showing 1 changed file with 15 additions and 2 deletions.
diff --git 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
 - | -