doc: add info about queue over rest and add to CLI help about queue c…

…ommand usage
reddec · Dec 27, 2019 · 9fbb28f · 9fbb28f
1 parent b905789
commit 9fbb28f
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/docs/cli/storages.md b/docs/cli/storages.md
@@ -37,6 +37,27 @@ Available commands:
 
 See `storages <command> --help`
 
+### Queues
+
+```
+Usage:
+  storages [OPTIONS] queue <command>
+
+Application Options:
+  -u, --url=      Storage URL (default: bbolt://data) [$URL]
+  -k, --key=      Key in storage where configuration defined [$KEY]
+  -L, --lock=     Optional lock file for inter-process synchronization [$LOCK]
+
+Help Options:
+  -h, --help      Show this help message
+
+Available commands:
+  discard  remove oldest data from queue (like silent get)
+  get      get oldest data from queue and remove it (aliases: pop)
+  peek     get oldest data from queue but not remove
+  put      put data to the queue (aliases: push, append)
+  serve    expose queue over REST interface (aliases: rest)
+```
 
 
 # Install

diff --git a/docs/derived/queues.md b/docs/derived/queues.md
@@ -19,4 +19,16 @@ import: `github.com/reddec/storages/queues`
 
 Constructors:
 
-* `Naive`
+* `Naive`
+
+
+## HTTP expose
+
+It's possible to expose queue over HTTP by `NewServer(queue)`  
+
+
+| Method   | Path   | Success status | Description |
+|----------|--------|----------------|-------------
+| `GET`    | `/`    | 200            | Peek last message in queue (404 NotFound if queue is empty)
+| `POST`   | `/`    | 204            | Add message to queue
+| `DELETE` | `/`    | 200            | Get last message from queue and remove it. Last message will be returned otherwise 404 not found