openstack/cinder
Code Issues Proposed changes

Improve/Clean api-ref parameters

Browse Source 
The parameters with name like example_1, example_2 ... etc. cause
confusion while updating the api-ref docs like the examples below:

https://review.openstack.org/#/c/609639/
https://review.openstack.org/#/c/609611/

This patch does the following changes :
1) Replace numbering in the parameter with relevant names
2) Clean up unused parameters

Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
This commit is contained in:
whoami-rajat 2018-10-30 11:03:09 +05:30
parent 75e4f1e0f3
commit 609412fcd2
29 changed files with 710 additions and 910 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
api-ref/source/v3/attachments.inc
View File

@ -62,7 +62,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- attachment_id: attachment_id_1 - attachment_id: attachment_id_path
Show attachment details Show attachment details
@ -93,7 +93,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- attachment_id: attachment_id_1 - attachment_id: attachment_id_path
Response Parameters Response Parameters
@ -101,14 +101,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_9 - status: status_attachment
- detached_at: detached_at - detached_at: detached_at
- connection_info: connection_info - connection_info: connection_info
- attached_at: attached_at - attached_at: attached_at
- attach_mode: attach_mode - attach_mode: attach_mode_required
- instance: instance_uuid_1 - instance: instance_uuid_req
- volume_id: volume_id_7 - volume_id: volume_id_attachment
- id: attachment_id_2 - id: attachment_id_required
Response Example Response Example
---------------- ----------------
@ -156,14 +156,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_9 - status: status_attachment
- detached_at: detached_at - detached_at: detached_at
- connection_info: connection_info - connection_info: connection_info
- attached_at: attached_at - attached_at: attached_at
- attach_mode: attach_mode - attach_mode: attach_mode_required
- instance: instance_uuid_1 - instance: instance_uuid_req
- volume_id: volume_id_7 - volume_id: volume_id_attachment
- id: attachment_id_2 - id: attachment_id_required
Response Example Response Example
---------------- ----------------
@ -211,10 +211,10 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_9 - status: status_attachment
- instance: instance_uuid_1 - instance: instance_uuid_req
- volume_id: volume_id_7 - volume_id: volume_id_attachment
- id: attachment_id_2 - id: attachment_id_required
Response Example Response Example
@ -253,10 +253,10 @@ Request
- project_id: project_id_path - project_id: project_id_path
- attachment: attachment - attachment: attachment
- instance_uuid: instance_uuid_1 - instance_uuid: instance_uuid_req
- connector: connector - connector: connector
- volume_uuid: volume_id_7 - volume_uuid: volume_id_attachment
- mode: attach_mode_1 - mode: attach_mode
Request Example Request Example
--------------- ---------------
@ -270,14 +270,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- attachment: attachment - attachment: attachment
- status: status_9 - status: status_attachment
- detached_at: detached_at - detached_at: detached_at
- connection_info: connection_info - connection_info: connection_info
- attached_at: attached_at - attached_at: attached_at
- attach_mode: attach_mode - attach_mode: attach_mode_required
- instance: instance_uuid_1 - instance: instance_uuid_req
- volume_id: volume_id_7 - volume_id: volume_id_attachment
- id: attachment_id_2 - id: attachment_id_required
Response Example Response Example
---------------- ----------------
@ -314,9 +314,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- attachment_id: attachment_id_1 - attachment_id: attachment_id_path
- attachement: attachment - attachement: attachment
- connector: connector_1 - connector: connector_required
Request Example Request Example
--------------- ---------------
@ -330,14 +330,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- attachment: attachment - attachment: attachment
- status: status_9 - status: status_attachment
- detached_at: detached_at - detached_at: detached_at
- connection_info: connection_info - connection_info: connection_info
- attached_at: attached_at - attached_at: attached_at
- attach_mode: attach_mode - attach_mode: attach_mode_required
- instance: instance_uuid_1 - instance: instance_uuid_req
- volume_id: volume_id_7 - volume_id: volume_id_attachment
- id: attachment_id_2 - id: attachment_id_required
Response Example Response Example
---------------- ----------------
@ -374,7 +374,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- attachment_id: attachment_id_1 - attachment_id: attachment_id_path
Request Example Request Example
--------------- ---------------

4
api-ref/source/v3/capabilities-v3.inc
View File

@ -35,9 +35,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- pool_name: pool_name - pool_name: pool_name
- description: description_10 - description: description_cap
- volume_backend_name: volume_backend_name - volume_backend_name: volume_backend_name
- namespace: namespace_1 - namespace: namespace_storage
- visibility: visibility - visibility: visibility
- driver_version: driver_version - driver_version: driver_version
- vendor_name: vendor_name - vendor_name: vendor_name

34
api-ref/source/v3/consistencygroups-v3.inc
View File

@ -80,10 +80,10 @@ Request
- project_id: project_id_path - project_id: project_id_path
- consistencygroup: consistencygroup - consistencygroup: consistencygroup
- description: description_11 - description: description_consis
- availability_zone: availability_zone - availability_zone: availability_zone
- volume_types: volume_types_2 - volume_types: volume_types_commas
- name: name_15 - name: name_consis
Request Example Request Example
--------------- ---------------
@ -97,13 +97,13 @@ Response
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- consistencygroup: consistencygroup - consistencygroup: consistencygroup
- status: status_1 - status: status_consis
- description: description_6 - description: description_cg
- availability_zone: availability_zone - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- volume_types: volume_types - volume_types: volume_types
- name: name_15 - name: name_consis
- id: consistencygroup_id_1 - id: consistencygroup_id
Response Example Response Example
---------------- ----------------
@ -131,15 +131,15 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- consistencygroup_id: consistencygroup_id_2 - consistencygroup_id: consistencygroup_id_path
Response Parameters Response Parameters
------------------- -------------------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_1 - status: status_consis
- description: description_6 - description: description_cg
- availability_zone: availability_zone - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- volume_types: volume_types - volume_types: volume_types
@ -176,9 +176,9 @@ Request
- project_id: project_id_path - project_id: project_id_path
- consistencygroup-from-src: consistencygroup-from-src - consistencygroup-from-src: consistencygroup-from-src
- status: status_1 - status: status_consis
- user_id: user_id - user_id: user_id
- description: description_11 - description: description_consis
- cgsnapshot_id: cgsnapshot_id - cgsnapshot_id: cgsnapshot_id
- source_cgid: source_cgid - source_cgid: source_cgid
- project_id: project_id - project_id: project_id
@ -212,7 +212,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- consistencygroup_id: consistencygroup_id_2 - consistencygroup_id: consistencygroup_id_path
- consistencygroup: consistencygroup - consistencygroup: consistencygroup
- force: force - force: force
@ -257,8 +257,8 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- consistencygroups: consistencygroups - consistencygroups: consistencygroups
- status: status_1 - status: status_consis
- description: description_6 - description: description_cg
- availability_zone: availability_zone - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- volume_types: volume_types - volume_types: volume_types
@ -294,10 +294,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- consistencygroup_id: consistencygroup_id_2 - consistencygroup_id: consistencygroup_id_path
- consistencygroup: consistencygroup - consistencygroup: consistencygroup
- remove_volumes: remove_volumes - remove_volumes: remove_volumes
- description: description_11 - description: description_consis
- add_volumes: add_volumes - add_volumes: add_volumes
- name: name - name: name

6
api-ref/source/v3/ext-backups-actions-v3.inc
View File

@ -37,7 +37,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id_required
- os-force_delete: os-force_delete - os-force_delete: os-force_delete
Request Example Request Example
@ -75,9 +75,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id_required
- os-reset_status: os-reset_status - os-reset_status: os-reset_status
- status: status_10 - status: status_backup_action
Request Example Request Example
--------------- ---------------

74
api-ref/source/v3/ext-backups.inc
View File

@ -77,26 +77,26 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- backups: backups - backups: backups
- status: status_4 - status: status_backup
- object_count: object_count - object_count: object_count
- fail_reason: fail_reason - fail_reason: fail_reason
- description: description - description: description
- links: links_1 - links: links_backup
- availability_zone: availability_zone - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- updated_at: updated_at - updated_at: updated_at
- name: name_1 - name: name_backup
- has_dependent_backups: has_dependent_backups - has_dependent_backups: has_dependent_backups
- volume_id: volume_id - volume_id: volume_id
- container: container - container: container
- size: size - size: size
- id: id_1 - id: id_backup
- is_incremental: is_incremental - is_incremental: is_incremental
- data_timestamp: data_timestamp - data_timestamp: data_timestamp
- snapshot_id: snapshot_id_2 - snapshot_id: snapshot_id_source_vol
- os-backup-project-attr:project_id: os-backup-project-attr:project_id - os-backup-project-attr:project_id: os-backup-project-attr:project_id
- count: count - count: count
- metadata: metadata_9 - metadata: metadata_backup
Response Example Response Example
---------------- ----------------
@ -126,7 +126,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id_required
Response Parameters Response Parameters
@ -135,26 +135,26 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- backup: backup - backup: backup
- status: status_4 - status: status_backup
- object_count: object_count - object_count: object_count
- container: container - container: container
- description: description - description: description
- links: links_1 - links: links_backup
- availability_zone: availability_zone - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- updated_at: updated_at - updated_at: updated_at
- name: name_1 - name: name_backup
- has_dependent_backups: has_dependent_backups - has_dependent_backups: has_dependent_backups
- volume_id: volume_id - volume_id: volume_id
- fail_reason: fail_reason - fail_reason: fail_reason
- size: size - size: size
- backup: backup - backup: backup
- id: id_1 - id: id_backup
- is_incremental: is_incremental - is_incremental: is_incremental
- data_timestamp: data_timestamp - data_timestamp: data_timestamp
- snapshot_id: snapshot_id_2 - snapshot_id: snapshot_id_source_vol
- os-backup-project-attr:project_id: os-backup-project-attr:project_id - os-backup-project-attr:project_id: os-backup-project-attr:project_id
- metadata: metadata_9 - metadata: metadata_backup
Response Example Response Example
---------------- ----------------
@ -187,7 +187,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id_required
Restore a backup Restore a backup
@ -229,10 +229,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id_required
- restore: restore - restore: restore
- name: volume_name_optional - name: volume_name_optional
- volume_id: volume_id_6 - volume_id: volume_id_restore
Request Example Request Example
--------------- ---------------
@ -246,7 +246,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- restore: restore - restore: restore
- backup_id: backup_id - backup_id: backup_id_required
- volume_id: volume_id - volume_id: volume_id
- volume_name: volume_name - volume_name: volume_name
@ -285,15 +285,15 @@ Request
- project_id: project_id_path - project_id: project_id_path
- backup: backup - backup: backup
- volume_id: volume_id_2 - volume_id: volume_id_backup
- container: container - container: container
- description: description - description: description
- incremental: incremental - incremental: incremental
- force: force - force: force
- name: name_optional - name: name_optional
- snapshot_id: snapshot_id_3 - snapshot_id: snapshot_id_backup
- metadata: metadata_9 - metadata: metadata_backup
- availability_zone: availability_zone_4 - availability_zone: availability_zone_backup
Request Example Request Example
--------------- ---------------
@ -307,9 +307,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- backup: backup - backup: backup
- id: id_1 - id: id_backup
- links: links_1 - links: links_backup
- name: name_1 - name: name_backup
Update a backup Update a backup
@ -336,11 +336,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id_required
- backup: backup - backup: backup
- description: description - description: description
- name: name_optional - name: name_optional
- metadata: metadata_9 - metadata: metadata_backup
Request Example Request Example
--------------- ---------------
@ -354,9 +354,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- backup: backup - backup: backup
- id: id_1 - id: id_backup
- links: links_1 - links: links_backup
- name: name_1 - name: name_backup
Response Example Response Example
---------------- ----------------
@ -403,9 +403,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- backups: backups - backups: backups
- id: id_1 - id: id_backup
- links: links_1 - links: links_backup
- name: name_1 - name: name_backup
- count: count - count: count
Response Example Response Example
@ -442,7 +442,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id_required
Response Parameters Response Parameters
@ -488,7 +488,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id_required
- backup-record: backup_record - backup-record: backup_record
- backup_service: backup_service - backup_service: backup_service
- backup_url: backup_url - backup_url: backup_url
@ -506,9 +506,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: id_1 - id: id_backup
- links: links_1 - links: links_backup
- name: name_1 - name: name_backup
Response Example Response Example
---------------- ----------------

8
api-ref/source/v3/group-replication.inc
View File

@ -34,7 +34,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id_path
Request Example Request Example
--------------- ---------------
@ -83,7 +83,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id_path
Request Example Request Example
--------------- ---------------
@ -116,7 +116,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id_path
Request Example Request Example
--------------- ---------------
@ -149,7 +149,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id_path
- allow_attached_volume: allow_attached_volume - allow_attached_volume: allow_attached_volume
- secondary_backend_id: backend_id_target - secondary_backend_id: backend_id_target

48
api-ref/source/v3/group-snapshots.inc
View File

@ -34,7 +34,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_snapshot_id: group_snapshot_id - group_snapshot_id: group_snapshot_id_path
Show group snapshot details Show group snapshot details
@ -64,7 +64,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_snapshot_id: group_snapshot_id - group_snapshot_id: group_snapshot_id_path
Response Parameters Response Parameters
@ -74,12 +74,12 @@ Response Parameters
- group_snapshot: group_snapshot - group_snapshot: group_snapshot
- created_at: created_at - created_at: created_at
- group_id: source_group_id - group_id: source_group_id_req
- id: group_snapshot_id_1 - id: group_snapshot_id_req
- name: name_19 - name: name_group_snap_req
- status: status_7 - status: status_group_snap
- description: description_16 - description: description_group_snap_req
- group_type_id: group_type_id_2 - group_type_id: group_type_id
Response Example Response Example
---------------- ----------------
@ -128,13 +128,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_snapshots: group_snapshots - group_snapshots: group_snapshots
- id: group_snapshot_id_1 - id: group_snapshot_id_req
- name: name_19 - name: name_group_snap_req
- status: status_7 - status: status_group_snap
- description: description_16 - description: description_group_snap_req
- created_at: created_at - created_at: created_at
- group_id: group_id_1 - group_id: group_id
- group_type_id: group_type_id_2 - group_type_id: group_type_id
Response Example Response Example
---------------- ----------------
@ -183,8 +183,8 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_snapshots: group_snapshots - group_snapshots: group_snapshots
- id: group_snapshot_id_1 - id: group_snapshot_id_req
- name: name_19 - name: name_group_snap_req
Response Example Response Example
@ -221,9 +221,9 @@ Request
- project_id: project_id_path - project_id: project_id_path
- group_snapshot: group_snapshot - group_snapshot: group_snapshot
- name: name_18 - name: name_group_snap
- description: description_14 - description: description_group_snap
- group_id: group_id_1 - group_id: group_id
Request Example Request Example
--------------- ---------------
@ -237,9 +237,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_snapshot: group_snapshot - group_snapshot: group_snapshot
- id: group_snapshot_id_1 - id: group_snapshot_id_req
- name: name_19 - name: name_group_snap_req
- group_type_id: group_type_id_2 - group_type_id: group_type_id
Response Example Response Example
---------------- ----------------
@ -274,9 +274,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_snapshot_id: group_snapshot_id - group_snapshot_id: group_snapshot_id_path
- reset_status: reset_status - reset_status: reset_status
- status: status_7 - status: status_group_snap
Request Example Request Example
--------------- ---------------

16
api-ref/source/v3/group-type-specs.inc
View File

@ -31,8 +31,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1 - group_type_id: group_type_id_path
- group_specs: group_specs_2 - group_specs: group_specs_req
Request Example Request Example
--------------- ---------------
@ -47,7 +47,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_specs: group_specs_2 - group_specs: group_specs_req
Response Example Response Example
@ -84,7 +84,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1 - group_type_id: group_type_id_path
Response Parameters Response Parameters
@ -92,7 +92,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_specs: group_specs_2 - group_specs: group_specs_req
Response Example Response Example
@ -129,7 +129,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1 - group_type_id: group_type_id_path
- spec_id: spec_id - spec_id: spec_id
@ -174,7 +174,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1 - group_type_id: group_type_id_path
- spec_id: spec_id - spec_id: spec_id
- spec: spec_value - spec: spec_value
@ -225,5 +225,5 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1 - group_type_id: group_type_id_path
- spec_id: spec_id - spec_id: spec_id

30
api-ref/source/v3/group-types.inc
View File

@ -35,9 +35,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1 - group_type_id: group_type_id_path
- group_type: group_type - group_type: group_type
- name: name_16 - name: name_group
- description: description_group_type_optional - description: description_group_type_optional
- is_public: is_public_group_type_optional - is_public: is_public_group_type_optional
@ -54,11 +54,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type: group_type - group_type: group_type
- id: group_type_id_2 - id: group_type_id
- is_public: is_public_group_type_required - is_public: is_public_group_type_required
- group_specs: group_specs - group_specs: group_specs
- description: description_group_type_required - description: description_group_type_required
- name: name_16 - name: name_group_type
Response Example Response Example
---------------- ----------------
@ -91,7 +91,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1 - group_type_id: group_type_id_path
Response Parameters Response Parameters
@ -100,8 +100,8 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type: group_type - group_type: group_type
- id: group_type_id_2 - id: group_type_id
- name: name_16 - name: name_group_type
- is_public: is_public_group_type_required - is_public: is_public_group_type_required
- group_specs: group_specs - group_specs: group_specs
- description: description_group_type_required - description: description_group_type_required
@ -147,8 +147,8 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type: group_type - group_type: group_type
- id: group_type_id_2 - id: group_type_id
- name: name_16 - name: name_group_type
- is_public: is_public_group_type_required - is_public: is_public_group_type_required
- group_specs: group_specs - group_specs: group_specs
- description: description_group_type_required - description: description_group_type_required
@ -187,7 +187,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type_id: group_type_id_1 - group_type_id: group_type_id_path
- project_id: project_id_path - project_id: project_id_path
@ -224,9 +224,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_types: group_types - group_types: group_types
- id: group_type_id_2 - id: group_type_id
- group_specs: group_specs - group_specs: group_specs
- name: name_16 - name: name_group_type
- is_public: is_public_group_type_required - is_public: is_public_group_type_required
- description: description_group_type_required - description: description_group_type_required
@ -266,7 +266,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- group_type: group_type - group_type: group_type
- name: name_16 - name: name_group_type
- description: description_group_type_optional - description: description_group_type_optional
- is_public: is_public_group_type_optional - is_public: is_public_group_type_optional
- group_specs: group_specs - group_specs: group_specs
@ -284,11 +284,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type: group_type - group_type: group_type
- id: group_type_id_2 - id: group_type_id
- is_public: is_public_group_type_required - is_public: is_public_group_type_required
- group_specs: group_specs - group_specs: group_specs
- description: description_group_type_required - description: description_group_type_required
- name: name_16 - name: name_group_type
Response Example Response Example

36
api-ref/source/v3/groups.inc
View File

@ -95,7 +95,7 @@ Request
- group: group - group: group
- description: description_group_false - description: description_group_false
- availability_zone: availability_zone - availability_zone: availability_zone
- group_type: group_type_id_2 - group_type: group_type_id
- volume_types: volume_types - volume_types: volume_types
- name: group_name - name: group_name
@ -110,7 +110,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: group_id - id: group_id_path
- name: group_name - name: group_name
Response Example Response Example
@ -144,7 +144,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id_path
- list_volume: list_volume - list_volume: list_volume
Response Parameters Response Parameters
@ -153,13 +153,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group: group - group: group
- status: status_8 - status: status_group
- description: description_group_true - description: description_group_true
- availability_zone: availability_zone - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- group_type: group_type_id_2 - group_type: group_type_id
- group_snapshot_id: group_snapshot_id_2 - group_snapshot_id: group_snapshot_id
- source_group_id: source_group_id_2 - source_group_id: source_group_id
- volume_types: volume_types - volume_types: volume_types
- id: id - id: id
- name: group_name - name: group_name
@ -202,8 +202,8 @@ Request
- project_id: project_id_path - project_id: project_id_path
- create-from-src: create-from-src - create-from-src: create-from-src
- description: description_group_false - description: description_group_false
- group_snapshot_id: group_snapshot_id_1 - group_snapshot_id: group_snapshot_id_req
- source_group_id: source_group_id - source_group_id: source_group_id_req
- name: group_name - name: group_name
Request Example Request Example
@ -217,7 +217,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: group_id - id: group_id_path
- name: group_name - name: group_name
Response Example Response Example
@ -253,7 +253,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id_path
- delete: delete - delete: delete
- delete-volumes: delete-volumes - delete-volumes: delete-volumes
@ -305,15 +305,15 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- groups: groups - groups: groups
- status: status_8 - status: status_group
- description: description_group_true - description: description_group_true
- availability_zone: availability_zone - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- group_type: group_type_id_2 - group_type: group_type_id
- group_snapshot_id: group_snapshot_id_2 - group_snapshot_id: group_snapshot_id
- source_group_id: source_group_id_2 - source_group_id: source_group_id
- volume_types: volume_types - volume_types: volume_types
- id: group_id - id: group_id_path
- name: name - name: name
- volumes: volume_ids - volumes: volume_ids
@ -350,7 +350,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id_path
- group: group - group: group
- remove_volumes: remove_volumes - remove_volumes: remove_volumes
- description: description_group_false - description: description_group_false
@ -390,7 +390,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id - project_id: project_id
- group_id: group_id - group_id: group_id_path
- reset_status: reset_status - reset_status: reset_status
- status: status - status: status

8
api-ref/source/v3/hosts.inc
View File

@ -44,9 +44,9 @@ Response Parameters
- hosts: hosts - hosts: hosts
- service-status: service_status - service-status: service_status
- service: host_service - service: host_service
- zone: availability_zone_3 - zone: availability_zone_required
- service-state: service_state - service-state: service_state
- host_name: host_name_1 - host_name: host_name_backend
- last-update: updated_at - last-update: updated_at
Response Example Response Example
@ -97,8 +97,8 @@ Response
- volume_count: total_count - volume_count: total_count
- total_volume_gb: totalGigabytesUsed - total_volume_gb: totalGigabytesUsed
- total_snapshot_gb: totalSnapGigabytesUsed - total_snapshot_gb: totalSnapGigabytesUsed
- project: project_id_2 - project: project_id_host
- host: host_name_1 - host: host_name_backend
- snapshot_count: totalSnapshotsUsed - snapshot_count: totalSnapshotsUsed
Response Example Response Example

2
api-ref/source/v3/limits.inc
View File

@ -45,7 +45,7 @@ Response Parameters
- limits: limits - limits: limits
- rate: rate - rate: rate
- absolute: absolute - absolute: absolute
- totalSnapshotsUsed: totalSnapshotsUsed_1 - totalSnapshotsUsed: totalSnapshotsUsed_int
- maxTotalBackups: maxTotalBackups - maxTotalBackups: maxTotalBackups
- maxTotalVolumeGigabytes: maxTotalVolumeGigabytes - maxTotalVolumeGigabytes: maxTotalVolumeGigabytes
- maxTotalSnapshots: maxTotalSnapshots - maxTotalSnapshots: maxTotalSnapshots

8
api-ref/source/v3/messages.inc
View File

@ -74,13 +74,13 @@ Response Parameters
- message: user_message - message: user_message
- request_id: request_id - request_id: request_id
- links: links_5 - links: links_message
- message_level: message_level - message_level: message_level
- event_id: event_id - event_id: event_id
- created_at: created_at - created_at: created_at
- guaranteed_until: guaranteed_until - guaranteed_until: guaranteed_until
- resource_uuid: resource_uuid - resource_uuid: resource_uuid
- id: id_8 - id: id_message
- resource_type: resource_type - resource_type: resource_type
- user_message: user_message - user_message: user_message
@ -130,13 +130,13 @@ Response Parameters
- messages: user_messages - messages: user_messages
- request_id: request_id - request_id: request_id
- links: links_5 - links: links_message
- message_level: message_level - message_level: message_level
- event_id: event_id - event_id: event_id
- created_at: created_at - created_at: created_at
- guaranteed_until: guaranteed_until - guaranteed_until: guaranteed_until
- resource_uuid: resource_uuid - resource_uuid: resource_uuid
- id: id_8 - id: id_message
- resource_type: resource_type - resource_type: resource_type
- user_message: user_message - user_message: user_message

22
api-ref/source/v3/os-cgsnapshots-v3.inc
View File

@ -28,7 +28,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- cgsnapshot_id: cgsnapshot_id_1 - cgsnapshot_id: cgsnapshot_id_path
Show consistency group snapshot detail Show consistency group snapshot detail
@ -52,7 +52,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- cgsnapshot_id: cgsnapshot_id_1 - cgsnapshot_id: cgsnapshot_id_path
Response Parameters Response Parameters
@ -64,9 +64,9 @@ Response Parameters
- status: status - status: status
- description: description_cg_snapshot_true - description: description_cg_snapshot_true
- created_at: created_at - created_at: created_at
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- id: id - id: id
- name: name_2 - name: name_cgsnap
Response Example Response Example
---------------- ----------------
@ -107,9 +107,9 @@ Response Parameters
- status: status - status: status
- description: description_cg_snapshot_true - description: description_cg_snapshot_true
- created_at: created_at - created_at: created_at
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- id: id - id: id
- name: name_2 - name: name_cgsnap
Response Example Response Example
---------------- ----------------
@ -149,7 +149,7 @@ Response Parameters
- cgsnapshots: cgsnapshots - cgsnapshots: cgsnapshots
- id: id - id: id
- name: name_2 - name: name_cgsnap
@ -183,8 +183,8 @@ Request
- project_id: project_id_path - project_id: project_id_path
- cgsnapshot: cgsnapshot - cgsnapshot: cgsnapshot
- name: name_5 - name: name_snap
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- description: description_cg_snapshot_false - description: description_cg_snapshot_false
Request Example Request Example
@ -201,6 +201,6 @@ Response Parameters
- status: status - status: status
- description: description_cg_snapshot_true - description: description_cg_snapshot_true
- created_at: created_at - created_at: created_at
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- id: id - id: id
- name: name_2 - name: name_cgsnap

72
api-ref/source/v3/os-services.inc
View File

@ -44,16 +44,16 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- services: services - services: services
- binary: binary - binary: binary_required
- disabled_reason: disabled_reason_body - disabled_reason: disabled_reason_body_req
- host: host_name_body - host: host_name_body_req
- state: service_state_1 - state: service_state_up_down
- status: service_status - status: service_status
- frozen: frozen - frozen: frozen
- updated_at: updated - updated_at: updated
- zone: availability_zone_3 - zone: availability_zone_required
- cluster: cluster - cluster: cluster_cvol
- replication_status: replication_status_1 - replication_status: replication_status_cvol
- active_backend_id: active_backend_id - active_backend_id: active_backend_id
- backend_state: backend_state - backend_state: backend_state
@ -92,8 +92,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- host: host_name_body - host: host_name_body_req
- binary: binary - binary: binary_required
Request Example Request Example
--------------- ---------------
@ -106,11 +106,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- disabled: disabled_1 - disabled: disabled_required
- status: service_status - status: service_status
- host: host_name_body - host: host_name_body_req
- service: service_key - service: service_key
- binary: binary - binary: binary_required
Response Example Response Example
---------------- ----------------
@ -148,9 +148,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- binary: binary - binary: binary_required
- host: host_name_body - host: host_name_body_req
- disabled_reason: disabled_reason_body_1 - disabled_reason: disabled_reason_body
Request Example Request Example
--------------- ---------------
@ -163,12 +163,12 @@ Response
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- disabled: disabled_1 - disabled: disabled_required
- status: service_status - status: service_status
- host: host_name_body - host: host_name_body_req
- service: service_key - service: service_key
- binary: binary - binary: binary_required
- disabled_reason: disabled_reason_body - disabled_reason: disabled_reason_body_req
Response Example Response Example
---------------- ----------------
@ -205,8 +205,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- binary: binary - binary: binary_required
- host: host_name_body - host: host_name_body_req
Request Example Request Example
--------------- ---------------
@ -219,12 +219,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- disabled: disabled_1 - disabled: disabled_required
- status: service_status - status: service_status
- host: host_name_body - host: host_name_body_req
- service: service_key - service: service_key
- binary: binary - binary: binary_required
- disabled_reason: disabled_reason_body - disabled_reason: disabled_reason_body_req
Response Example Response Example
---------------- ----------------
@ -260,8 +260,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- binary: binary_1 - binary: binary
- server: host_name_body_1 - server: host_name_body
- prefix: prefix - prefix: prefix
Request Example Request Example
@ -276,8 +276,8 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- log_levels: log_levels - log_levels: log_levels
- binary: binary - binary: binary_required
- host: host_name_body - host: host_name_body_req
- levels: levels - levels: levels
Response Example Response Example
@ -314,10 +314,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- binary: binary_1 - binary: binary
- server: host_name_body_1 - server: host_name_body
- prefix: prefix - prefix: prefix
- levels: levels_1 - levels: levels_set
Request Example Request Example
--------------- ---------------
@ -353,7 +353,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- host: host_name_body - host: host_name_body_req
Request Example Request Example
--------------- ---------------
@ -389,7 +389,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- host: host_name_body - host: host_name_body_req
Request Example Request Example
--------------- ---------------
@ -427,9 +427,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- host: host_name_body - host: host_name_body_req
- backend_id: backend_id - backend_id: backend_id
- cluster: cluster - cluster: cluster_cvol
Request Example Request Example
--------------- ---------------

2
api-ref/source/v3/os-vol-pool-v3.inc
View File

@ -43,7 +43,7 @@ Response Parameters
- pools: pools - pools: pools
- updated: updated - updated: updated
- QoS_support: QoS_support - QoS_support: QoS_support
- name: name_20 - name: name_backend_pool
- total_capacity_gb: total_capacity - total_capacity_gb: total_capacity
- volume_backend_name: volume_backend_name - volume_backend_name: volume_backend_name
- capabilities: capabilities - capabilities: capabilities

868
api-ref/source/v3/parameters.yaml
View File

File diff suppressed because it is too large Load Diff

20
api-ref/source/v3/qos-specs-v3-qos-specs.inc
View File

@ -202,9 +202,9 @@ Response Parameters
- qos_specs: qos_specs - qos_specs: qos_specs
- specs: specs - specs: specs
- consumer: consumer - consumer: consumer
- name: name_4 - name: name_qos_spec
- id: id_3 - id: id_qos_spec
- links: links_2 - links: links_qos
Response Example Response Example
@ -281,7 +281,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- qos_id: qos_id - qos_id: qos_id
- force: force_3 - force: force_del_qos
Create a QoS specification Create a QoS specification
@ -309,7 +309,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- qos_specs: qos_specs - qos_specs: qos_specs
- name: name_4 - name: name_qos_spec
Request Example Request Example
--------------- ---------------
@ -324,9 +324,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- qos_specs: qos_specs - qos_specs: qos_specs
- name: name_4 - name: name_qos_spec
- links: links_2 - links: links_qos
- id: id_3 - id: id_qos_spec
- consumer: consumer - consumer: consumer
- specs: specs - specs: specs
@ -377,8 +377,8 @@ Response Parameters
- qos_specs: qos_specs - qos_specs: qos_specs
- specs: specs - specs: specs
- consumer: consumer - consumer: consumer
- id: id_3 - id: id_qos_spec
- name: name_4 - name: name_qos_spec
Response Example Response Example

4
api-ref/source/v3/resource-filters.inc
View File

@ -35,9 +35,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- resource_filters: resource_filters_1 - resource_filters: resource_filters_coll
- filters: resource_filters - filters: resource_filters
- resource: resource_1 - resource: resource_fil
Response Example Response Example
---------------- ----------------

18
api-ref/source/v3/snapshot-manage.inc
View File

@ -39,10 +39,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- snapshot: snapshot_1 - snapshot: snapshot_obj
- description: description_4 - description: description_snap
- metadata: metadata_7 - metadata: metadata_snap
- name: name_5 - name: name_snap
- ref: ref - ref: ref
- volume_id: volume_id - volume_id: volume_id
@ -58,14 +58,14 @@ Response
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- snapshot: snapshot_1 - snapshot: snapshot_obj
- status: status_2 - status: status_snap
- size: size - size: size
- metadata: metadata_7 - metadata: metadata_snap
- name: name_5 - name: name_snap
- volume_id: volume_id - volume_id: volume_id
- created_at: created_at - created_at: created_at
- description: description_8 - description: description_snap_req
- id: id - id: id
- updated_at: updated_at - updated_at: updated_at

22
api-ref/source/v3/volume-manage.inc
View File

@ -43,15 +43,15 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume: volume - volume: volume
- description: description_5 - description: description_vol
- availability_zone: availability_zone - availability_zone: availability_zone
- bootable: bootable_1 - bootable: bootable_required
- volume_type: volume_type - volume_type: volume_type
- name: volume_name_optional - name: volume_name_optional
- host: host_mutex - host: host_mutex
- cluster: cluster_mutex - cluster: cluster_mutex
- ref: ref - ref: ref
- metadata: metadata_10 - metadata: metadata_vol
Request Example Request Example
--------------- ---------------
@ -69,26 +69,26 @@ Response
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume: volume - volume: volume
- status: status_3 - status: status_vol
- migration_status: migration_status - migration_status: migration_status_req
- user_id: user_id - user_id: user_id
- attachments: attachments - attachments: attachments
- links: links_3 - links: links_vol
- availability_zone: availability_zone - availability_zone: availability_zone
- bootable: bootable_response - bootable: bootable_response
- encrypted: encrypted - encrypted: encrypted
- created_at: created_at - created_at: created_at
- description: description_5 - description: description_vol
- updated_at: updated_at - updated_at: updated_at
- volume_type: volume_type - volume_type: volume_type
- name: name_13 - name: name_vol
- replication_status: replication_status - replication_status: replication_status
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- source_volid: source_volid - source_volid: source_volid
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- multiattach: multiattach_resp - multiattach: multiattach_resp
- metadata: metadata_1 - metadata: metadata_vol_obj
- id: id_5 - id: id_vol
- size: size - size: size
Response Example Response Example

2
api-ref/source/v3/volumes-v3-extensions.inc
View File

@ -39,7 +39,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- updated: updated_at - updated: updated_at
- description: description_7 - description: description_extn
- links: links - links: links
- namespace: namespace - namespace: namespace
- alias: alias - alias: alias

4
api-ref/source/v3/volumes-v3-snapshots-actions.inc
View File

@ -30,7 +30,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- os-reset_status: os-reset_status - os-reset_status: os-reset_status
- status: status_2 - status: status_snap
Request Example Request Example
--------------- ---------------
@ -63,7 +63,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- os-update_snapshot_status: os-update_snapshot_status - os-update_snapshot_status: os-update_snapshot_status
- status: status_2 - status: status_snap
- progress: snapshot_progress - progress: snapshot_progress
Request Example Request Example

86
api-ref/source/v3/volumes-v3-snapshots.inc
View File

@ -74,20 +74,20 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_2 - status: status_snap
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress - os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description_8 - description: description_snap_req
- created_at: created_at - created_at: created_at
- name: name - name: name
- user_id: user_id_2 - user_id: user_id_min
- volume_id: volume_id_5 - volume_id: volume_id_snap
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id - os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size - size: size
- id: id_4 - id: id_snap
- metadata: metadata - metadata: metadata
- count: count - count: count
- updated_at: updated_at - updated_at: updated_at
- snapshots_links: links_7 - snapshots_links: links_snap
Response Example Response Example
---------------- ----------------
@ -118,12 +118,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- snapshot: snapshot_1 - snapshot: snapshot_obj
- volume_id: volume_id - volume_id: volume_id
- name: name_12 - name: name_snap_req
- description: description_4 - description: description_snap
- force: force - force: force
- metadata: metadata_7 - metadata: metadata_snap
Request Example Request Example
--------------- ---------------
@ -136,15 +136,15 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_2 - status: status_snap
- description: description_8 - description: description_snap_req
- created_at: created_at - created_at: created_at
- name: name_12 - name: name_snap_req
- snapshot: snapshot_1 - snapshot: snapshot_obj
- user_id: user_id_2 - user_id: user_id_min
- volume_id: volume_id_5 - volume_id: volume_id_snap
- metadata: metadata - metadata: metadata
- id: id_4 - id: id_snap
- size: size - size: size
- updated_at: updated_at - updated_at: updated_at
@ -195,18 +195,18 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_2 - status: status_snap
- description: description_8 - description: description_snap_req
- created_at: created_at - created_at: created_at
- name: name - name: name
- user_id: user_id_2 - user_id: user_id_min
- volume_id: volume_id_5 - volume_id: volume_id_snap
- metadata: metadata - metadata: metadata
- id: id_4 - id: id_snap
- size: size - size: size
- count: count - count: count
- updated_at: updated_at - updated_at: updated_at
- snapshots_links: links_7 - snapshots_links: links_snap
Response Example Response Example
---------------- ----------------
@ -373,17 +373,17 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_2 - status: status_snap
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress - os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description_8 - description: description_snap_req
- created_at: created_at - created_at: created_at
- name: name - name: name
- snapshot: snapshot_1 - snapshot: snapshot_obj
- user_id: user_id_2 - user_id: user_id_min
- volume_id: volume_id_5 - volume_id: volume_id_snap
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id - os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size - size: size
- id: id_4 - id: id_snap
- metadata: metadata - metadata: metadata
- updated_at: updated_at - updated_at: updated_at
@ -416,8 +416,8 @@ Request
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- snapshot: snapshot_1 - snapshot: snapshot_obj
- description: description_4 - description: description_snap
- name: name - name: name
Request Example Request Example
@ -433,15 +433,15 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_2 - status: status_snap
- description: description_8 - description: description_snap_req
- created_at: created_at - created_at: created_at
- name: name - name: name
- snapshot: snapshot_1 - snapshot: snapshot_obj
- id: id_4 - id: id_snap
- size: size - size: size
- volume_id: volume_id_5 - volume_id: volume_id_snap
- user_id: user_id_2 - user_id: user_id_min
- metadata: metadata - metadata: metadata
Response Example Response Example
@ -507,7 +507,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- key: key_2 - key: key_view
Response Parameters Response Parameters
@ -515,7 +515,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- meta: meta_1 - meta: meta_snap
Response Example Response Example
---------------- ----------------
@ -547,7 +547,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- key: key_1 - key: key_path
Update a snapshot's metadata for a specific key Update a snapshot's metadata for a specific key
@ -572,8 +572,8 @@ Request
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- key: key_3 - key: key_update
- meta: meta_1 - meta: meta_snap
Request Example Request Example
--------------- ---------------
@ -586,7 +586,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- meta: meta_1 - meta: meta_snap
Response Example Response Example
---------------- ----------------

20
api-ref/source/v3/volumes-v3-types.inc
View File

@ -39,7 +39,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_type_id: volume_type_id - volume_type_id: volume_type_id
- volume_type: volume_type_1 - volume_type: volume_type
- name: name_volume_type_optional - name: name_volume_type_optional
- description: description_volume_type_optional - description: description_volume_type_optional
- is_public: is_public_volume_type_optional - is_public: is_public_volume_type_optional
@ -56,7 +56,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type_1 - volume_type: volume_type
- is_public: is_public_volume_type_required - is_public: is_public_volume_type_required
- extra_specs: extra_specs_volume_type_optional - extra_specs: extra_specs_volume_type_optional
- description: description_volume_type_required - description: description_volume_type_required
@ -176,7 +176,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_type_id: volume_type_id - volume_type_id: volume_type_id
- key: key_4 - key: key_extra_spec
Response Example Response Example
@ -208,7 +208,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_type_id: volume_type_id - volume_type_id: volume_type_id
- key: key_4 - key: key_extra_spec
Request Example Request Example
--------------- ---------------
@ -246,7 +246,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_type_id: volume_type_id - volume_type_id: volume_type_id
- key: key_4 - key: key_extra_spec
Show volume type detail Show volume type detail
@ -277,7 +277,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type_1 - volume_type: volume_type
- is_public: is_public_volume_type_required - is_public: is_public_volume_type_required
- extra_specs: extra_specs_volume_type_optional - extra_specs: extra_specs_volume_type_optional
- description: description_volume_type_required - description: description_volume_type_required
@ -321,7 +321,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type_1 - volume_type: volume_type
- is_public: is_public_volume_type_required - is_public: is_public_volume_type_required
- extra_specs: extra_specs_volume_type_optional - extra_specs: extra_specs_volume_type_optional
- description: description_volume_type_required - description: description_volume_type_required
@ -429,7 +429,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- volume_type: volume_type_1 - volume_type: volume_type
- name: name_volume_type_required - name: name_volume_type_required
- os-volume-type-access:is_public: is_public_volume_type_optional - os-volume-type-access:is_public: is_public_volume_type_optional
- description: description_volume_type_optional - description: description_volume_type_optional
@ -447,7 +447,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type_1 - volume_type: volume_type
- is_public: is_public_volume_type_required - is_public: is_public_volume_type_required
- extra_specs: extra_specs_volume_type_optional - extra_specs: extra_specs_volume_type_optional
- description: description_volume_type_required - description: description_volume_type_required
@ -531,7 +531,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_type_id: volume_type_id - volume_type_id: volume_type_id
- key: key_5 - key: key_encrypt_spec
Response Example Response Example
---------------- ----------------

2
api-ref/source/v3/volumes-v3-versions.inc
View File

@ -33,7 +33,7 @@ Response Parameters
- status: version_status - status: version_status
- updated: version_updated - updated: version_updated
- links: links_6 - links: links_res
- min_version: version_min - min_version: version_min
- version: version_max - version: version_max
- media-types: media_types - media-types: media_types

26
api-ref/source/v3/volumes-v3-volumes-actions.inc
View File

@ -101,8 +101,8 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-reset_status: os-reset_status - os-reset_status: os-reset_status
- status: status_3 - status: status_vol
- migration_status: migration_status_1 - migration_status: migration_status
- attach_status: attach_status - attach_status: attach_status
Request Example Request Example
@ -144,7 +144,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- revert: revert - revert: revert
- snapshot_id: snapshot_id_4 - snapshot_id: snapshot_id_revert
Request Example Request Example
--------------- ---------------
@ -176,7 +176,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-set_image_metadata: os-set_image_metadata - os-set_image_metadata: os-set_image_metadata
- metadata: metadata_5 - metadata: metadata_image
Request Example Request Example
--------------- ---------------
@ -254,7 +254,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- metadata: metadata_5 - metadata: metadata_image
Response Example Response Example
---------------- ----------------
@ -587,7 +587,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-set_bootable: os-set_bootable - os-set_bootable: os-set_bootable
- bootable: bootable - bootable: bootable_required
Request Example Request Example
--------------- ---------------
@ -620,10 +620,10 @@ Request
- volume_id: volume_id_path - volume_id: volume_id_path
- os-volume_upload_image: os-volume_upload_image - os-volume_upload_image: os-volume_upload_image
- image_name: image_name - image_name: image_name
- force: force_4 - force: force_upload_vol
- disk_format: disk_format - disk_format: disk_format
- container_format: container_format - container_format: container_format
- visibility: visibility_1 - visibility: visibility_min
- protected: protected - protected: protected
Request Example Request Example
@ -638,18 +638,18 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- os-volume_upload_image: os-volume_upload_image - os-volume_upload_image: os-volume_upload_image
- status: status_3 - status: status_vol
- image_name: image_name - image_name: image_name
- disk_format: disk_format - disk_format: disk_format
- container_format: container_format - container_format: container_format
- visibility: visibility_1 - visibility: visibility_min
- protected: protected - protected: protected
- updated_at: updated_at - updated_at: updated_at
- image_id: image_id - image_id: image_id
- display_description: description_9 - display_description: description_vol_req
- id: id_5 - id: id_vol
- size: size - size: size
- volume_type: volume_type_6 - volume_type: volume_type_vol
Response Example Response Example

110
api-ref/source/v3/volumes-v3-volumes.inc
View File

@ -101,33 +101,33 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- migration_status: migration_status - migration_status: migration_status_req
- attachments: attachments - attachments: attachments
- links: links_3 - links: links_vol
- availability_zone: availability_zone - availability_zone: availability_zone
- os-vol-host-attr:host: os-vol-host-attr:host - os-vol-host-attr:host: os-vol-host-attr:host
- encrypted: encrypted - encrypted: encrypted
- updated_at: updated_at - updated_at: updated_at
- replication_status: replication_status - replication_status: replication_status
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- id: id_5 - id: id_vol
- size: size - size: size
- user_id: user_id - user_id: user_id
- os-vol-tenant-attr:tenant_id: os-vol-tenant-attr:tenant_id - os-vol-tenant-attr:tenant_id: os-vol-tenant-attr:tenant_id
- os-vol-mig-status-attr:migstat: os-vol-mig-status-attr:migstat - os-vol-mig-status-attr:migstat: os-vol-mig-status-attr:migstat
- metadata: metadata_1 - metadata: metadata_vol_obj
- status: status_3 - status: status_vol
- volume_image_metadata: volume_image_metadata - volume_image_metadata: volume_image_metadata
- description: description_9 - description: description_vol_req
- multiattach: multiattach_resp - multiattach: multiattach_resp
- source_volid: source_volid - source_volid: source_volid
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- os-vol-mig-status-attr:name_id: os-vol-mig-status-attr:name_id - os-vol-mig-status-attr:name_id: os-vol-mig-status-attr:name_id
- name: name_13 - name: name_vol
- bootable: bootable_response - bootable: bootable_response
- created_at: created_at - created_at: created_at
- volumes: volumes - volumes: volumes
- volume_type: volume_type_6 - volume_type: volume_type_vol
- count: count - count: count
@ -195,15 +195,15 @@ Request
- size: size - size: size
- availability_zone: availability_zone - availability_zone: availability_zone
- source_volid: source_volid - source_volid: source_volid
- description: description_5 - description: description_vol
- multiattach: multiattach_req - multiattach: multiattach_req
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- backup_id: backup_id_1 - backup_id: backup_id
- name: volume_name_optional - name: volume_name_optional
- imageRef: imageRef - imageRef: imageRef
- volume_type: volume_type_2 - volume_type: volume_type_detail
- metadata: metadata_10 - metadata: metadata_vol
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints - OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints
Request Example Request Example
@ -219,28 +219,28 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- migration_status: migration_status - migration_status: migration_status_req
- attachments: attachments - attachments: attachments
- links: links_3 - links: links_vol
- availability_zone: availability_zone - availability_zone: availability_zone
- encrypted: encrypted - encrypted: encrypted
- updated_at: updated_at - updated_at: updated_at
- replication_status: replication_status - replication_status: replication_status
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- id: id_5 - id: id_vol
- size: size - size: size
- user_id: user_id - user_id: user_id
- metadata: metadata_1 - metadata: metadata_vol_obj
- status: status_3 - status: status_vol
- description: description_9 - description: description_vol_req
- multiattach: multiattach_resp - multiattach: multiattach_resp
- source_volid: source_volid - source_volid: source_volid
- volume: volume - volume: volume
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- name: name_13 - name: name_vol
- bootable: bootable_response - bootable: bootable_response
- created_at: created_at - created_at: created_at
- volume_type: volume_type_6 - volume_type: volume_type_vol
Response Example Response Example
---------------- ----------------
@ -291,9 +291,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volumes: volumes - volumes: volumes
- id: id_5 - id: id_vol
- links: links_3 - links: links_vol
- name: name_13 - name: name_vol
- count: count - count: count
@ -340,33 +340,33 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- migration_status: migration_status - migration_status: migration_status_req
- attachments: attachments - attachments: attachments
- links: links_3 - links: links_vol
- availability_zone: availability_zone - availability_zone: availability_zone
- os-vol-host-attr:host: os-vol-host-attr:host - os-vol-host-attr:host: os-vol-host-attr:host
- encrypted: encrypted - encrypted: encrypted
- updated_at: updated_at - updated_at: updated_at
- replication_status: replication_status - replication_status: replication_status
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- id: id_5 - id: id_vol
- size: size - size: size
- user_id: user_id - user_id: user_id
- os-vol-tenant-attr:tenant_id: os-vol-tenant-attr:tenant_id - os-vol-tenant-attr:tenant_id: os-vol-tenant-attr:tenant_id
- os-vol-mig-status-attr:migstat: os-vol-mig-status-attr:migstat - os-vol-mig-status-attr:migstat: os-vol-mig-status-attr:migstat
- metadata: metadata_1 - metadata: metadata_vol_obj
- status: status_3 - status: status_vol
- volume_image_metadata: volume_image_metadata - volume_image_metadata: volume_image_metadata
- description: description_9 - description: description_vol_req
- multiattach: multiattach_resp - multiattach: multiattach_resp
- source_volid: source_volid - source_volid: source_volid
- volume: volume - volume: volume
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- os-vol-mig-status-attr:name_id: os-vol-mig-status-attr:name_id - os-vol-mig-status-attr:name_id: os-vol-mig-status-attr:name_id
- name: name_13 - name: name_vol
- bootable: bootable_response - bootable: bootable_response
- created_at: created_at - created_at: created_at
- volume_type: volume_type_6 - volume_type: volume_type_vol
- service_uuid: service_uuid - service_uuid: service_uuid
- shared_targets: shared_targets - shared_targets: shared_targets
@ -403,9 +403,9 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- volume: volume - volume: volume
- description: description_5 - description: description_vol
- name: volume_name_optional - name: volume_name_optional
- metadata: metadata_2 - metadata: metadata_vol_assoc
Request Example Request Example
--------------- ---------------
@ -420,28 +420,28 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- migration_status: migration_status - migration_status: migration_status_req
- attachments: attachments - attachments: attachments
- links: links_3 - links: links_vol
- availability_zone: availability_zone - availability_zone: availability_zone
- encrypted: encrypted - encrypted: encrypted
- updated_at: updated_at - updated_at: updated_at
- replication_status: replication_status - replication_status: replication_status
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- id: id_5 - id: id_vol
- size: size - size: size
- user_id: user_id - user_id: user_id
- metadata: metadata_1 - metadata: metadata_vol_obj
- status: status_3 - status: status_vol
- description: description_9 - description: description_vol_req
- multiattach: multiattach_resp - multiattach: multiattach_resp
- source_volid: source_volid - source_volid: source_volid
- volume: volume - volume: volume
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_required
- name: name_13 - name: name_vol
- bootable: bootable_response - bootable: bootable_response
- created_at: created_at - created_at: created_at
- volume_type: volume_type_6 - volume_type: volume_type_vol
Response Example Response Example
@ -500,7 +500,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- cascade: cascade - cascade: cascade
- force: force_5 - force: force_vol_del
Create metadata for volume Create metadata for volume
@ -526,7 +526,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- metadata: metadata_3 - metadata: metadata_vol_assoc_req
Request Example Request Example
--------------- ---------------
@ -541,7 +541,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- metadata: metadata_3 - metadata: metadata_vol_assoc_req
Response Example Response Example
@ -581,7 +581,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- metadata: metadata_3 - metadata: metadata_vol_assoc_req
@ -615,7 +615,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- metadata: metadata_3 - metadata: metadata_vol_assoc_req
Request Example Request Example
--------------- ---------------
@ -630,7 +630,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- metadata: metadata_3 - metadata: metadata_vol_assoc_req
@ -663,7 +663,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- key: key_2 - key: key_view
Response Parameters Response Parameters
@ -705,7 +705,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- key: key_1 - key: key_path
Update a volume's metadata for a specific key Update a volume's metadata for a specific key
@ -731,7 +731,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- key: key_3 - key: key_update
- meta: meta - meta: meta
Request Example Request Example

4
api-ref/source/v3/worker-cleanup.inc
View File

@ -30,7 +30,7 @@ Request
- cluster_name: cluster_mutex - cluster_name: cluster_mutex
- service_id: service_id - service_id: service_id
- host: host_service - host: host_service
- binary: binary - binary: binary_required
- is-up: is_up - is-up: is_up
- disabled: disabled - disabled: disabled
- resource-id: resource_id - resource-id: resource_id
@ -50,7 +50,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- host: host_service - host: host_service
- binary: binary - binary: binary_required
- id: service_id - id: service_id
- cluster_name: cluster_mutex - cluster_name: cluster_mutex