"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "api-ref/source/queues.inc" between
zaqar-5.0.0.tar.gz and zaqar-7.0.0.tar.gz

About: OpenStack Zaqar is a multi-tenant cloud messaging and notification service for web and mobile developers.
The "Rocky" series (latest release).

queues.inc  (zaqar-5.0.0):queues.inc  (zaqar-7.0.0)
skipping to change at line 26 skipping to change at line 26
.. rest_method:: GET /v2/queues .. rest_method:: GET /v2/queues
Lists queues. Lists queues.
A request to list queues when you have no queues in your account returns 204, A request to list queues when you have no queues in your account returns 204,
instead of 200, because there was no information to send back. instead of 200, because there was no information to send back.
This operation lists queues for the project. The queues are sorted This operation lists queues for the project. The queues are sorted
alphabetically by name. alphabetically by name.
Normal response codes: 200 When queue listing , we can add filter in query string parameter
to filter queue, like name and metadata. If metadata or name of queue is
consistent with the filter,the queue will be listed to the user,
otherwise the queue will be filtered.
Error response codes: Response codes
--------------
- BadRequest (400) .. rest_status_code:: success status.yaml
- Unauthorized (401)
- ServiceUnavailable (503) - 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 503
Request Parameters Request Parameters
------------------ ------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- limit: limit - limit: limit
- marker: marker - marker: marker
- detailed: detailed - detailed: detailed
skipping to change at line 76 skipping to change at line 86
The body of the request is empty. The body of the request is empty.
``queue_name`` is the name that you give to the queue. The name must not ``queue_name`` is the name that you give to the queue. The name must not
exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, exceed 64 bytes in length, and it is limited to US-ASCII letters, digits,
underscores, and hyphens. underscores, and hyphens.
When create queue, user can specify metadata for the queue. Currently, Zaqar When create queue, user can specify metadata for the queue. Currently, Zaqar
supports below metadata: _flavor, _max_claim_count, _dead_letter_queue and supports below metadata: _flavor, _max_claim_count, _dead_letter_queue and
_dead_letter_queue_messages_ttl. _dead_letter_queue_messages_ttl.
Normal response codes: 201, 204 In order to support the delayed queues, now add a metadata
``_default_message_delay``.
Response codes
--------------
.. rest_status_code:: success status.yaml
Error response codes: - 201
- 204
- BadRequest (400) .. rest_status_code:: error status.yaml
- Unauthorized (401)
- ServiceUnavailable (503) - 400
- 401
- 503
Request Parameters Request Parameters
------------------ ------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- queue_name: queue_name - queue_name: queue_name
- _dead_letter_queue: _dead_letter_queue - _dead_letter_queue: _dead_letter_queue
- _dead_letter_queue_messages_ttl: _dead_letter_queue_messages_ttl - _dead_letter_queue_messages_ttl: _dead_letter_queue_messages_ttl
- _default_message_delay: _default_message_delay
- _default_message_ttl: _default_message_ttl - _default_message_ttl: _default_message_ttl
- _flavor: _flavor - _flavor: _flavor
- _max_claim_count: _max_claim_count - _max_claim_count: _max_claim_count
- _max_messages_post_size: _max_messages_post_size - _max_messages_post_size: _max_messages_post_size
Request Example Request Example
--------------- ---------------
.. literalinclude:: samples/queue-create-request.json .. literalinclude:: samples/queue-create-request.json
:language: javascript :language: javascript
This operation does not return a response body. This operation does not return a response body.
Update queue Update queue
============ ============
.. rest_method:: PATCH /v2/queues/{queue_name} .. rest_method:: PATCH /v2/queues/{queue_name}
Updates a queue. Updates a queue.
Normal response codes: 200 Response codes
--------------
.. rest_status_code:: success status.yaml
Error response codes: - 200
- BadRequest (400) .. rest_status_code:: error status.yaml
- Unauthorized (401)
- Not Found (404) - 400
- Conflict (409) - 401
- ServiceUnavailable (503) - 404
- 409
- 503
Request Parameters Request Parameters
------------------ ------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- queue_name: queue_name - queue_name: queue_name
When setting the request body of updating queue, the body must be a list which When setting the request body of updating queue, the body must be a list which
contains a series of json object which follows contains a series of json object which follows
skipping to change at line 160 skipping to change at line 185
.. literalinclude:: samples/queue-update-response.json .. literalinclude:: samples/queue-update-response.json
:language: javascript :language: javascript
Show queue details Show queue details
================== ==================
.. rest_method:: GET /v2/queues/{queue_name} .. rest_method:: GET /v2/queues/{queue_name}
Shows details for a queue. Shows details for a queue.
Normal response codes: 200 Response codes
--------------
.. rest_status_code:: success status.yaml
Error response codes: - 200
- BadRequest (400) .. rest_status_code:: error status.yaml
- Unauthorized (401)
- ServiceUnavailable (503) - 400
- 401
- 503
Request Parameters Request Parameters
------------------ ------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- queue_name: queue_name - queue_name: queue_name
Response Parameters Response Parameters
------------------- -------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- _max_messages_post_size: _max_messages_post_size - _max_messages_post_size: _max_messages_post_size
- _default_message_delay: _default_message_delay
- _default_message_ttl: _default_message_ttl - _default_message_ttl: _default_message_ttl
Response Example Response Example
---------------- ----------------
.. literalinclude:: samples/queue-show-response.json .. literalinclude:: samples/queue-show-response.json
:language: javascript :language: javascript
Delete queue Delete queue
=============== ===============
skipping to change at line 202 skipping to change at line 233
.. rest_method:: DELETE /v2/queues/{queue_name} .. rest_method:: DELETE /v2/queues/{queue_name}
Deletes the specified queue. Deletes the specified queue.
This operation immediately deletes a queue and all of its existing messages. This operation immediately deletes a queue and all of its existing messages.
``queue_name`` is the name that you give to the queue. The name must not ``queue_name`` is the name that you give to the queue. The name must not
exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, exceed 64 bytes in length, and it is limited to US-ASCII letters, digits,
underscores, and hyphens. underscores, and hyphens.
Normal response codes: 204 Response codes
--------------
.. rest_status_code:: success status.yaml
- 204
Error response codes: .. rest_status_code:: error status.yaml
- BadRequest (400) - 400
- Unauthorized (401) - 401
- ServiceUnavailable (503) - 503
Request Parameters Request Parameters
------------------ ------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- queue_name: queue_name - queue_name: queue_name
This operation does not accept a request body and does not return a response This operation does not accept a request body and does not return a response
body. body.
skipping to change at line 233 skipping to change at line 269
.. rest_method:: GET /v2/queues/{queue_name}/stats .. rest_method:: GET /v2/queues/{queue_name}/stats
Returns statistics for the specified queue. Returns statistics for the specified queue.
This operation returns queue statistics, including how many messages are in This operation returns queue statistics, including how many messages are in
the queue, categorized by status. the queue, categorized by status.
If the value of the ``total`` attribute is 0, then ``oldest`` and ``newest`` If the value of the ``total`` attribute is 0, then ``oldest`` and ``newest``
message statistics are not included in the response. message statistics are not included in the response.
Normal response codes: 200 Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
Error response codes: .. rest_status_code:: error status.yaml
- BadRequest (400) - 400
- Unauthorized (401) - 401
- ServiceUnavailable (503) - 503
Request Parameters Request Parameters
------------------ ------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- queue_name: queue_name - queue_name: queue_name
Response Example Response Example
---------------- ----------------
skipping to change at line 265 skipping to change at line 306
================ ================
.. rest_method:: POST /v2/queues/{queue_name}/share .. rest_method:: POST /v2/queues/{queue_name}/share
Create a pre-signed URL for a given 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 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 is to prevent cases where queues are deleted and users still have a valid
URL. This is not a big issues in cases where there’s just 1 pool. However, URL. This is not a big issues in cases where there's just 1 pool. However,
if there’s a deployment using more than 1 type of pool, the lazily created if there's a deployment using more than 1 type of pool, the lazily created
queue may end up in an undesired pool and it’d be possible for an attacker queue may end up in an undesired pool and it'd be possible for an attacker
to try a DoS on that pool. Therefore, whenever a pre-signed URL is created, to try a DoS on that pool. Therefore, whenever a pre-signed URL is created,
if a pool doesnt exist, it needs to be created. if a pool doesn't exist, it needs to be created.
Normal response codes: 200 Response codes
--------------
Error response codes: .. rest_status_code:: success status.yaml
- BadRequest (400) - 200
- Unauthorized (401)
- Not Found (404) .. rest_status_code:: error status.yaml
- ServiceUnavailable (503)
- 400
- 401
- 404
- 503
Request Parameters Request Parameters
------------------ ------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- queue_name: queue_name - queue_name: queue_name
- paths: pre_signed_queue_paths - paths: pre_signed_queue_paths
- methods: pre_signed_queue_methods - methods: pre_signed_queue_methods
- expires: pre_signed_queue_expires - expires: pre_signed_queue_expires
skipping to change at line 325 skipping to change at line 371
.. rest_method:: POST /v2/queues/{queue_name}/purge .. rest_method:: POST /v2/queues/{queue_name}/purge
Purge particular resource of the queue. Purge particular resource of the queue.
.. note:: .. note::
Now Zaqar supports to purge "messages" and "subscriptions" resource from Now Zaqar supports to purge "messages" and "subscriptions" resource from
a queue. a queue.
Normal response codes: 204 Response codes
--------------
.. rest_status_code:: success status.yaml
- 204
Error response codes: .. rest_status_code:: error status.yaml
- BadRequest (400) - 400
- Unauthorized (401) - 401
- ServiceUnavailable (503) - 503
Request Parameters Request Parameters
------------------ ------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- queue_name: queue_name - queue_name: queue_name
- resource_types: resource_types - resource_types: resource_types
Request Example Request Example
 End of changes. 28 change blocks. 
47 lines changed or deleted 98 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)