This admin API is only called externally by Nova at present when
finishing the migration or retype of an attached volume. However for
future reference it would be really useful to have this listed in the
official API reference guide.
Change-Id: I5fad6eb4903784870aa26fa0996a391bbbbb9276
https://developer.openstack.org/api-ref/block-storage/v3/index.html#list-snapshots-and-details
1. updated_at is missing in the response fields of show-snapshot
and list-snapshots
2. id's description is "The UUID of the volume transfer.", which
is incorrect.
3. volume_id's description is "The UUID of the volume.", which is
not very accurate.
4. os-extended-snapshot-attributes:progress is something like '100%',
so it should be string, not integer
5. response fields of show-snapshot-metadata is incorrect.
6. metadata is missing in the response example of update-snapshot
7. snapshots_links is missing in the response of list-snapshot
Change-Id: I0f6994c2d2dc27d3d594acdd460e27c338f86a2c
Adds the v2 and v3 API reference documentation for the
admin-only (by default) os-migrate_volume volume action
API. The only major difference with the v3 API is the
cluster parameter introduced in the 3.16 microversion.
Change-Id: I70f6b2cc4d25ea155ce09ddeec26b995890a2db3
Partial-Bug: #1607539
'os-volume-replication:extended_status' and
'os-volume-replication:driver_date' are unavailable
since the merge of patch [1] during Liberty, remove these
from API document.
[1]: https://review.openstack.org/#/c/275797/
Change-Id: Ib319702f085930a6bf528ef95fb17a7da8451e96
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 and its
sample response.
Change-Id: I547dca649db22b31051b490c2b230322d3c9d479
Reset a snapshot's status API Request Example was syntax error with comma, so
remove comma to syntax correct.
Change-Id: I8b2c249aaf0f9729bc35b80ecd6cd28bb34835c0
Close-bug: #1720487
In the sample json files, some examples of the provider value were
wrong and showed a key manager class instead of an encryptor name.
Other samples showed the legacy encryptor classes where the newer
os-brick encryptor shorthand names should be used instead.
I3eec91e221692177833909e0378116cea4966807 removes support for the
legacy provider class names, so it is important that the samples
reflect the updated shorthand names.
Change-Id: I1c3879a5d12a8c9802deeac1c6e24b57310588d5
The v1 API has been deprecated for many releases now. We have not
been able to remove it due to SDKs and tooling being slow to
update. This is the latest attempt to see if it has been long
enough.
Change-Id: I03bf2db5bd7e2fdfb4f6032758ccaf2b348a82ba
This commit adds the api documentation for the
GET/PUT os-quota-class-set APIs (v2 and v3).
Change-Id: Idb51b7b90a081775d2d836bf6d9ec8b9c0399f1b
Closes-Bug: #1602400
The 'os-show_image_metadata' API is outdated.
Rewrite the document, also correct the response
codes for image metadata's create/delete APIs.
Change-Id: I50a5b3571973564b8b5010b412d94303866e8dcd
In v2 sample path, there are redundant files version-v2-show-response.json,
in v3 sample path, there are redundant files version-v2-show-response.json
and version-v3-show-response.json, This patch is to remove the redundant
JSON file and reorganize volumes versions of v2 and v3
Change-Id: I3d9337cc94ad02138459742a7b84fe97bd09bb90
There is no document about v2/v3 backup 'os-reset_status' action. This
action explicitly updates the backup state. So add the missing content.
Change-Id: Ie0dd2b4e184d09e957c4ba296544f5019d05fda3
Partial-Bug: #1607539
There is no document about update a volume's bootable status,
so add the missing doc.
Change-Id: If706205678cfd7a803e2d7733bec34494b47fc66
Partial-Bug: #1607539
There is no API doc found for force-delete volume in cinder.
We need to add the API doc for the operation with its description,
request and response parameters.
Change-Id: Id25b4070a3946d2d7d89f44bdc81039286a5d8fe
Closes-bug: #1673644
Added volume type encryption sections to volumes v2 types and
added related parameters to parameters file.
Appropriate sample files added.
Had to add for v2 to several headings to pass tox/gates
Change-Id: I7a35551c4ebd345ce2d6c42217015b29c324d96c
Closes-Bug: #1679736
Volume/Snapshot contains two kinds API for it's metadata: POST/PUT
POST is used for creatng or replacing the volume/snapshot's
metadata items that match keys. It doesn't modify items that
are not in the request.
PUT is used for replacing all the volume/snapshot's metadata
with the key-value pairs in the request.
Cinder's api-ref description is wrong. This patch fixed the
description and added the missing POST/PUT request.
Change-Id: I51128d32c9f70ba57d7d4cf0634a16ca566db95f
Since the commit If98db25f1f4032725444c3959acb9aad8f869802 XML
support has been removed from Cinder API. And the version API
doesn't return XML entity on media-types.
Then this patch removes the entity from sample files.
Change-Id: I782d5cf7a152647254d9a36edcc7352000139dc3
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
We have already removed xml support from cinder code
in previous release.
As per previous discussions, xml references are required
to eliminate to sync code and api-ref.
Implements : blueprint eliminate-xml-references
Change-Id: I0cb7da56306e29cff8385c784bfc3f49cd9cfddd
'replication_targets' is always returned in Response of GET/v2/
{tenant_id}/capabilities/{hostname} API, but it is not written
in either Response parameters table or JSON example.
'display_name' is listed in JSON example but not described in
Response parameter table.
This patch adds the above two missing information.
Change-Id: Ib3bf54df7c5c400cfec64dd9c7df136c87cd6376
Closes-Bug: #1603306
user_id, project_id and status were listed as request parameters when
they are actually response parameters.
Change-Id: I5ff464c6aae853929b2b10ba62898913977016b0
Closes-Bug: 1603177
Currently, the API reference is showing a blank sample response
for the v2 "List API Versions" call [1]. That appears to be because
the sample file it includes is "versions-resp.json" which exists, but
is 0 bytes (completely empty). There is also a
"versions-response.json" file present in the samples directory, which
appears to contain a valid JSON reply.
This patch fixes the problem by removing the 0-byte sample file and
pointing to the correct one.
[1]
http://developer.openstack.org/api-ref/block-storage/v2/#list-api-versions
Change-Id: If2c1b486229681f68ba4ab0c13307de4599d9b72
Closes-Bug: #1623744
