most places use description of backup, such as groups,
consistency groups, snapshots .etc, this is incorrect
this patch is to correct them.
Change-Id: I079f0351c93b5f19e87a42b4b0b84ff086b83820
Some request details provided information about the other
JSON value while others didn't. To make things consistent
and to make sure API consumers understand how the requests
need to be structured, this adds missing instances. It also
reorders some parameter lists to be a little more logical,
so even though we can't show the nested nature of some of
these, it at least doesn't show inner values before outer
ones.
This also corrects many errors seen while going through
the API ref. This is by no means exhaustive, and is already
somewhat out of the scope for this patch, so it is expected
that there are some (many) cases that are not addressed by
this patch. Those will be fixed with ongoing effort in
future patches.
Partial-bug: #1713517
Change-Id: I30964ba8d829778fd01174d639d44ba07e4b77a6
Add "display_name" and "replication_targets" to the response parameters
in the api-ref of getting capabilities.
Change-Id: Id1776641ea9938d024906707fec2e21404668ff7
Closes-bug: #1674237
Modifies heading levels in .inc files to allow nested display in
table of contents. Table of contents depth has been changed to allow
this.
Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
Keystone API v2 was deprecated in Mitaka and uses "project"
instead of "tenant" in V3 now.
This patch change the "tenant" to "project" in Cinder API v3 doc.
Change-Id: I06d400f3e38d78014e9eae89b29b075adaecffe4
Our Api-ref CI job failed due to the change[1] in os-api-ref.
This patch fixed the issue.
[1]: I8686006339b82ed5465dd8e4d3a8b15f85ee897c
Change-Id: I00458bef8729e9ff877b4e38563f5d133de47cf5
Current capabilities api-ref explains that the API takes
{hostname}, but this is not accurate.
Actually this api takes hostname@volume_backend_name format.
To avoid confusion, this explanation should be updated.
Change-Id: I0d9e9925a1b011f49cefc9867f617e8b51ec7437
The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref
was ever created. This is problematic for end users and would hinder
the v3 API from being included in DefCore Interoperability Guidelines
somewhere down the line (since one of DefCore's Criteria[1] is that a
Capability be well documented). This patch creates an API ref for v3.
It also adds a header to the v2 index to show that it is SUPPORTED,
whereas v3 is CURRENT.
[1]
http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77
Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e
Closes-Bug: #1616072
