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: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
We have implemented quota-classes-show and quota-classes-update
api, but no api-ref is documented. This patch is to add api-ref
in the docs.
Change-Id: I275ee4fe048607a49368c4f985c055ab3a3bbfb6
Closes-bug: #1751683
When use version details api http://ip:8786/v2 to get api details,
it does not return 200 OK, and the return value is empty.
This change is to correct the version details API URL.
Change-Id: I1cde2a35dc84ccaac15d6963f453fd793c54fda4
Closes-Bug: #1742336
Added support for display count info
in share list and detail APIs Doc.
Depends-On: I12c41a46140b04f26565d8934e0326480477c612
Partially-Implements bp add-amount-info-in-list-api
Change-Id: I25c41a46190b04f26565d8934e0326480477c613
Add attr 'description' in list/create share
type API Doc.
Depends-On: I39705acbfca812b66d74fbd2fee228a7a85bc2d8
Change-Id: I49705acbfca812b66d74fbd2fee228a7a85bc2d7
Partial-Bug: #1724183
Things like following is in api-ref, need to be correct.
1. use share_id and remove share_id_4
2. export_location_id_path param is required
3. security_service_id is required not optional
This patch is to fix these.
Change-Id: Ic811095b85a0460d3c6bedc9526d8ed64248de4c
Closes-bug: #1719543
* Change description parameter 'required' attr value
from true to false.
* Add neutron_net_id and neutron_subnet_id in share
network update API request parameter.
Closes-bug: #1727145
Change-Id: Iedde7a2a674a60e760b47d5eb2973f42d79223d1
Separate add share group description in other API or CLI echo in
this patch from add share group itself description in other patches:
Added share group iteslf in api-ref [1]
Added share api admin doc [2]
Added share group in driver requirements [3]
[1] I852d264eb120027aad32997dc64a6ca428ee55a4
[2] Ia0cc534e0bfb2ca5e495e575237e9911c746691b
[3] Iedde5a9a774a60e760b47d5eb2973f42d79227d4
Change-Id: Iedde5a9a774a60e760b47d5eb2973f42d79127d3
Since consistency group APIs were removed in 2.31 API version.
Now we delete consistency group description in docs.
Change-Id: I6499ae6c98d9489a257bb20febd6c1ddb9e17b12
In the parameters.yaml file, the description of tenant_id_path is the
same as tenant_id_1, so delete the parameter tenant_id_1.
Change-Id: If4f738f6e32823f196b8ffe224bda3945ab97717
1. remove duplicate html_last_updated_fmt in doc/source/conf.py
the second one cause the new added one not take effect.
2. update html_last_updated_fmt in api-ref/source/conf.py
use the recommended '%Y-%m-%d %H:%M' data time format.
Change-Id: Ib37b8a05c88667b34438186c55b6eb3f64b64960
In api-ref/source/snapshot.inc, when update a snapshot, we can only update
its "display_name" and "display_description", is_public can not be updated,
So this change is to remove "is_public" in update snapshot description.
Change-Id: I02109fc032df4bbf8ef487a567c7dd8d1d9c66ce
Closes-bug: #1710523
Now that the "MAPRFS" has been supported by manila driver,
but this is missing in share.inc docs, this change is to add
it.
Change-Id: If2bd03786738469bb2e98683719a3bb164c181ae
