Commit Graph

61 Commits

Author SHA1 Message Date
wanghao cdf45da555 Fix API DOC
Now Zaqar's API could be finded on OpenInfra API Ref.
This patch want to fix this.

Change-Id: I1b60ae2c2230724a5a22ec51d5e0c32a5e4a5591
2022-07-06 15:59:54 +08:00
wanghao 96d9c97e55 Fix confirmation api doc missing
Zaqar didn't update the api doc after supporting
the confirmation feature.

Change-Id: Iff1e39b4b9d89ff925f5b21774265ea1bc9a0b5f
2021-07-09 10:01:20 +08:00
wanghao e12c65a369 Encrypted Messages in Queue
The queue in Zaqar will support to encrypt
messages before storing them into storage backends,
also could support to decrypt messages when those
are claimed by consumer. This feature will enhance
the security of messaging service.

Implements: blueprint encrypted-messages-in-queue
Signed-off-by: wanghao <sxmatch1986@gmail.com>
Change-Id: Icecfb9a232cfeefc2f9603934696bb2dcd56bc9c
2020-07-23 14:07:54 +08:00
melissaml e195c8112b Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_auto_name to use 'project' as name.

Change pygments_style to 'native' since old theme version always
used 'native' and the theme now respects the setting and using 'sphinx'
can lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not
needed during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the
renames before the next release removes them. A couple of variables
are also not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ie623e7a2389c292ffc71a285f0fc2d4bb9820c3f
2020-05-26 14:03:34 +08:00
Andreas Jaeger b6e1688b24 Doc cleanups
Switch to newer openstackdocstheme and remove settings that
are default now.

Change-Id: I27895a6fb91ba3be37831a697098718082eec00f
2020-05-13 17:49:28 +08:00
wanghao 7aa2522e3d Support query queues with count
Zaqar will support query queues with 'with_count' to
return the amount of the queues. This will help users to
quickly get the exact total number of queues which they own.

Change-Id: I1d2cdc802ecd76c01671cd5660ae79dd39505d43
Implements: blueprint query-queues-with-count
Signed-off-by: wanghao <sxmatch1986@gmail.com>
2020-01-10 14:52:10 +08:00
wanghao b963a91a11 Miss name filter in querying queues
Fix the missing name filter in querying queues.

Change-Id: I29f3f6e41773e84bb0580e87f1ac823917a0ea05
Closes-Bug: #1808756
2018-12-17 16:27:10 +08:00
wanghao ee0b807a44 Missing response parameters in API DOC
Three response parameters about dead_letter_queue is
missing in response doc.

Change-Id: Ibc92ae20306c6a733109e66ed87a4f270ee2d328
Closes-Bug: #1801678
2018-11-13 11:20:20 +08:00
Zuul 3dff7fd057 Merge "Remove format constraint of client id" 2018-07-13 08:03:08 +00:00
Zuul 611147f4bc Merge "Remove pool group from zaqar for api-ref" 2018-07-11 06:00:14 +00:00
gengchc2 93bd4fed93 Remove pool group from zaqar for api-ref
Co-Authored-By: wanghao<sxmatch1986@gmail.com>
Change-Id: I81c0cc322e89260cb8803de9f3c0afb58ed75532
Implement: blueprint remove-pool-group-from-zaqar
2018-07-09 13:55:43 +08:00
wanghao fff82e7a11 Remove format constraint of client id
Since some clients use different format of client id not only uuid,
so Zaqar will support this function.

Add one option 'client_id_uuid_safe' to allow user to control
the validation of client id.

Add two options 'min_length_client_id' and 'max_length_client_id'
to allow user to control the length of client id if not using uuid.

This also requires user to ensure the client id is immutable.

Implements: blueprint remove-format-constraint-of-client-id
Change-Id: I96bc2620b09394419b66a733484ff3d8f0d56313
2018-06-23 10:50:36 +08:00
Zuul 9399962a2f Merge "Update docs to properly describe delete with pop" 2018-05-08 10:42:15 +00:00
Zuul 714ad91005 Merge "Move openstackdocstheme to extensions in api-ref" 2018-05-08 10:42:14 +00:00
Jude Cross 941bd74be7 Update docs to properly describe delete with pop
This patch updates the documentation for the Zaqar API to properly
describe when a delete is invoked with the pop query parameter.

Change-Id: Id586797eb4707f5db9d751c80035ba07270627c3
Closes-Bug: 1768157
2018-05-03 10:59:15 -07:00
Zuul 1f774925c1 Merge "Use rest_status_code for api-ref response codes" 2018-04-20 05:21:46 +00:00
wanghui eef0eac428 Move openstackdocstheme to extensions in api-ref
Move openstackdocstheme to extensions. According to the guide below:
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I7c23cc33007316c3316b3307f5f0500b244ca035
2018-04-20 10:15:13 +08:00
wanghao b4c395c79a Support query filter in queue.
This patch will support to query queues filtered by
name and metadata in mongodb backend.

Other backends will support in following patchs.

Co-Authored-By: gecong <ge.cong@zte.com.cn>
Change-Id: I5fc6a5959e5d94942aebce9cedb22666e5577cb8
Partial-implements: blueprint queue-filter-support
2018-04-13 14:53:43 +08:00
Zuul d4e7491a3a Merge "Remove the deprecated "giturl" option" 2018-03-28 09:02:33 +00:00
liuyamin 8d54d2c2b6 Use rest_status_code for api-ref response codes
Rather than our freeform way of listing response codes in our
api-ref, we should be using the os-api-ref extension option to
get nicely formatted response code listings.

https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code

Change-Id: I70b5f0c20089d0eaa201ab9d9bbf9ec1464ec636
2018-03-23 17:50:24 +08:00
wanghao 83300343d2 Add reserved metadatas for dead letter queue
We support dead letter queue in Queens. There
are some new reserved metadatas which should be
returned.

Change-Id: Iba5add5b75fa67e025ec89a887db0d04fb61548a
2018-03-15 16:56:24 +08:00
yangzhenyu f605dd9bae The doc of bp support-md5-of-body
blueprint: support-md5-of-body
Change-Id: I7238971df284f5cd146e3013092b353649cffc6f
2018-02-08 01:01:57 +00:00
gaofei 3d99504e27 Replace curly quotes with straight quotes
Curly quotes usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I7224650e2a52e813077bb84ad3ceddb9d87f934e
2018-01-25 03:42:31 +00:00
zhang.lei c465441405 Remove the deprecated "giturl" option
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.

[1] https://review.openstack.org/532163

Change-Id: Ifd6b12d021dbcb8c025a3c1ed66e57b091edd61d
2018-01-15 03:22:46 +00:00
yangzhenyu 31a08e348a Modify delay queue api-doc description
Add the ``reserved attributes`` description for the
parameters``_default_message_delay``.

Change-Id: If440e284e1e5175b7d0f8d0f912a983c20547d43
2018-01-05 12:07:06 +08:00
yangzhenyu 949d496263 Doc of delayed queues
Tempest plugin
Depends-On: I0a15600a836f609e4b992f8a80ba887e312aa780

Implement blueprint delayed-queues
Change-Id: Iea7a68be8b20f3eb20ed035c33243cc843a22365
2017-12-19 01:52:50 +00:00
wangxiyuan 210976fbae Update message api-ref
The message get_all and delete_all api-ref is a litte misleading.
Update it to be more clear.

Change-Id: I7e94bc89bc41ad85199f5664ee92ce001a4835fe
2017-10-16 14:35:13 +08:00
wanghao a986ef0bdf [api-ref]Change 'queues' to required in response body
In api doc, when getting the queues list,
the 'queues' in response body is optional,
but it should be required even if there is empty list.

Change-Id: I1503ec3828b2107df9488ec48164b502a2244e4d
Closes-Bug: #1710583
2017-09-01 10:43:11 +08:00
wanghao 159f89ad38 Fix api doc in creating pre-signed url
Now the three arguments 'paths', 'methods', 'expires' in body
are all optional, but it's required in api-ref doc.

So fix it soon.

Change-Id: I61dad6daa2d030a8ae14acaf1f9bed43cf0be060
2017-07-31 17:17:08 +08:00
Jenkins 9b966b4912 Merge "Support dead letter queue for MongoDB" 2017-07-21 02:11:31 +00:00
e 35661d4a1f Trivial Fix in api-ref
Change-Id: I0dcc74459769025da824dab17c5774078b9a4768
2017-07-18 15:42:39 +08:00
Fei Long Wang 7fdb41fab7 Support dead letter queue for MongoDB
Implement blueprint dead-letter-queue

Change-Id: Idf5d80c4d135fa7c7f0f3ec1c14f6a68f5abb88f
2017-07-17 01:44:04 +00:00
Vu Cong Tuan 7930f511f0 Fix html_last_updated_fmt for Python3
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I502588bf0ce1fff0be34e9b21ef55be95d2d7bc1
Closes-Bug:#1693670
2017-07-04 18:38:31 +07:00
Jenkins 488c137671 Merge "API Ref bug about the mailto protocol" 2017-06-14 00:38:00 +00:00
yangzhenyu 2cf1cd7bba API Ref bug about the mailto protocol
Actually, the correct usage of mailto protocol should be
mailto:youremail@example.com instead of mailto://youremail@example.com

Closes-Bug:#1697449

Change-Id: I24135c4c6d6f6a8a15da4a33e38e1a518bddee50
2017-06-13 14:00:17 +08:00
zengjianfang 980ea37e61 modify doc of Claim messages
This patch modify the API link of Claim messages and add normal response codes 204.

Change-Id: I4acf8b12c440f2da1c8cbe0588cabf27274ba2ee
2017-06-13 10:03:25 +08:00
wanghao b0f96b2a28 Fix detailed missing in api-ref
Variable 'detailed' in query is missing now in api-ref.
Quick fix it.

Change-Id: Iad6d50824742431857dbfab4a5b4729de9f8ff18
2017-04-07 08:42:18 +08:00
Andreas Jaeger b027aa0a77 Fix api-ref building
The current os-api-ref and Sphinx packages warn about a couple of
problems. Fix them all:
* wrong order of entries in parameters.yaml
* missing parameter
* too short underline

Also, treat warnings as errors for Sphinx to avoid regressions.

Change-Id: Id129cc709df38385a8cfe6dc12ffca6d4ba4857e
2017-03-04 18:58:42 +01:00
Cao Xuan Hoang 53f0c9f8fe Removes unnecessary utf-8 encoding
The following file(s) added utf-8 encoding but never used. So we can
remove them at all.

zaqar/tests/tempest_plugin/tests/v2/test_claims_negative.py
zaqar/tests/tempest_plugin/tests/v2/test_queues_negative.py
api-ref/source/conf.py
doc/source/conf.py
releasenotes/source/conf.py

Change-Id: I4a7b138f72ef61787636efcca9ef319d527be72c
2017-01-04 09:43:53 +07:00
wanghao b41802c3ad 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
2016-12-22 09:56:55 +08:00
Jenkins cd3adce177 Merge "Add some descriptions for resources in API Ref" 2016-11-16 19:53:04 +00:00
ZhaoBo 308934a1ba Fix an typo in flavors.inc
This patch fix the typo issue.

Change-Id: I81c9fb9fa841f3f180f27e20268ab0f52983c7d4
2016-11-16 14:20:39 +08:00
wanghao 160f958ae3 Reword description of grace
Now Zaqar uses "claim expiration time > current message TTL"
to judge whether to extend message ttl or not.
The explanation of grace "If a claimed message would normally
live longer than the grace period, its expiration is not adjusted."
is not very clear to users.

So we reword the description of grace to "If a claimed message
would normally live longer than the claim's live period,
its expiration is not adjusted."

Change-Id: Ib9b042e99116fb4c4656696d413a778e4f07f4c6
Closes-Bug: #1632629
2016-11-08 22:43:01 +00:00
Fei Long Wang 1032436455 Add some descriptions for resources in API Ref
Change-Id: I9cebddf6ad435b4238190c39abff174a1b184594
2016-11-07 16:16:28 +13:00
Nguyen Phuong An f31a6e2b7a [api-ref] Remove temporary block in conf.py
The os-api-ref 1.0.0 is out. We can remove the support to older version now.
Reference:
6d41feb58d

Change-Id: I1946a4c3cf51001b3c759008ce9c7da2ab646ee4
2016-09-07 07:29:34 +00:00
Nguyen Phuong An 4bae6c70f3 Config logABug feature for zaqar api-ref
Currently, zaqar api-ref is not configured with logABug feature.
When users click "Report bug" button, it leads to "openstack-manuals"
which is default.

Change-Id: I94c15bb27ca3f920ba4f1a9622222ca891e1e663
2016-08-31 13:25:37 +07:00
Jenkins 5e38c85d5e Merge "Get ready for os-api-ref sphinx theme change" 2016-08-24 19:39:18 +00:00
Graham Hayes 6ff9be91e3 Get ready for os-api-ref sphinx theme change
Change-Id: Ia4aa6962a43d343b6c19f9fd111f7573336b688c
2016-08-19 16:45:08 +01:00
yanyanhu 96aae7cca8 Fix a minor error in API reference
Based on test result, response body of claim messages API
includes a top level key "messages" whose vlaue is a list of
messages being successfully claimed. This patch revises
corresponding sample in API reference.

Change-Id: I72b7b7a59e9c54c398448e474d2d13f77454e29c
2016-08-16 04:21:25 -04:00
yanyanhu c7fa05694f Fix errors in API reference for message resource
Request and response examples for posting messages are not
cited correctly in API reference. This patch fixes it.

Change-Id: Id7c12b5e63e4cc4936e10e0380c7fed6ff94b032
2016-07-29 05:02:52 -04:00