36 Commits

Author SHA1 Message Date
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
Jenkins
1d0c95e0e2 Merge "Add flavors api ref" 2016-07-28 23:10:39 +00:00
wanghao
8bdc2156bb Add flavors api ref
Co-Authored-By: wangxiyuan<wangxiyuan@huawei.com>

Change-Id: I1fe0b2b6a1f80c56df5d7cc641be17c956555581
2016-07-27 11:34:14 +08:00
Fei Long Wang
930a075f96 Support messages API ref
Co-Authored-By: Kevin_Zheng <zhengzhenyu@huawei.com>
Co-Authored-By: Fei Long Wang <flwang@catalyst.net.nz>

Change-Id: If3fcb6594bc81736474875d5e1db0b465c6d750e
2016-07-27 12:09:18 +12:00
AvnishPal
28cc17109b This patch removes extra spaces from files.
Closes-Bug: #1603318

Change-Id: I55d47bfb0408d4a8bb59dcc70afd47a3c47ad9b1
2016-07-15 15:15:40 +05:30
wanghao
fabc0b1bd7 Add pools api ref
Change-Id: Ib66eef4af791fd854966c7d99067c84541661b6c
2016-07-07 10:23:02 +08:00
Fei Long Wang
18fc577923 Add `Pre-signed queue' api ref
Change-Id: I7a7dfc3a30f3c9d754410fa96ec94b86f1b92ffa
2016-07-06 18:53:19 +12:00
Fei Long Wang
ef0f8bac66 Add Health api ref
Change-Id: I796530b3481d131be23a759d23415149815d3179
2016-06-26 07:12:16 +12:00
wangxiyuan
65bf61df13 Add subscription api ref
Change-Id: Ib902f0ce0c2478ba616a7d3a6b72d3944ff115bb
2016-06-24 09:53:43 +08:00
Fei Long Wang
721925c921 Add Claims for api ref
Change-Id: Id9ac39f69b3e042f61ee9ae6d2abbca36c7a4e34
2016-06-23 05:45:26 +12:00
Fei Long Wang
9a3b0191af Add Queues for api ref
Change-Id: I45566944491d0ddf6d43ad60c3f97d3d7f5aa057
2016-06-15 14:50:41 +12:00
Fei Long Wang
da4009d8ad Init commit to add API ref in tree
This patches adds the basic architecture to adopt api ref in tree
and a new tox command to build api ref for testing.

A new api ref gate job will be added to verify the format which
will be tracked by another commit against project-config.

blueprint: api-ref-in-tree

Change-Id: Idffbdc9325868a3dcd6a9bd7f90f030fd52ee0dc
2016-05-30 15:40:10 +12:00