diff --git a/api-ref/source/v3/attachments.inc b/api-ref/source/v3/attachments.inc index 7b9845965ea..9272a39728c 100644 --- a/api-ref/source/v3/attachments.inc +++ b/api-ref/source/v3/attachments.inc @@ -62,7 +62,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - attachment_id: attachment_id_1 + - attachment_id: attachment_id_path Show attachment details @@ -93,7 +93,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - attachment_id: attachment_id_1 + - attachment_id: attachment_id_path Response Parameters @@ -101,14 +101,14 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status_9 + - status: status_attachment - detached_at: detached_at - connection_info: connection_info - attached_at: attached_at - - attach_mode: attach_mode - - instance: instance_uuid_1 - - volume_id: volume_id_7 - - id: attachment_id_2 + - attach_mode: attach_mode_required + - instance: instance_uuid_req + - volume_id: volume_id_attachment + - id: attachment_id_required Response Example ---------------- @@ -156,14 +156,14 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status_9 + - status: status_attachment - detached_at: detached_at - connection_info: connection_info - attached_at: attached_at - - attach_mode: attach_mode - - instance: instance_uuid_1 - - volume_id: volume_id_7 - - id: attachment_id_2 + - attach_mode: attach_mode_required + - instance: instance_uuid_req + - volume_id: volume_id_attachment + - id: attachment_id_required Response Example ---------------- @@ -211,10 +211,10 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status_9 - - instance: instance_uuid_1 - - volume_id: volume_id_7 - - id: attachment_id_2 + - status: status_attachment + - instance: instance_uuid_req + - volume_id: volume_id_attachment + - id: attachment_id_required Response Example @@ -253,10 +253,10 @@ Request - project_id: project_id_path - attachment: attachment - - instance_uuid: instance_uuid_1 + - instance_uuid: instance_uuid_req - connector: connector - - volume_uuid: volume_id_7 - - mode: attach_mode_1 + - volume_uuid: volume_id_attachment + - mode: attach_mode Request Example --------------- @@ -270,14 +270,14 @@ Response Parameters .. rest_parameters:: parameters.yaml - attachment: attachment - - status: status_9 + - status: status_attachment - detached_at: detached_at - connection_info: connection_info - attached_at: attached_at - - attach_mode: attach_mode - - instance: instance_uuid_1 - - volume_id: volume_id_7 - - id: attachment_id_2 + - attach_mode: attach_mode_required + - instance: instance_uuid_req + - volume_id: volume_id_attachment + - id: attachment_id_required Response Example ---------------- @@ -314,9 +314,9 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - attachment_id: attachment_id_1 + - attachment_id: attachment_id_path - attachement: attachment - - connector: connector_1 + - connector: connector_required Request Example --------------- @@ -330,14 +330,14 @@ Response Parameters .. rest_parameters:: parameters.yaml - attachment: attachment - - status: status_9 + - status: status_attachment - detached_at: detached_at - connection_info: connection_info - attached_at: attached_at - - attach_mode: attach_mode - - instance: instance_uuid_1 - - volume_id: volume_id_7 - - id: attachment_id_2 + - attach_mode: attach_mode_required + - instance: instance_uuid_req + - volume_id: volume_id_attachment + - id: attachment_id_required Response Example ---------------- @@ -374,7 +374,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - attachment_id: attachment_id_1 + - attachment_id: attachment_id_path Request Example --------------- diff --git a/api-ref/source/v3/capabilities-v3.inc b/api-ref/source/v3/capabilities-v3.inc index d17b929d8af..bd11799f374 100644 --- a/api-ref/source/v3/capabilities-v3.inc +++ b/api-ref/source/v3/capabilities-v3.inc @@ -35,9 +35,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - pool_name: pool_name - - description: description_10 + - description: description_cap - volume_backend_name: volume_backend_name - - namespace: namespace_1 + - namespace: namespace_storage - visibility: visibility - driver_version: driver_version - vendor_name: vendor_name diff --git a/api-ref/source/v3/consistencygroups-v3.inc b/api-ref/source/v3/consistencygroups-v3.inc index f9482d919ed..144d8dc6a13 100644 --- a/api-ref/source/v3/consistencygroups-v3.inc +++ b/api-ref/source/v3/consistencygroups-v3.inc @@ -80,10 +80,10 @@ Request - project_id: project_id_path - consistencygroup: consistencygroup - - description: description_11 + - description: description_consis - availability_zone: availability_zone - - volume_types: volume_types_2 - - name: name_15 + - volume_types: volume_types_commas + - name: name_consis Request Example --------------- @@ -97,13 +97,13 @@ Response .. rest_parameters:: parameters.yaml - consistencygroup: consistencygroup - - status: status_1 - - description: description_6 + - status: status_consis + - description: description_cg - availability_zone: availability_zone - created_at: created_at - volume_types: volume_types - - name: name_15 - - id: consistencygroup_id_1 + - name: name_consis + - id: consistencygroup_id Response Example ---------------- @@ -131,15 +131,15 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - consistencygroup_id: consistencygroup_id_2 + - consistencygroup_id: consistencygroup_id_path Response Parameters ------------------- .. rest_parameters:: parameters.yaml - - status: status_1 - - description: description_6 + - status: status_consis + - description: description_cg - availability_zone: availability_zone - created_at: created_at - volume_types: volume_types @@ -176,9 +176,9 @@ Request - project_id: project_id_path - consistencygroup-from-src: consistencygroup-from-src - - status: status_1 + - status: status_consis - user_id: user_id - - description: description_11 + - description: description_consis - cgsnapshot_id: cgsnapshot_id - source_cgid: source_cgid - project_id: project_id @@ -212,7 +212,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - consistencygroup_id: consistencygroup_id_2 + - consistencygroup_id: consistencygroup_id_path - consistencygroup: consistencygroup - force: force @@ -257,8 +257,8 @@ Response Parameters .. rest_parameters:: parameters.yaml - consistencygroups: consistencygroups - - status: status_1 - - description: description_6 + - status: status_consis + - description: description_cg - availability_zone: availability_zone - created_at: created_at - volume_types: volume_types @@ -294,10 +294,10 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - consistencygroup_id: consistencygroup_id_2 + - consistencygroup_id: consistencygroup_id_path - consistencygroup: consistencygroup - remove_volumes: remove_volumes - - description: description_11 + - description: description_consis - add_volumes: add_volumes - name: name diff --git a/api-ref/source/v3/ext-backups-actions-v3.inc b/api-ref/source/v3/ext-backups-actions-v3.inc index f7594b7cf82..82e942a14b8 100644 --- a/api-ref/source/v3/ext-backups-actions-v3.inc +++ b/api-ref/source/v3/ext-backups-actions-v3.inc @@ -37,7 +37,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - backup_id: backup_id + - backup_id: backup_id_required - os-force_delete: os-force_delete Request Example @@ -75,9 +75,9 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - backup_id: backup_id + - backup_id: backup_id_required - os-reset_status: os-reset_status - - status: status_10 + - status: status_backup_action Request Example --------------- diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc index 76ec2e42bae..432df9733cd 100644 --- a/api-ref/source/v3/ext-backups.inc +++ b/api-ref/source/v3/ext-backups.inc @@ -77,26 +77,26 @@ Response Parameters .. rest_parameters:: parameters.yaml - backups: backups - - status: status_4 + - status: status_backup - object_count: object_count - fail_reason: fail_reason - description: description - - links: links_1 + - links: links_backup - availability_zone: availability_zone - created_at: created_at - updated_at: updated_at - - name: name_1 + - name: name_backup - has_dependent_backups: has_dependent_backups - volume_id: volume_id - container: container - size: size - - id: id_1 + - id: id_backup - is_incremental: is_incremental - 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 - count: count - - metadata: metadata_9 + - metadata: metadata_backup Response Example ---------------- @@ -126,7 +126,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - backup_id: backup_id + - backup_id: backup_id_required Response Parameters @@ -135,26 +135,26 @@ Response Parameters .. rest_parameters:: parameters.yaml - backup: backup - - status: status_4 + - status: status_backup - object_count: object_count - container: container - description: description - - links: links_1 + - links: links_backup - availability_zone: availability_zone - created_at: created_at - updated_at: updated_at - - name: name_1 + - name: name_backup - has_dependent_backups: has_dependent_backups - volume_id: volume_id - fail_reason: fail_reason - size: size - backup: backup - - id: id_1 + - id: id_backup - is_incremental: is_incremental - 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 - - metadata: metadata_9 + - metadata: metadata_backup Response Example ---------------- @@ -187,7 +187,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - backup_id: backup_id + - backup_id: backup_id_required Restore a backup @@ -229,10 +229,10 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - backup_id: backup_id + - backup_id: backup_id_required - restore: restore - name: volume_name_optional - - volume_id: volume_id_6 + - volume_id: volume_id_restore Request Example --------------- @@ -246,7 +246,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - restore: restore - - backup_id: backup_id + - backup_id: backup_id_required - volume_id: volume_id - volume_name: volume_name @@ -285,15 +285,15 @@ Request - project_id: project_id_path - backup: backup - - volume_id: volume_id_2 + - volume_id: volume_id_backup - container: container - description: description - incremental: incremental - force: force - name: name_optional - - snapshot_id: snapshot_id_3 - - metadata: metadata_9 - - availability_zone: availability_zone_4 + - snapshot_id: snapshot_id_backup + - metadata: metadata_backup + - availability_zone: availability_zone_backup Request Example --------------- @@ -307,9 +307,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - backup: backup - - id: id_1 - - links: links_1 - - name: name_1 + - id: id_backup + - links: links_backup + - name: name_backup Update a backup @@ -336,11 +336,11 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - backup_id: backup_id + - backup_id: backup_id_required - backup: backup - description: description - name: name_optional - - metadata: metadata_9 + - metadata: metadata_backup Request Example --------------- @@ -354,9 +354,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - backup: backup - - id: id_1 - - links: links_1 - - name: name_1 + - id: id_backup + - links: links_backup + - name: name_backup Response Example ---------------- @@ -403,9 +403,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - backups: backups - - id: id_1 - - links: links_1 - - name: name_1 + - id: id_backup + - links: links_backup + - name: name_backup - count: count Response Example @@ -442,7 +442,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - backup_id: backup_id + - backup_id: backup_id_required Response Parameters @@ -488,7 +488,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - backup_id: backup_id + - backup_id: backup_id_required - backup-record: backup_record - backup_service: backup_service - backup_url: backup_url @@ -506,9 +506,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - - id: id_1 - - links: links_1 - - name: name_1 + - id: id_backup + - links: links_backup + - name: name_backup Response Example ---------------- diff --git a/api-ref/source/v3/group-replication.inc b/api-ref/source/v3/group-replication.inc index dd4c5a1e68e..133b6fead34 100644 --- a/api-ref/source/v3/group-replication.inc +++ b/api-ref/source/v3/group-replication.inc @@ -34,7 +34,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_id: group_id + - group_id: group_id_path Request Example --------------- @@ -83,7 +83,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_id: group_id + - group_id: group_id_path Request Example --------------- @@ -116,7 +116,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_id: group_id + - group_id: group_id_path Request Example --------------- @@ -149,7 +149,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_id: group_id + - group_id: group_id_path - allow_attached_volume: allow_attached_volume - secondary_backend_id: backend_id_target diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc index 1abcec93b3a..e3acb931aaa 100644 --- a/api-ref/source/v3/group-snapshots.inc +++ b/api-ref/source/v3/group-snapshots.inc @@ -34,7 +34,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_snapshot_id: group_snapshot_id + - group_snapshot_id: group_snapshot_id_path Show group snapshot details @@ -64,7 +64,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_snapshot_id: group_snapshot_id + - group_snapshot_id: group_snapshot_id_path Response Parameters @@ -74,12 +74,12 @@ Response Parameters - group_snapshot: group_snapshot - created_at: created_at - - group_id: source_group_id - - id: group_snapshot_id_1 - - name: name_19 - - status: status_7 - - description: description_16 - - group_type_id: group_type_id_2 + - group_id: source_group_id_req + - id: group_snapshot_id_req + - name: name_group_snap_req + - status: status_group_snap + - description: description_group_snap_req + - group_type_id: group_type_id Response Example ---------------- @@ -128,13 +128,13 @@ Response Parameters .. rest_parameters:: parameters.yaml - group_snapshots: group_snapshots - - id: group_snapshot_id_1 - - name: name_19 - - status: status_7 - - description: description_16 + - id: group_snapshot_id_req + - name: name_group_snap_req + - status: status_group_snap + - description: description_group_snap_req - created_at: created_at - - group_id: group_id_1 - - group_type_id: group_type_id_2 + - group_id: group_id + - group_type_id: group_type_id Response Example ---------------- @@ -183,8 +183,8 @@ Response Parameters .. rest_parameters:: parameters.yaml - group_snapshots: group_snapshots - - id: group_snapshot_id_1 - - name: name_19 + - id: group_snapshot_id_req + - name: name_group_snap_req Response Example @@ -221,9 +221,9 @@ Request - project_id: project_id_path - group_snapshot: group_snapshot - - name: name_18 - - description: description_14 - - group_id: group_id_1 + - name: name_group_snap + - description: description_group_snap + - group_id: group_id Request Example --------------- @@ -237,9 +237,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - group_snapshot: group_snapshot - - id: group_snapshot_id_1 - - name: name_19 - - group_type_id: group_type_id_2 + - id: group_snapshot_id_req + - name: name_group_snap_req + - group_type_id: group_type_id Response Example ---------------- @@ -274,9 +274,9 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_snapshot_id: group_snapshot_id + - group_snapshot_id: group_snapshot_id_path - reset_status: reset_status - - status: status_7 + - status: status_group_snap Request Example --------------- diff --git a/api-ref/source/v3/group-type-specs.inc b/api-ref/source/v3/group-type-specs.inc index 6cb241c1dc3..47b387c7f49 100644 --- a/api-ref/source/v3/group-type-specs.inc +++ b/api-ref/source/v3/group-type-specs.inc @@ -31,8 +31,8 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_type_id: group_type_id_1 - - group_specs: group_specs_2 + - group_type_id: group_type_id_path + - group_specs: group_specs_req Request Example --------------- @@ -47,7 +47,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - group_specs: group_specs_2 + - group_specs: group_specs_req Response Example @@ -84,7 +84,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_type_id: group_type_id_1 + - group_type_id: group_type_id_path Response Parameters @@ -92,7 +92,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - group_specs: group_specs_2 + - group_specs: group_specs_req Response Example @@ -129,7 +129,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_type_id: group_type_id_1 + - group_type_id: group_type_id_path - spec_id: spec_id @@ -174,7 +174,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_type_id: group_type_id_1 + - group_type_id: group_type_id_path - spec_id: spec_id - spec: spec_value @@ -225,5 +225,5 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_type_id: group_type_id_1 + - group_type_id: group_type_id_path - spec_id: spec_id diff --git a/api-ref/source/v3/group-types.inc b/api-ref/source/v3/group-types.inc index 8fa6ebc9f63..9cbf8fff8f4 100644 --- a/api-ref/source/v3/group-types.inc +++ b/api-ref/source/v3/group-types.inc @@ -35,9 +35,9 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_type_id: group_type_id_1 + - group_type_id: group_type_id_path - group_type: group_type - - name: name_16 + - name: name_group - description: description_group_type_optional - is_public: is_public_group_type_optional @@ -54,11 +54,11 @@ Response Parameters .. rest_parameters:: parameters.yaml - group_type: group_type - - id: group_type_id_2 + - id: group_type_id - is_public: is_public_group_type_required - group_specs: group_specs - description: description_group_type_required - - name: name_16 + - name: name_group_type Response Example ---------------- @@ -91,7 +91,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_type_id: group_type_id_1 + - group_type_id: group_type_id_path Response Parameters @@ -100,8 +100,8 @@ Response Parameters .. rest_parameters:: parameters.yaml - group_type: group_type - - id: group_type_id_2 - - name: name_16 + - id: group_type_id + - name: name_group_type - is_public: is_public_group_type_required - group_specs: group_specs - description: description_group_type_required @@ -147,8 +147,8 @@ Response Parameters .. rest_parameters:: parameters.yaml - group_type: group_type - - id: group_type_id_2 - - name: name_16 + - id: group_type_id + - name: name_group_type - is_public: is_public_group_type_required - group_specs: group_specs - description: description_group_type_required @@ -187,7 +187,7 @@ Request .. rest_parameters:: parameters.yaml - - group_type_id: group_type_id_1 + - group_type_id: group_type_id_path - project_id: project_id_path @@ -224,9 +224,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - group_types: group_types - - id: group_type_id_2 + - id: group_type_id - group_specs: group_specs - - name: name_16 + - name: name_group_type - is_public: is_public_group_type_required - description: description_group_type_required @@ -266,7 +266,7 @@ Request - project_id: project_id_path - group_type: group_type - - name: name_16 + - name: name_group_type - description: description_group_type_optional - is_public: is_public_group_type_optional - group_specs: group_specs @@ -284,11 +284,11 @@ Response Parameters .. rest_parameters:: parameters.yaml - group_type: group_type - - id: group_type_id_2 + - id: group_type_id - is_public: is_public_group_type_required - group_specs: group_specs - description: description_group_type_required - - name: name_16 + - name: name_group_type Response Example diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index 883a4fbdb73..2961ad14d5c 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -95,7 +95,7 @@ Request - group: group - description: description_group_false - availability_zone: availability_zone - - group_type: group_type_id_2 + - group_type: group_type_id - volume_types: volume_types - name: group_name @@ -110,7 +110,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - id: group_id + - id: group_id_path - name: group_name Response Example @@ -144,7 +144,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_id: group_id + - group_id: group_id_path - list_volume: list_volume Response Parameters @@ -153,13 +153,13 @@ Response Parameters .. rest_parameters:: parameters.yaml - group: group - - status: status_8 + - status: status_group - description: description_group_true - availability_zone: availability_zone - created_at: created_at - - group_type: group_type_id_2 - - group_snapshot_id: group_snapshot_id_2 - - source_group_id: source_group_id_2 + - group_type: group_type_id + - group_snapshot_id: group_snapshot_id + - source_group_id: source_group_id - volume_types: volume_types - id: id - name: group_name @@ -202,8 +202,8 @@ Request - project_id: project_id_path - create-from-src: create-from-src - description: description_group_false - - group_snapshot_id: group_snapshot_id_1 - - source_group_id: source_group_id + - group_snapshot_id: group_snapshot_id_req + - source_group_id: source_group_id_req - name: group_name Request Example @@ -217,7 +217,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - id: group_id + - id: group_id_path - name: group_name Response Example @@ -253,7 +253,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_id: group_id + - group_id: group_id_path - delete: delete - delete-volumes: delete-volumes @@ -305,15 +305,15 @@ Response Parameters .. rest_parameters:: parameters.yaml - groups: groups - - status: status_8 + - status: status_group - description: description_group_true - availability_zone: availability_zone - created_at: created_at - - group_type: group_type_id_2 - - group_snapshot_id: group_snapshot_id_2 - - source_group_id: source_group_id_2 + - group_type: group_type_id + - group_snapshot_id: group_snapshot_id + - source_group_id: source_group_id - volume_types: volume_types - - id: group_id + - id: group_id_path - name: name - volumes: volume_ids @@ -350,7 +350,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - group_id: group_id + - group_id: group_id_path - group: group - remove_volumes: remove_volumes - description: description_group_false @@ -390,7 +390,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id - - group_id: group_id + - group_id: group_id_path - reset_status: reset_status - status: status diff --git a/api-ref/source/v3/hosts.inc b/api-ref/source/v3/hosts.inc index da5b83dc2a8..a85950f1756 100644 --- a/api-ref/source/v3/hosts.inc +++ b/api-ref/source/v3/hosts.inc @@ -44,9 +44,9 @@ Response Parameters - hosts: hosts - service-status: service_status - service: host_service - - zone: availability_zone_3 + - zone: availability_zone_required - service-state: service_state - - host_name: host_name_1 + - host_name: host_name_backend - last-update: updated_at Response Example @@ -97,8 +97,8 @@ Response - volume_count: total_count - total_volume_gb: totalGigabytesUsed - total_snapshot_gb: totalSnapGigabytesUsed - - project: project_id_2 - - host: host_name_1 + - project: project_id_host + - host: host_name_backend - snapshot_count: totalSnapshotsUsed Response Example diff --git a/api-ref/source/v3/limits.inc b/api-ref/source/v3/limits.inc index 04c40342eae..4c2db5fd539 100644 --- a/api-ref/source/v3/limits.inc +++ b/api-ref/source/v3/limits.inc @@ -45,7 +45,7 @@ Response Parameters - limits: limits - rate: rate - absolute: absolute - - totalSnapshotsUsed: totalSnapshotsUsed_1 + - totalSnapshotsUsed: totalSnapshotsUsed_int - maxTotalBackups: maxTotalBackups - maxTotalVolumeGigabytes: maxTotalVolumeGigabytes - maxTotalSnapshots: maxTotalSnapshots diff --git a/api-ref/source/v3/messages.inc b/api-ref/source/v3/messages.inc index b80c7fee1c5..9264573b53c 100644 --- a/api-ref/source/v3/messages.inc +++ b/api-ref/source/v3/messages.inc @@ -74,13 +74,13 @@ Response Parameters - message: user_message - request_id: request_id - - links: links_5 + - links: links_message - message_level: message_level - event_id: event_id - created_at: created_at - guaranteed_until: guaranteed_until - resource_uuid: resource_uuid - - id: id_8 + - id: id_message - resource_type: resource_type - user_message: user_message @@ -130,13 +130,13 @@ Response Parameters - messages: user_messages - request_id: request_id - - links: links_5 + - links: links_message - message_level: message_level - event_id: event_id - created_at: created_at - guaranteed_until: guaranteed_until - resource_uuid: resource_uuid - - id: id_8 + - id: id_message - resource_type: resource_type - user_message: user_message diff --git a/api-ref/source/v3/os-cgsnapshots-v3.inc b/api-ref/source/v3/os-cgsnapshots-v3.inc index ffe5bd366fb..8c66e74a178 100644 --- a/api-ref/source/v3/os-cgsnapshots-v3.inc +++ b/api-ref/source/v3/os-cgsnapshots-v3.inc @@ -28,7 +28,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - cgsnapshot_id: cgsnapshot_id_1 + - cgsnapshot_id: cgsnapshot_id_path Show consistency group snapshot detail @@ -52,7 +52,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - cgsnapshot_id: cgsnapshot_id_1 + - cgsnapshot_id: cgsnapshot_id_path Response Parameters @@ -64,9 +64,9 @@ Response Parameters - status: status - description: description_cg_snapshot_true - created_at: created_at - - consistencygroup_id: consistencygroup_id + - consistencygroup_id: consistencygroup_id_required - id: id - - name: name_2 + - name: name_cgsnap Response Example ---------------- @@ -107,9 +107,9 @@ Response Parameters - status: status - description: description_cg_snapshot_true - created_at: created_at - - consistencygroup_id: consistencygroup_id + - consistencygroup_id: consistencygroup_id_required - id: id - - name: name_2 + - name: name_cgsnap Response Example ---------------- @@ -149,7 +149,7 @@ Response Parameters - cgsnapshots: cgsnapshots - id: id - - name: name_2 + - name: name_cgsnap @@ -183,8 +183,8 @@ Request - project_id: project_id_path - cgsnapshot: cgsnapshot - - name: name_5 - - consistencygroup_id: consistencygroup_id + - name: name_snap + - consistencygroup_id: consistencygroup_id_required - description: description_cg_snapshot_false Request Example @@ -201,6 +201,6 @@ Response Parameters - status: status - description: description_cg_snapshot_true - created_at: created_at - - consistencygroup_id: consistencygroup_id + - consistencygroup_id: consistencygroup_id_required - id: id - - name: name_2 + - name: name_cgsnap diff --git a/api-ref/source/v3/os-services.inc b/api-ref/source/v3/os-services.inc index 91f1231add0..e709905aec3 100644 --- a/api-ref/source/v3/os-services.inc +++ b/api-ref/source/v3/os-services.inc @@ -44,16 +44,16 @@ Response Parameters .. rest_parameters:: parameters.yaml - services: services - - binary: binary - - disabled_reason: disabled_reason_body - - host: host_name_body - - state: service_state_1 + - binary: binary_required + - disabled_reason: disabled_reason_body_req + - host: host_name_body_req + - state: service_state_up_down - status: service_status - frozen: frozen - updated_at: updated - - zone: availability_zone_3 - - cluster: cluster - - replication_status: replication_status_1 + - zone: availability_zone_required + - cluster: cluster_cvol + - replication_status: replication_status_cvol - active_backend_id: active_backend_id - backend_state: backend_state @@ -92,8 +92,8 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - host: host_name_body - - binary: binary + - host: host_name_body_req + - binary: binary_required Request Example --------------- @@ -106,11 +106,11 @@ Response Parameters .. rest_parameters:: parameters.yaml - - disabled: disabled_1 + - disabled: disabled_required - status: service_status - - host: host_name_body + - host: host_name_body_req - service: service_key - - binary: binary + - binary: binary_required Response Example ---------------- @@ -148,9 +148,9 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - binary: binary - - host: host_name_body - - disabled_reason: disabled_reason_body_1 + - binary: binary_required + - host: host_name_body_req + - disabled_reason: disabled_reason_body Request Example --------------- @@ -163,12 +163,12 @@ Response .. rest_parameters:: parameters.yaml - - disabled: disabled_1 + - disabled: disabled_required - status: service_status - - host: host_name_body + - host: host_name_body_req - service: service_key - - binary: binary - - disabled_reason: disabled_reason_body + - binary: binary_required + - disabled_reason: disabled_reason_body_req Response Example ---------------- @@ -205,8 +205,8 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - binary: binary - - host: host_name_body + - binary: binary_required + - host: host_name_body_req Request Example --------------- @@ -219,12 +219,12 @@ Response Parameters .. rest_parameters:: parameters.yaml - - disabled: disabled_1 + - disabled: disabled_required - status: service_status - - host: host_name_body + - host: host_name_body_req - service: service_key - - binary: binary - - disabled_reason: disabled_reason_body + - binary: binary_required + - disabled_reason: disabled_reason_body_req Response Example ---------------- @@ -260,8 +260,8 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - binary: binary_1 - - server: host_name_body_1 + - binary: binary + - server: host_name_body - prefix: prefix Request Example @@ -276,8 +276,8 @@ Response Parameters .. rest_parameters:: parameters.yaml - log_levels: log_levels - - binary: binary - - host: host_name_body + - binary: binary_required + - host: host_name_body_req - levels: levels Response Example @@ -314,10 +314,10 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - binary: binary_1 - - server: host_name_body_1 + - binary: binary + - server: host_name_body - prefix: prefix - - levels: levels_1 + - levels: levels_set Request Example --------------- @@ -353,7 +353,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - host: host_name_body + - host: host_name_body_req Request Example --------------- @@ -389,7 +389,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - host: host_name_body + - host: host_name_body_req Request Example --------------- @@ -427,9 +427,9 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - host: host_name_body + - host: host_name_body_req - backend_id: backend_id - - cluster: cluster + - cluster: cluster_cvol Request Example --------------- diff --git a/api-ref/source/v3/os-vol-pool-v3.inc b/api-ref/source/v3/os-vol-pool-v3.inc index 36e80b46170..eb89f4e7579 100644 --- a/api-ref/source/v3/os-vol-pool-v3.inc +++ b/api-ref/source/v3/os-vol-pool-v3.inc @@ -43,7 +43,7 @@ Response Parameters - pools: pools - updated: updated - QoS_support: QoS_support - - name: name_20 + - name: name_backend_pool - total_capacity_gb: total_capacity - volume_backend_name: volume_backend_name - capabilities: capabilities diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 9d85cd76749..d1df5aa6eaf 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -13,13 +13,13 @@ admin_project_id: in: path required: true type: string -attachment_id_1: +attachment_id_path: description: | The ID of the attachment. in: path required: true type: string -backup_id: +backup_id_required: description: | The UUID for a backup. in: path @@ -31,13 +31,13 @@ cascade: in: path required: false type: boolean -cgsnapshot_id_1: +cgsnapshot_id_path: description: | The ID of the consistency group snapshot. in: path required: true type: string -consistencygroup_id_2: +consistencygroup_id_path: description: | The ID of the consistency group. in: path @@ -49,7 +49,7 @@ encryption_id: in: path required: true type: string -force_5: +force_vol_del: description: | Indicates whether to force delete a volume even if the volume is in deleting or error_deleting. Default is ``false``. @@ -57,19 +57,19 @@ force_5: required: false type: boolean min_version: 3.23 -group_id: +group_id_path: description: | The ID of the group. in: path required: true type: string -group_snapshot_id: +group_snapshot_id_path: description: | The ID of the group snapshot. in: path required: true type: string -group_type_id_1: +group_type_id_path: description: | The UUID for an existing group type. in: path @@ -82,36 +82,36 @@ hostname: in: path required: true type: string -key_1: +key_encrypt_spec: + description: | + The key name of the encryption spec for a volume type. + in: path + required: true + type: string +key_extra_spec: + description: | + The key name of the extra spec for a volume type. + in: path + required: true + type: string +key_path: description: | The metadata key name for the metadata that you want to remove. in: path required: true type: string -key_2: - description: | - The metadata key name for the metadata that you - want to see. - in: path - required: true - type: string -key_3: +key_update: description: | The metadata key name for the metadata that you want to update. in: path required: true type: string -key_4: +key_view: description: | - The key name of the extra spec for a volume type. - in: path - required: true - type: string -key_5: - description: | - The key name of the encryption spec for a volume type. + The metadata key name for the metadata that you + want to see. in: path required: true type: string @@ -224,7 +224,7 @@ fix_allocated_quotas: in: query required: false type: boolean -force_3: +force_del_qos: description: | To delete a QoS specification even if it is in- use, set to ``true``. Default is ``false``. @@ -445,13 +445,6 @@ allow_attached_volume: required: true type: boolean attach_mode: - description: | - The attach mode of attachment, read-only ('ro') or - read-and-write ('rw'), default is 'rw'. - in: body - required: true - type: string -attach_mode_1: description: | The attach mode of attachment, acceptable values are read-only ('ro') and read-and-write ('rw'). @@ -459,6 +452,13 @@ attach_mode_1: required: false type: string min_version: 3.54 +attach_mode_required: + description: | + The attach mode of attachment, read-only ('ro') or + read-and-write ('rw'), default is 'rw'. + in: body + required: true + type: string attach_status: description: | The volume attach status. @@ -483,7 +483,7 @@ attachment_id: in: body required: false type: string -attachment_id_2: +attachment_id_required: description: | The ID of attachment. in: body @@ -511,19 +511,19 @@ availability_zone: in: body required: false type: string -availability_zone_3: - description: | - The availability zone name. - in: body - required: true - type: string -availability_zone_4: +availability_zone_backup: description: | The backup availability zone key value pair. in: body required: false type: string min_version: 3.51 +availability_zone_required: + description: | + The availability zone name. + in: body + required: true + type: string backend_id: description: | ID of backend to failover to. Default is ``None``. @@ -562,7 +562,7 @@ backup_gigabytes_usage: in: body required: true type: object -backup_id_1: +backup_id: description: | The UUID of the backup. in: body @@ -612,13 +612,13 @@ binary: description: | The binary name of the service. in: body - required: true + required: false type: string -binary_1: +binary_required: description: | The binary name of the service. in: body - required: false + required: true type: string bootable: description: | @@ -626,15 +626,15 @@ bootable: can boot an instance from a bootable volume. See :ref:`valid boolean values ` in: body - required: true + required: false type: boolean -bootable_1: +bootable_required: description: | Enables or disables the bootable attribute. You can boot an instance from a bootable volume. See :ref:`valid boolean values ` in: body - required: false + required: true type: boolean bootable_response: description: | @@ -682,19 +682,13 @@ cipher: in: body required: false type: string -cluster: +cluster_cvol: description: | The cluster name. Only in ``cinder-volume`` service. in: body required: false type: string min_version: 3.7 -cluster_1: - description: | - The cluster name. - in: body - required: false - type: string cluster_mutex: description: | The OpenStack Block Storage cluster where the resource resides. Optional @@ -714,7 +708,7 @@ connector: in: body required: false type: object -connector_1: +connector_required: description: | The ``connector`` object. The internal structure of connector depends on the volume driver implementation. For details about the required elements @@ -738,13 +732,13 @@ consistencygroup_id: description: | The UUID of the consistency group. in: body - required: true + required: false type: string -consistencygroup_id_1: +consistencygroup_id_required: description: | The UUID of the consistency group. in: body - required: false + required: true type: string consistencygroups: description: | @@ -758,12 +752,6 @@ consumer: in: body required: false type: string -consumer_1: - description: | - The consumer type. - in: body - required: true - type: string container: description: | The container name or null. @@ -814,12 +802,6 @@ created_at: in: body required: true type: string -created_at_1: - description: | - Date and time when the volume was created. - in: body - required: true - type: string data_timestamp: description: | The time when the data on the volume was first saved. If it is @@ -876,71 +858,16 @@ description: in: body required: false type: string -description_10: +description_cap: description: | The capabilities description. in: body required: true type: string -description_11: +description_cg: description: | The consistency group description. in: body - required: false - type: string -description_13: - description: | - The group description. - in: body - required: false - type: string -description_14: - description: | - The group snapshot description. - in: body - required: false - type: string -description_16: - description: | - The group snapshot description. - in: body - required: true - type: string -description_4: - description: | - A description for the snapshot. Default is - ``None``. - in: body - required: false - type: string -description_5: - description: | - The volume description. - in: body - required: false - type: string -description_6: - description: | - The consistency group description. - in: body - required: true - type: string -description_7: - description: | - The extension description. - in: body - required: true - type: string -description_8: - description: | - A description for the snapshot. - in: body - required: true - type: string -description_9: - description: | - The volume description. - in: body required: true type: string description_cg_snapshot_false: @@ -955,12 +882,36 @@ description_cg_snapshot_true: in: body required: true type: string +description_consis: + description: | + The consistency group description. + in: body + required: false + type: string +description_extn: + description: | + The extension description. + in: body + required: true + type: string description_group_false: description: | The group description. in: body required: false type: string +description_group_snap: + description: | + The group snapshot description. + in: body + required: false + type: string +description_group_snap_req: + description: | + The group snapshot description. + in: body + required: true + type: string description_group_true: description: | The group description. @@ -979,6 +930,31 @@ description_group_type_required: in: body required: true type: string +description_snap: + description: | + A description for the snapshot. Default is + ``None``. + in: body + required: false + type: string +description_snap_req: + description: | + A description for the snapshot. + in: body + required: true + type: string +description_vol: + description: | + The volume description. + in: body + required: false + type: string +description_vol_req: + description: | + The volume description. + in: body + required: true + type: string description_volume_type_optional: description: | The volume type description. @@ -1004,24 +980,24 @@ disabled: in: body required: false type: boolean -disabled_1: - description: | - The service is disabled or not. - in: body - required: true - type: boolean disabled_reason_body: - description: | - The reason for disabling a service. - in: body - required: true - type: string -disabled_reason_body_1: description: | The reason for disabling a service. in: body required: false type: string +disabled_reason_body_req: + description: | + The reason for disabling a service. + in: body + required: true + type: string +disabled_required: + description: | + The service is disabled or not. + in: body + required: true + type: boolean disk_format: description: | Disk format for the new image. Default is raw. @@ -1102,21 +1078,7 @@ force: in: body required: false type: boolean -force_1: - description: | - Indicates whether to snapshot, even if the volume - is attached. Default is ``false``. - in: body - required: false - type: boolean -force_2: - description: | - If set to ``true``, forces deletion of a - consistency group that has a registered volume. - in: body - required: false - type: boolean -force_4: +force_upload_vol: description: | Enables or disables upload of a volume that is attached to an instance. Default=False. @@ -1174,7 +1136,7 @@ group: in: body required: true type: object -group_id_1: +group_id: description: | The ID of the group. in: body @@ -1198,18 +1160,18 @@ group_snapshot: in: body required: true type: object -group_snapshot_id_1: - description: | - The ID of the group snapshot. - in: body - required: true - type: string -group_snapshot_id_2: +group_snapshot_id: description: | The ID of the group snapshot. in: body required: false type: string +group_snapshot_id_req: + description: | + The ID of the group snapshot. + in: body + required: true + type: string group_snapshots: description: | A collection of group snapshots. @@ -1223,7 +1185,7 @@ group_specs: in: body required: false type: object -group_specs_2: +group_specs_req: description: | A set of key and value pairs that contains the specifications for a group type. @@ -1236,7 +1198,7 @@ group_type: in: body required: true type: object -group_type_id_2: +group_type_id: description: | The group type ID. in: body @@ -1302,7 +1264,7 @@ host_name: in: body required: false type: string -host_name_1: +host_name_backend: description: | The name of the host that hosts the storage backend. in: body @@ -1312,13 +1274,13 @@ host_name_body: description: | The name of the host. in: body - required: true + required: false type: string -host_name_body_1: +host_name_body_req: description: | The name of the host. in: body - required: false + required: true type: string host_service: description: | @@ -1338,54 +1300,36 @@ id: in: body required: true type: string -id_1: +id_backup: description: | The UUID of the backup. in: body required: true type: string -id_2: +id_message: description: | - The UUID of the consistency group snapshot. + The UUID for the message. in: body required: true type: string -id_3: +id_qos_spec: description: | The generated ID for the QoS specification. in: body required: true type: string -id_4: +id_snap: description: | The snapshot UUID. in: body required: true type: string -id_5: +id_vol: description: | The UUID of the volume. in: body required: true type: string -id_6: - description: | - The UUID of the consistency group. - in: body - required: true - type: string -id_7: - description: | - The ID for the quota set. - in: body - required: true - type: integer -id_8: - description: | - The UUID for the message. - in: body - required: true - type: string image_id: description: | The uuid for the new image. @@ -1419,7 +1363,7 @@ instance_uuid: in: body required: false type: string -instance_uuid_1: +instance_uuid_req: description: | The UUID of the attaching instance. in: body @@ -1493,7 +1437,7 @@ levels: in: body required: true type: object -levels_1: +levels_set: description: | The log level to set, case insensitive, accepted values are ``INFO``, ``WARNING``, ``ERROR`` and ``DEBUG``. @@ -1519,48 +1463,42 @@ links: in: body required: true type: array -links_1: +links_backup: description: | Links for the backup. in: body required: true type: array -links_2: - description: | - The QoS specification links. - in: body - required: true - type: array -links_3: - description: | - The volume links. - in: body - required: true - type: array -links_4: - description: | - List of links related to the extension. - in: body - required: true - type: array -links_5: +links_message: description: | Links for the message. in: body required: false type: array -links_6: +links_qos: + description: | + The QoS specification links. + in: body + required: true + type: array +links_res: description: | Links to the resources in question. in: body required: true type: array -links_7: +links_snap: description: | Links for the snapshot. in: body required: false type: array +links_vol: + description: | + The volume links. + in: body + required: true + type: array location: description: | Full URL to a service or server. @@ -1667,7 +1605,7 @@ meta: in: body required: true type: object -meta_1: +meta_snap: description: | The metadata key and value pair for the snapshot. in: body @@ -1680,75 +1618,55 @@ metadata: in: body required: true type: object -metadata_1: - description: | - A ``metadata`` object. Contains one or more - metadata key and value pairs that are associated with the volume. - in: body - required: true - type: object -metadata_10: - description: | - One or more metadata key and value pairs to be associated - with the new volume. - in: body - required: false - type: object -metadata_2: - description: | - One or more metadata key and value pairs that are - associated with the volume. - in: body - required: false - type: object -metadata_3: - description: | - One or more metadata key and value pairs that are - associated with the volume. - in: body - required: true - type: object -metadata_4: - description: | - One or more metadata key and value pairs to - associate with the volume. - in: body - required: false - type: string -metadata_5: - description: | - The image metadata to add to the volume as a set - of metadata key and value pairs. - in: body - required: true - type: object -metadata_6: - description: | - One or more metadata key and value pairs to - associate with the volume. - in: body - required: false - type: object -metadata_7: - description: | - One or more metadata key and value pairs for the - snapshot. - in: body - required: false - type: object -metadata_8: - description: | - The image metadata key value pairs. - in: body - required: true - type: object -metadata_9: +metadata_backup: description: | The backup metadata key value pairs. in: body required: false type: object min_version: 3.43 +metadata_image: + description: | + The image metadata to add to the volume as a set + of metadata key and value pairs. + in: body + required: true + type: object +metadata_snap: + description: | + One or more metadata key and value pairs for the + snapshot. + in: body + required: false + type: object +metadata_vol: + description: | + One or more metadata key and value pairs to be associated + with the new volume. + in: body + required: false + type: object +metadata_vol_assoc: + description: | + One or more metadata key and value pairs that are + associated with the volume. + in: body + required: false + type: object +metadata_vol_assoc_req: + description: | + One or more metadata key and value pairs that are + associated with the volume. + in: body + required: true + type: object +metadata_vol_obj: + description: | + A ``metadata`` object. Contains one or more + metadata key and value pairs that are associated with the volume. + in: body + required: true + type: object migrate_cluster: description: | The target cluster for the volume migration. Cluster format is @@ -1803,13 +1721,13 @@ migration_status: description: | The volume migration status. in: body - required: true + required: false type: string -migration_status_1: +migration_status_req: description: | The volume migration status. in: body - required: false + required: true type: string mountpoint: description: | @@ -1839,114 +1757,52 @@ name: in: body required: true type: string -name_1: - description: | - The backup name. - in: body - required: true - type: string -name_10: - description: | - The name of the extension. For example, "Fox In - Socks." - in: body - required: true - type: string -name_11: - description: | - The name of the back-end volume. - in: body - required: true - type: string -name_12: - description: | - The name of the snapshot. - in: body - required: true - type: string -name_13: - description: | - The volume name. - in: body - required: true - type: string -name_14: - description: | - The name of the volume to which you want to - restore a backup. - in: body - required: false - type: string -name_15: - description: | - The consistency group name. - in: body - required: false - type: string -name_16: - description: | - The group type name. - in: body - required: true - type: string -name_17: - description: | - The group name. - in: body - required: false - type: string -name_18: - description: | - The group snapshot name. - in: body - required: false - type: string -name_19: - description: | - The group snapshot name. - in: body - required: true - type: string -name_2: - description: | - The consistency group snapshot name. - in: body - required: true - type: string -name_20: +name_backend_pool: description: | The name of the backend pool. in: body required: true type: string -name_3: +name_backup: description: | - The name of the consistency group. + The backup name. in: body required: true type: string -name_4: +name_cgsnap: description: | - The name of the QoS specification. + The consistency group snapshot name. in: body required: true type: string -name_5: - description: | - The name of the snapshot. Default is ``None``. - in: body - required: false - type: string -name_6: - description: | - The volume transfer name. - in: body - required: false - type: string -name_9: +name_consis: description: | The consistency group name. in: body + required: false + type: string +name_group: + description: | + The group name. + in: body + required: false + type: string +name_group_snap: + description: | + The group snapshot name. + in: body + required: false + type: string +name_group_snap_req: + description: | + The group snapshot name. + in: body + required: true + type: string +name_group_type: + description: | + The group type name. + in: body required: true type: string name_optional: @@ -1955,6 +1811,30 @@ name_optional: in: body required: false type: string +name_qos_spec: + description: | + The name of the QoS specification. + in: body + required: true + type: string +name_snap: + description: | + The name of the snapshot. Default is ``None``. + in: body + required: false + type: string +name_snap_req: + description: | + The name of the snapshot. + in: body + required: true + type: string +name_vol: + description: | + The volume name. + in: body + required: true + type: string name_volume_type_optional: description: | The name of the volume type. @@ -1973,7 +1853,7 @@ namespace: in: body required: false type: string -namespace_1: +namespace_storage: description: | The storage namespace, such as ``OS::Storage::Capabilities::foo``. @@ -2016,9 +1896,6 @@ os-backup-project-attr:project_id: The UUID of the owning project. in: body required: true - type: string. - in: body - required: true type: string min_version: 3.18 os-begin_detaching: @@ -2245,13 +2122,7 @@ project_id: in: body required: true type: string -project_id_1: - description: | - The Project ID having access to this volume type. - in: body - required: true - type: string -project_id_2: +project_id_host: description: | The Project ID which the host resource belongs to. In the summary resource, the value is ``(total)``. @@ -2381,15 +2252,6 @@ ref: in: body required: true type: object -ref_1: - description: | - A reference to the existing volume. The internal - structure of this reference is dependent on the implementation of - the volume driver, see the specific driver's documentation for - details of the required elements in the structure. - in: body - required: true - type: object reference: description: | Some information for the resource. @@ -2415,7 +2277,7 @@ replication_status: in: body required: true type: string -replication_status_1: +replication_status_cvol: description: | The volume service replication status. Only in ``cinder-volume`` service. in: body @@ -2452,7 +2314,7 @@ reset_status: in: body required: true type: object -resource_1: +resource_fil: description: | Resource which the filters will be applied to. in: body @@ -2464,7 +2326,7 @@ resource_filters: in: body required: true type: array -resource_filters_1: +resource_filters_coll: description: | A collection of resource filters. in: body @@ -2540,7 +2402,7 @@ service_state: in: body required: true type: string -service_state_1: +service_state_up_down: description: | The state of the service. One of ``up`` or ``down``. in: body @@ -2585,12 +2447,6 @@ snapshot: in: body required: true type: string -snapshot_1: - description: | - A ``snapshot`` object. - in: body - required: true - type: object snapshot_id: description: | To create a volume from an existing snapshot, @@ -2599,25 +2455,31 @@ snapshot_id: in: body required: false type: string -snapshot_id_2: - description: | - The UUID of the source volume snapshot. - in: body - required: false - type: string -snapshot_id_3: +snapshot_id_backup: description: | The UUID of the source snapshot that you want to back up. in: body required: false type: string -snapshot_id_4: +snapshot_id_revert: description: | The UUID of the snapshot. The API reverts the volume with this snapshot. in: body required: true type: string +snapshot_id_source_vol: + description: | + The UUID of the source volume snapshot. + in: body + required: false + type: string +snapshot_obj: + description: | + A ``snapshot`` object. + in: body + required: true + type: object snapshot_progress: description: | A percentage value for snapshot build progress. @@ -2669,13 +2531,13 @@ source_group_id: description: | The UUID of the source group. in: body - required: true + required: false type: string -source_group_id_2: +source_group_id_req: description: | The UUID of the source group. in: body - required: false + required: true type: string source_reference: description: | @@ -2702,64 +2564,58 @@ specs: in: body required: true type: object -specs_2: - description: | - Specification key and value pairs. - in: body - required: true - type: string status: description: | The ``status`` of the consistency group snapshot. in: body required: false type: string -status_1: +status_attachment: description: | - The status of the consistency group. + The status of the attachment. in: body required: true type: string -status_10: - description: | - The status for the backup. - in: body - required: true - type: string -status_2: - description: | - The status for the snapshot. - in: body - required: true - type: string -status_3: - description: | - The volume status. - in: body - required: true - type: string -status_4: +status_backup: description: | The backup status. Refer to Backup statuses table for the possible status value. in: body required: true type: string -status_7: +status_backup_action: description: | - The ``status`` of the generic group snapshot. + The status for the backup. in: body required: true type: string -status_8: +status_consis: + description: | + The status of the consistency group. + in: body + required: true + type: string +status_group: description: | The status of the generic group. in: body required: true type: string -status_9: +status_group_snap: description: | - The status of the attachment. + The ``status`` of the generic group snapshot. + in: body + required: true + type: string +status_snap: + description: | + The status for the snapshot. + in: body + required: true + type: string +status_vol: + description: | + The volume status. in: body required: true type: string @@ -2828,7 +2684,7 @@ totalSnapshotsUsed: in: body required: true type: string -totalSnapshotsUsed_1: +totalSnapshotsUsed_int: description: | The total number of snapshots used. in: body @@ -2859,13 +2715,6 @@ updated: in: body required: true type: string -updated_1: - description: | - The date and time stamp when the API request was - issued. - in: body - required: true - type: string updated_at: description: | The date and time when the resource was updated. @@ -2893,7 +2742,7 @@ user_id: in: body required: true type: string -user_id_2: +user_id_min: description: | The UUID of the user. in: body @@ -2962,7 +2811,7 @@ visibility: in: body required: true type: string -visibility_1: +visibility_min: description: | The visibility property of the new image. Default is private. in: body @@ -2981,12 +2830,6 @@ volume-summary: in: body required: true type: object -volume_1: - description: | - A ``volume`` object. - in: body - required: true - type: string volume_backend_name: description: | The name of the back-end volume. @@ -2999,44 +2842,30 @@ volume_id: in: body required: true type: string -volume_id_2: +volume_id_attachment: + description: | + The UUID of the volume which the attachment belongs + to. + in: body + required: true + type: string +volume_id_backup: description: | The UUID of the volume that you want to back up. in: body required: true type: string -volume_id_3: - description: | - To create a snapshot from an existing volume, - specify the UUID of the existing volume. - in: body - required: true - type: string -volume_id_4: - description: | - The UUID of the volume from which the backup was - created. - in: body - required: true - type: string -volume_id_5: - description: | - If the snapshot was created from a volume, the - volume ID. - in: body - required: true - type: string -volume_id_6: +volume_id_restore: description: | The UUID of the volume to which you want to restore a backup. in: body required: false type: string -volume_id_7: +volume_id_snap: description: | - The UUID of the volume which the attachment belongs - to. + If the snapshot was created from a volume, the + volume ID. in: body required: true type: string @@ -3068,18 +2897,18 @@ volume_name_optional: required: false type: string volume_type: - description: | - The ID of Volume Type to be accessed by project. - in: body - required: false - type: string -volume_type_1: description: | A ``volume_type`` object. in: body required: true type: object -volume_type_2: +volume_type_access: + description: | + The object contains volume type to be accessed by project. + in: body + required: true + type: object +volume_type_detail: description: | The volume type (either name or ID). To create an environment with multiple-storage back ends, you must specify a volume type. Block @@ -3096,47 +2925,18 @@ volume_type_2: in: body required: false type: string -volume_type_3: - description: | - The volume type. In an environment with multiple- - storage back ends, the scheduler determines where to send the - volume based on the volume type. For information about how to use - volume types to create multiple- storage back ends, see `Configure - multiple-storage back ends `_. - in: body - required: true - type: string -volume_type_4: - description: | - The associated volume type. - in: body - required: false - type: string -volume_type_5: - description: | - A list of ``volume_type`` objects. - in: body - required: true - type: array -volume_type_6: - description: | - The associated volume type for the volume. - in: body - required: true - type: string -volume_type_access: - description: | - The object contains volume type to be accessed by project. - in: body - required: true - type: object volume_type_id_body: description: | The UUID of the volume type. in: body required: true type: string +volume_type_vol: + description: | + The associated volume type for the volume. + in: body + required: true + type: string volume_types: description: | The list of volume types. In an environment with @@ -3149,7 +2949,7 @@ volume_types: in: body required: true type: array -volume_types_2: +volume_types_commas: description: | The list of volume types separated by commas. In an environment with multiple-storage back ends, the scheduler determines where to send diff --git a/api-ref/source/v3/qos-specs-v3-qos-specs.inc b/api-ref/source/v3/qos-specs-v3-qos-specs.inc index 00ffdcf6af4..5bbdb09b44b 100644 --- a/api-ref/source/v3/qos-specs-v3-qos-specs.inc +++ b/api-ref/source/v3/qos-specs-v3-qos-specs.inc @@ -202,9 +202,9 @@ Response Parameters - qos_specs: qos_specs - specs: specs - consumer: consumer - - name: name_4 - - id: id_3 - - links: links_2 + - name: name_qos_spec + - id: id_qos_spec + - links: links_qos Response Example @@ -281,7 +281,7 @@ Request - project_id: project_id_path - qos_id: qos_id - - force: force_3 + - force: force_del_qos Create a QoS specification @@ -309,7 +309,7 @@ Request - project_id: project_id_path - qos_specs: qos_specs - - name: name_4 + - name: name_qos_spec Request Example --------------- @@ -324,9 +324,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - qos_specs: qos_specs - - name: name_4 - - links: links_2 - - id: id_3 + - name: name_qos_spec + - links: links_qos + - id: id_qos_spec - consumer: consumer - specs: specs @@ -377,8 +377,8 @@ Response Parameters - qos_specs: qos_specs - specs: specs - consumer: consumer - - id: id_3 - - name: name_4 + - id: id_qos_spec + - name: name_qos_spec Response Example diff --git a/api-ref/source/v3/resource-filters.inc b/api-ref/source/v3/resource-filters.inc index dd842b16e1c..b045d54fcf4 100644 --- a/api-ref/source/v3/resource-filters.inc +++ b/api-ref/source/v3/resource-filters.inc @@ -35,9 +35,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - - resource_filters: resource_filters_1 + - resource_filters: resource_filters_coll - filters: resource_filters - - resource: resource_1 + - resource: resource_fil Response Example ---------------- diff --git a/api-ref/source/v3/snapshot-manage.inc b/api-ref/source/v3/snapshot-manage.inc index b7764e96d4a..d407d89d833 100644 --- a/api-ref/source/v3/snapshot-manage.inc +++ b/api-ref/source/v3/snapshot-manage.inc @@ -39,10 +39,10 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - snapshot: snapshot_1 - - description: description_4 - - metadata: metadata_7 - - name: name_5 + - snapshot: snapshot_obj + - description: description_snap + - metadata: metadata_snap + - name: name_snap - ref: ref - volume_id: volume_id @@ -58,14 +58,14 @@ Response .. rest_parameters:: parameters.yaml - - snapshot: snapshot_1 - - status: status_2 + - snapshot: snapshot_obj + - status: status_snap - size: size - - metadata: metadata_7 - - name: name_5 + - metadata: metadata_snap + - name: name_snap - volume_id: volume_id - created_at: created_at - - description: description_8 + - description: description_snap_req - id: id - updated_at: updated_at diff --git a/api-ref/source/v3/volume-manage.inc b/api-ref/source/v3/volume-manage.inc index cced4767e51..bddfb1a15b4 100644 --- a/api-ref/source/v3/volume-manage.inc +++ b/api-ref/source/v3/volume-manage.inc @@ -43,15 +43,15 @@ Request - project_id: project_id_path - volume: volume - - description: description_5 + - description: description_vol - availability_zone: availability_zone - - bootable: bootable_1 + - bootable: bootable_required - volume_type: volume_type - name: volume_name_optional - host: host_mutex - cluster: cluster_mutex - ref: ref - - metadata: metadata_10 + - metadata: metadata_vol Request Example --------------- @@ -69,26 +69,26 @@ Response .. rest_parameters:: parameters.yaml - volume: volume - - status: status_3 - - migration_status: migration_status + - status: status_vol + - migration_status: migration_status_req - user_id: user_id - attachments: attachments - - links: links_3 + - links: links_vol - availability_zone: availability_zone - bootable: bootable_response - encrypted: encrypted - created_at: created_at - - description: description_5 + - description: description_vol - updated_at: updated_at - volume_type: volume_type - - name: name_13 + - name: name_vol - replication_status: replication_status - - consistencygroup_id: consistencygroup_id + - consistencygroup_id: consistencygroup_id_required - source_volid: source_volid - snapshot_id: snapshot_id - multiattach: multiattach_resp - - metadata: metadata_1 - - id: id_5 + - metadata: metadata_vol_obj + - id: id_vol - size: size Response Example diff --git a/api-ref/source/v3/volumes-v3-extensions.inc b/api-ref/source/v3/volumes-v3-extensions.inc index 14082f88787..e90e348cea1 100644 --- a/api-ref/source/v3/volumes-v3-extensions.inc +++ b/api-ref/source/v3/volumes-v3-extensions.inc @@ -39,7 +39,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - updated: updated_at - - description: description_7 + - description: description_extn - links: links - namespace: namespace - alias: alias diff --git a/api-ref/source/v3/volumes-v3-snapshots-actions.inc b/api-ref/source/v3/volumes-v3-snapshots-actions.inc index 4ba975ab7ce..4665e9f5f36 100644 --- a/api-ref/source/v3/volumes-v3-snapshots-actions.inc +++ b/api-ref/source/v3/volumes-v3-snapshots-actions.inc @@ -30,7 +30,7 @@ Request - project_id: project_id_path - snapshot_id: snapshot_id_path - os-reset_status: os-reset_status - - status: status_2 + - status: status_snap Request Example --------------- @@ -63,7 +63,7 @@ Request - project_id: project_id_path - snapshot_id: snapshot_id_path - os-update_snapshot_status: os-update_snapshot_status - - status: status_2 + - status: status_snap - progress: snapshot_progress Request Example diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index 076b96e409e..c9ed2ba9310 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -74,20 +74,20 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status_2 + - status: status_snap - os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress - - description: description_8 + - description: description_snap_req - created_at: created_at - name: name - - user_id: user_id_2 - - volume_id: volume_id_5 + - user_id: user_id_min + - volume_id: volume_id_snap - os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id - size: size - - id: id_4 + - id: id_snap - metadata: metadata - count: count - updated_at: updated_at - - snapshots_links: links_7 + - snapshots_links: links_snap Response Example ---------------- @@ -118,12 +118,12 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - snapshot: snapshot_1 + - snapshot: snapshot_obj - volume_id: volume_id - - name: name_12 - - description: description_4 + - name: name_snap_req + - description: description_snap - force: force - - metadata: metadata_7 + - metadata: metadata_snap Request Example --------------- @@ -136,15 +136,15 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status_2 - - description: description_8 + - status: status_snap + - description: description_snap_req - created_at: created_at - - name: name_12 - - snapshot: snapshot_1 - - user_id: user_id_2 - - volume_id: volume_id_5 + - name: name_snap_req + - snapshot: snapshot_obj + - user_id: user_id_min + - volume_id: volume_id_snap - metadata: metadata - - id: id_4 + - id: id_snap - size: size - updated_at: updated_at @@ -195,18 +195,18 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status_2 - - description: description_8 + - status: status_snap + - description: description_snap_req - created_at: created_at - name: name - - user_id: user_id_2 - - volume_id: volume_id_5 + - user_id: user_id_min + - volume_id: volume_id_snap - metadata: metadata - - id: id_4 + - id: id_snap - size: size - count: count - updated_at: updated_at - - snapshots_links: links_7 + - snapshots_links: links_snap Response Example ---------------- @@ -373,17 +373,17 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status_2 + - status: status_snap - os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress - - description: description_8 + - description: description_snap_req - created_at: created_at - name: name - - snapshot: snapshot_1 - - user_id: user_id_2 - - volume_id: volume_id_5 + - snapshot: snapshot_obj + - user_id: user_id_min + - volume_id: volume_id_snap - os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id - size: size - - id: id_4 + - id: id_snap - metadata: metadata - updated_at: updated_at @@ -416,8 +416,8 @@ Request - project_id: project_id_path - snapshot_id: snapshot_id_path - - snapshot: snapshot_1 - - description: description_4 + - snapshot: snapshot_obj + - description: description_snap - name: name Request Example @@ -433,15 +433,15 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status_2 - - description: description_8 + - status: status_snap + - description: description_snap_req - created_at: created_at - name: name - - snapshot: snapshot_1 - - id: id_4 + - snapshot: snapshot_obj + - id: id_snap - size: size - - volume_id: volume_id_5 - - user_id: user_id_2 + - volume_id: volume_id_snap + - user_id: user_id_min - metadata: metadata Response Example @@ -507,7 +507,7 @@ Request - project_id: project_id_path - snapshot_id: snapshot_id_path - - key: key_2 + - key: key_view Response Parameters @@ -515,7 +515,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - meta: meta_1 + - meta: meta_snap Response Example ---------------- @@ -547,7 +547,7 @@ Request - project_id: project_id_path - snapshot_id: snapshot_id_path - - key: key_1 + - key: key_path Update a snapshot's metadata for a specific key @@ -572,8 +572,8 @@ Request - project_id: project_id_path - snapshot_id: snapshot_id_path - - key: key_3 - - meta: meta_1 + - key: key_update + - meta: meta_snap Request Example --------------- @@ -586,7 +586,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - meta: meta_1 + - meta: meta_snap Response Example ---------------- diff --git a/api-ref/source/v3/volumes-v3-types.inc b/api-ref/source/v3/volumes-v3-types.inc index 068005dcce5..4b06ff900b6 100644 --- a/api-ref/source/v3/volumes-v3-types.inc +++ b/api-ref/source/v3/volumes-v3-types.inc @@ -39,7 +39,7 @@ Request - project_id: project_id_path - volume_type_id: volume_type_id - - volume_type: volume_type_1 + - volume_type: volume_type - name: name_volume_type_optional - description: description_volume_type_optional - is_public: is_public_volume_type_optional @@ -56,7 +56,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - volume_type: volume_type_1 + - volume_type: volume_type - is_public: is_public_volume_type_required - extra_specs: extra_specs_volume_type_optional - description: description_volume_type_required @@ -176,7 +176,7 @@ Request - project_id: project_id_path - volume_type_id: volume_type_id - - key: key_4 + - key: key_extra_spec Response Example @@ -208,7 +208,7 @@ Request - project_id: project_id_path - volume_type_id: volume_type_id - - key: key_4 + - key: key_extra_spec Request Example --------------- @@ -246,7 +246,7 @@ Request - project_id: project_id_path - volume_type_id: volume_type_id - - key: key_4 + - key: key_extra_spec Show volume type detail @@ -277,7 +277,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - volume_type: volume_type_1 + - volume_type: volume_type - is_public: is_public_volume_type_required - extra_specs: extra_specs_volume_type_optional - description: description_volume_type_required @@ -321,7 +321,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - volume_type: volume_type_1 + - volume_type: volume_type - is_public: is_public_volume_type_required - extra_specs: extra_specs_volume_type_optional - description: description_volume_type_required @@ -429,7 +429,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - volume_type: volume_type_1 + - volume_type: volume_type - name: name_volume_type_required - os-volume-type-access:is_public: is_public_volume_type_optional - description: description_volume_type_optional @@ -447,7 +447,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - volume_type: volume_type_1 + - volume_type: volume_type - is_public: is_public_volume_type_required - extra_specs: extra_specs_volume_type_optional - description: description_volume_type_required @@ -531,7 +531,7 @@ Request - project_id: project_id_path - volume_type_id: volume_type_id - - key: key_5 + - key: key_encrypt_spec Response Example ---------------- diff --git a/api-ref/source/v3/volumes-v3-versions.inc b/api-ref/source/v3/volumes-v3-versions.inc index d7d6cf0651c..2de89584b46 100644 --- a/api-ref/source/v3/volumes-v3-versions.inc +++ b/api-ref/source/v3/volumes-v3-versions.inc @@ -33,7 +33,7 @@ Response Parameters - status: version_status - updated: version_updated - - links: links_6 + - links: links_res - min_version: version_min - version: version_max - media-types: media_types diff --git a/api-ref/source/v3/volumes-v3-volumes-actions.inc b/api-ref/source/v3/volumes-v3-volumes-actions.inc index 0d9d6d6e13f..09cc39605c7 100644 --- a/api-ref/source/v3/volumes-v3-volumes-actions.inc +++ b/api-ref/source/v3/volumes-v3-volumes-actions.inc @@ -101,8 +101,8 @@ Request - project_id: project_id_path - volume_id: volume_id_path - os-reset_status: os-reset_status - - status: status_3 - - migration_status: migration_status_1 + - status: status_vol + - migration_status: migration_status - attach_status: attach_status Request Example @@ -144,7 +144,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - revert: revert - - snapshot_id: snapshot_id_4 + - snapshot_id: snapshot_id_revert Request Example --------------- @@ -176,7 +176,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - os-set_image_metadata: os-set_image_metadata - - metadata: metadata_5 + - metadata: metadata_image Request Example --------------- @@ -254,7 +254,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - metadata: metadata_5 + - metadata: metadata_image Response Example ---------------- @@ -587,7 +587,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - os-set_bootable: os-set_bootable - - bootable: bootable + - bootable: bootable_required Request Example --------------- @@ -620,10 +620,10 @@ Request - volume_id: volume_id_path - os-volume_upload_image: os-volume_upload_image - image_name: image_name - - force: force_4 + - force: force_upload_vol - disk_format: disk_format - container_format: container_format - - visibility: visibility_1 + - visibility: visibility_min - protected: protected Request Example @@ -638,18 +638,18 @@ Response Parameters .. rest_parameters:: parameters.yaml - os-volume_upload_image: os-volume_upload_image - - status: status_3 + - status: status_vol - image_name: image_name - disk_format: disk_format - container_format: container_format - - visibility: visibility_1 + - visibility: visibility_min - protected: protected - updated_at: updated_at - image_id: image_id - - display_description: description_9 - - id: id_5 + - display_description: description_vol_req + - id: id_vol - size: size - - volume_type: volume_type_6 + - volume_type: volume_type_vol Response Example diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index d09aee47a17..6e13758ed07 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -101,33 +101,33 @@ Response Parameters .. rest_parameters:: parameters.yaml - - migration_status: migration_status + - migration_status: migration_status_req - attachments: attachments - - links: links_3 + - links: links_vol - availability_zone: availability_zone - os-vol-host-attr:host: os-vol-host-attr:host - encrypted: encrypted - updated_at: updated_at - replication_status: replication_status - snapshot_id: snapshot_id - - id: id_5 + - id: id_vol - size: size - user_id: user_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 - - metadata: metadata_1 - - status: status_3 + - metadata: metadata_vol_obj + - status: status_vol - volume_image_metadata: volume_image_metadata - - description: description_9 + - description: description_vol_req - multiattach: multiattach_resp - 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 - - name: name_13 + - name: name_vol - bootable: bootable_response - created_at: created_at - volumes: volumes - - volume_type: volume_type_6 + - volume_type: volume_type_vol - count: count @@ -195,15 +195,15 @@ Request - size: size - availability_zone: availability_zone - source_volid: source_volid - - description: description_5 + - description: description_vol - multiattach: multiattach_req - snapshot_id: snapshot_id - - backup_id: backup_id_1 + - backup_id: backup_id - name: volume_name_optional - imageRef: imageRef - - volume_type: volume_type_2 - - metadata: metadata_10 - - consistencygroup_id: consistencygroup_id + - volume_type: volume_type_detail + - metadata: metadata_vol + - consistencygroup_id: consistencygroup_id_required - OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints Request Example @@ -219,28 +219,28 @@ Response Parameters .. rest_parameters:: parameters.yaml - - migration_status: migration_status + - migration_status: migration_status_req - attachments: attachments - - links: links_3 + - links: links_vol - availability_zone: availability_zone - encrypted: encrypted - updated_at: updated_at - replication_status: replication_status - snapshot_id: snapshot_id - - id: id_5 + - id: id_vol - size: size - user_id: user_id - - metadata: metadata_1 - - status: status_3 - - description: description_9 + - metadata: metadata_vol_obj + - status: status_vol + - description: description_vol_req - multiattach: multiattach_resp - source_volid: source_volid - volume: volume - - consistencygroup_id: consistencygroup_id - - name: name_13 + - consistencygroup_id: consistencygroup_id_required + - name: name_vol - bootable: bootable_response - created_at: created_at - - volume_type: volume_type_6 + - volume_type: volume_type_vol Response Example ---------------- @@ -291,9 +291,9 @@ Response Parameters .. rest_parameters:: parameters.yaml - volumes: volumes - - id: id_5 - - links: links_3 - - name: name_13 + - id: id_vol + - links: links_vol + - name: name_vol - count: count @@ -340,33 +340,33 @@ Response Parameters .. rest_parameters:: parameters.yaml - - migration_status: migration_status + - migration_status: migration_status_req - attachments: attachments - - links: links_3 + - links: links_vol - availability_zone: availability_zone - os-vol-host-attr:host: os-vol-host-attr:host - encrypted: encrypted - updated_at: updated_at - replication_status: replication_status - snapshot_id: snapshot_id - - id: id_5 + - id: id_vol - size: size - user_id: user_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 - - metadata: metadata_1 - - status: status_3 + - metadata: metadata_vol_obj + - status: status_vol - volume_image_metadata: volume_image_metadata - - description: description_9 + - description: description_vol_req - multiattach: multiattach_resp - source_volid: source_volid - 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 - - name: name_13 + - name: name_vol - bootable: bootable_response - created_at: created_at - - volume_type: volume_type_6 + - volume_type: volume_type_vol - service_uuid: service_uuid - shared_targets: shared_targets @@ -403,9 +403,9 @@ Request - project_id: project_id_path - volume_id: volume_id_path - volume: volume - - description: description_5 + - description: description_vol - name: volume_name_optional - - metadata: metadata_2 + - metadata: metadata_vol_assoc Request Example --------------- @@ -420,28 +420,28 @@ Response Parameters .. rest_parameters:: parameters.yaml - - migration_status: migration_status + - migration_status: migration_status_req - attachments: attachments - - links: links_3 + - links: links_vol - availability_zone: availability_zone - encrypted: encrypted - updated_at: updated_at - replication_status: replication_status - snapshot_id: snapshot_id - - id: id_5 + - id: id_vol - size: size - user_id: user_id - - metadata: metadata_1 - - status: status_3 - - description: description_9 + - metadata: metadata_vol_obj + - status: status_vol + - description: description_vol_req - multiattach: multiattach_resp - source_volid: source_volid - volume: volume - - consistencygroup_id: consistencygroup_id - - name: name_13 + - consistencygroup_id: consistencygroup_id_required + - name: name_vol - bootable: bootable_response - created_at: created_at - - volume_type: volume_type_6 + - volume_type: volume_type_vol Response Example @@ -500,7 +500,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - cascade: cascade - - force: force_5 + - force: force_vol_del Create metadata for volume @@ -526,7 +526,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - - metadata: metadata_3 + - metadata: metadata_vol_assoc_req Request Example --------------- @@ -541,7 +541,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - metadata: metadata_3 + - metadata: metadata_vol_assoc_req Response Example @@ -581,7 +581,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - metadata: metadata_3 + - metadata: metadata_vol_assoc_req @@ -615,7 +615,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - - metadata: metadata_3 + - metadata: metadata_vol_assoc_req Request Example --------------- @@ -630,7 +630,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - metadata: metadata_3 + - metadata: metadata_vol_assoc_req @@ -663,7 +663,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - - key: key_2 + - key: key_view Response Parameters @@ -705,7 +705,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - - key: key_1 + - key: key_path Update a volume's metadata for a specific key @@ -731,7 +731,7 @@ Request - project_id: project_id_path - volume_id: volume_id_path - - key: key_3 + - key: key_update - meta: meta Request Example diff --git a/api-ref/source/v3/worker-cleanup.inc b/api-ref/source/v3/worker-cleanup.inc index d753ed0b45b..983b14a7cc3 100644 --- a/api-ref/source/v3/worker-cleanup.inc +++ b/api-ref/source/v3/worker-cleanup.inc @@ -30,7 +30,7 @@ Request - cluster_name: cluster_mutex - service_id: service_id - host: host_service - - binary: binary + - binary: binary_required - is-up: is_up - disabled: disabled - resource-id: resource_id @@ -50,7 +50,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - host: host_service - - binary: binary + - binary: binary_required - id: service_id - cluster_name: cluster_mutex