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
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
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
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
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
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
Now Zaqar has supported to qurge queue,
add api ref for it.
Partially Implements: blueprint purge-queue
Change-Id: If9f4f5aec92bf8c4bd5e9e0f0ca833bc8214b121
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
The os-api-ref 1.0.0 is out. We can remove the support to older version now.
Reference:
6d41feb58d
Change-Id: I1946a4c3cf51001b3c759008ce9c7da2ab646ee4
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
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
Request and response examples for posting messages are not
cited correctly in API reference. This patch fixes it.
Change-Id: Id7c12b5e63e4cc4936e10e0380c7fed6ff94b032
Co-Authored-By: Kevin_Zheng <zhengzhenyu@huawei.com>
Co-Authored-By: Fei Long Wang <flwang@catalyst.net.nz>
Change-Id: If3fcb6594bc81736474875d5e1db0b465c6d750e
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
