localhots
/
burlesque
1
0
Fork 0
Code Releases Activity

Describe flush endpoint in readme

This commit is contained in:
Gregory Eremin 2014-09-24 20:02:48 +04:00
parent 12b3a12c51
commit 185ebcd7a0
1 changed files with 29 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -24,6 +24,7 @@ To store messages Burlesque uses [Kyoto Cabinet](http://fallabs.com/kyotocabinet
* [API](#api) * [API](#api)
* [Publish](#publish) * [Publish](#publish)
* [Subscribe](#subscribe) * [Subscribe](#subscribe)
* [Flush](#flush)
* [Status](#status) * [Status](#status)
* [Debug](#debug) * [Debug](#debug)
@ -193,7 +194,8 @@ In case of success, server will respond with status 200 and `OK` message. Otherw
#### Example #### Example
```bash ```bash
curl '127.0.0.1:4401/publish?queue=urgent' -d 'Process this message as soon as possible!' $ curl '127.0.0.1:4401/publish?queue=urgent' -d \
'Process this message as soon as possible!'
``` ```
Response Response
``` ```
@ -208,20 +210,43 @@ Subscription is always done via `GET` method. To fetch a message from a queue us
#### Example #### Example
```bash ```bash
curl '127.0.0.1:4401/subscribe?queues=urgent,someday' $ curl '127.0.0.1:4401/subscribe?queues=urgent,someday'
``` ```
Response Response
``` ```
Process this message as soon as possible! Process this message as soon as possible!
``` ```
## Flush
This endpoint is used to fetch all messages from all of the given queues. All messages are encoded into a single JSON document.
#### Example
```bash
$ curl '127.0.0.1:4401/flush?queues=urgent,someday' > dump.json
$ cat dump.json
```
Result
```json
[
{
"queue": "urgent",
"message": "Process this message as soon as possible!"
},
{
"queue": "someday",
"message": "Process this message in your spare time"
}
]
```
## Status ## Status
This endpoint is used to display information about the queues, their messages and current subscriptions encoded in JSON format. This endpoint is used to display information about the queues, their messages and current subscriptions encoded in JSON format.
#### Example #### Example
```bash ```bash
curl 127.0.0.1:4401/status $ curl '127.0.0.1:4401/status'
``` ```
Response Response
```json ```json
@ -243,7 +268,7 @@ This endpoint is used to display debug information about Burlesque process. Curr
#### Example #### Example
```bash ```bash
curl 127.0.0.1:4401/debug $ curl '127.0.0.1:4401/debug'
``` ```
Response Response
```json ```json