Add API ref of purging queue
Now Zaqar has supported to qurge queue, add api ref for it. Partially Implements: blueprint purge-queue Change-Id: If9f4f5aec92bf8c4bd5e9e0f0ca833bc8214b121
This commit is contained in:
parent
3e7082484d
commit
b41802c3ad
@ -213,6 +213,14 @@ flavor_pool_group:
|
||||
The ``pool_group`` attribute specifies the name of the pool group
|
||||
this flavor sits on top of.
|
||||
|
||||
resource_types:
|
||||
type: list
|
||||
in: body
|
||||
required: false
|
||||
description: |
|
||||
The ``resource_types`` attribute allows user to purge particular resource
|
||||
of the queue.
|
||||
|
||||
#### variables in response ###################################################
|
||||
|
||||
versions:
|
||||
|
@ -264,7 +264,7 @@ Pre-signed queue
|
||||
|
||||
Create a pre-signed URL for a given queue.
|
||||
|
||||
.. note:
|
||||
.. note::
|
||||
|
||||
In the case of pre-signed URLs, the queue cannot be created lazily. This
|
||||
is to prevent cases where queues are deleted and users still have a valid
|
||||
@ -317,3 +317,39 @@ Response Example
|
||||
|
||||
.. literalinclude:: samples/queue-pre-signed-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Purge queue
|
||||
===========
|
||||
|
||||
.. rest_method:: POST /v2/queues/{queue_name}/purge
|
||||
|
||||
Purge particular resource of the queue.
|
||||
|
||||
.. note::
|
||||
|
||||
Now Zaqar supports to purge "messages" and "subscriptions" resource from
|
||||
a queue.
|
||||
|
||||
Normal response codes: 204
|
||||
|
||||
Error response codes:
|
||||
|
||||
- BadRequest (400)
|
||||
- Unauthorized (401)
|
||||
- ServiceUnavailable (503)
|
||||
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- queue_name: queue_name
|
||||
- resource_types: resource_types
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/purge-queue-request.json
|
||||
:language: javascript
|
||||
|
3
api-ref/source/samples/purge-queue-request.json
Normal file
3
api-ref/source/samples/purge-queue-request.json
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"resource_types": ["messages", "subscriptions"]
|
||||
}
|
Loading…
Reference in New Issue
Block a user