The status 'error_deleting' and 'deleted' doesn't exist in the doc.
Also the status error_restoring is a state of the volume, not backup.
This patch is to add and remove the respective statuses in the doc.
Change-Id: I96cd3d6fba38206a0a2b6c325092903b760b4ed4
The description for the backups API in both the v2 and v3
reference had a generic statement that only available volumes
can be backed up and restored, which is misleading since it
is possible to backup an in-use volume if the force parameter
is used.
This change drops the generic statement from the high-level
description and opts for per-API descriptions about the status
preconditions for backup and restore operations.
The v3 restore reference already mentioned the status precondition
so the only change to that is fixing the bullet list formatting.
Change-Id: Ib6c61af9ced2527884569fa15a848a215dd985b8
Closes-Bug: #1799499
We had a few instances where the title level used for calls in the
api-ref was wrong, resulting in the api call being hidden inside the
details of another title level.
This fixes title levels to be consistent and adds a missing inclusion to
the v2 index.
Closes-bug: #1787203
Change-Id: I602250117dbf52f9e031e945040b45f089d8602e
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Using the wrong character resulted in the wrong title level
being used for the response codes, which in turn caused the
"detail" show/hide toggle to not be able to hide all of the
per-endpoint details. This corrects these to be at the correct
level.
Also ran into issues after changing them where sphinx was not
happy with the random title levels. This appears to be due to
the order processed and whether not earlier included files had
all subsequent levels. Adding an additional title in our first
included file resolved that problem.
Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03
Closes-bug: #1755566
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: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
Cinder REST API allows one to use a special query parameter
named "all_tenants" to list resources from all projects (tenants)
through the REST API:
`/v3/{project_id}/volumes/detail?all_tenants=1`
However, this option is hardly documented anywhere besides
`/v3/{project_id}/volumes/summary`. So add them.
Change-Id: Ia9cc9e20c3b333a054c90f07e952b61dfad8529e
Closes-Bug: #1743800
We had a mix of formatting for our API response codes. This
makes it so all have a leading space, no trailing comma, and
no empty Error response labels.
This also addresses a formatting issue with due to the spacing
between the Normal and Error lines that was causing the two to
run together in the formatted HTML, making it harder to read.
Change-Id: Ic411ee9f671c48ce60bda21984dafe55135685ba
During the migration to in-tree api-ref docs we somehow lost the details
for backup export_record and import_record. Adding back in.
Also fixing up a few records that referred to the wrong parameter record
names, resulting in their descriptions referring to volume transfer for
backup operations.
Change-Id: I6fc555729c1b8404887d41424831fc48934f1491
Closes-bug: #1628812
Closes-bug: #1712923
In the api-ref/source/v2 and api-ref/source/v3, Add response
example for some of volumes, backups, consistencygroups doc.
Change-Id: I2d89df3cf6f691d6cde2429b1b33b5b16af3269c
Add "snapshot_id" and "data_timestamp" and "volume_name" to
the response parameters and error response code in the api-ref of
ext-backups.inc.
Change-Id: I2e3a6c737a74816e5e56b5a435a73e0bf501bec8
Closes-bug: #1676693
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
In the api ref most of our references to the status parameter are wrong,
since they are all referencing `status`, which in most cases is:
status:
description: |
The ``status`` of the consistency group snapshot.
This patch fixes this by referencing the right status parameter.
TrivialFix
Change-Id: I3f76ad10bacd8c75f742efc3ff3395a7effc31b5
Current doc states "Error repsonse codes:204". This should actually
by "Normal response code" and be 202 (Accepted) vs 204 (No Content).
Change-Id: I6e3855b2d1280de3e0fe6b5638feb54e9dfa4c10
Closes-bug: #1598237
