diff --git a/openstack_cli/src/compute/v2/server/volume_attachment/set_20.rs b/openstack_cli/src/compute/v2/server/volume_attachment/set_20.rs index 5653156b4..d1d316d45 100644 --- a/openstack_cli/src/compute/v2/server/volume_attachment/set_20.rs +++ b/openstack_cli/src/compute/v2/server/volume_attachment/set_20.rs @@ -34,15 +34,10 @@ use openstack_types::compute::v2::server::volume_attachment::response::set::Volu /// Update a volume attachment. /// -/// Policy default role is ‘rule:system_admin_or_owner’, its scope is \[system, -/// project\], which allow project members or system admins to change the -/// fields of an attached volume of a server. Policy defaults enable only users -/// with the administrative role to change `volumeId` via this operation. Cloud -/// providers can change these permissions through the `policy.json` file. -/// -/// Updating, or what is commonly referred to as “swapping”, volume attachments -/// with volumes that have more than one read/write attachment, is not -/// supported. +/// Policy default role is ‘rule:admin_or_owner’, its scope is [project], which +/// allow project members or admins to change the fields of an attached volume +/// of a server. Cloud providers can change these permissions through the +/// `policy.yaml` file. /// /// Normal response codes: 202 /// @@ -94,7 +89,7 @@ struct PathParameters { /// VolumeAttachment Body data #[derive(Args, Clone)] struct VolumeAttachment { - /// The UUID of the volume to attach instead of the attached volume. + /// The UUID of the attached volume. #[arg(help_heading = "Body parameters", long)] volume_id: String, } diff --git a/openstack_cli/src/compute/v2/server/volume_attachment/set_285.rs b/openstack_cli/src/compute/v2/server/volume_attachment/set_285.rs index d0f40b429..bce870e48 100644 --- a/openstack_cli/src/compute/v2/server/volume_attachment/set_285.rs +++ b/openstack_cli/src/compute/v2/server/volume_attachment/set_285.rs @@ -34,15 +34,10 @@ use openstack_types::compute::v2::server::volume_attachment::response::set::Volu /// Update a volume attachment. /// -/// Policy default role is ‘rule:system_admin_or_owner’, its scope is \[system, -/// project\], which allow project members or system admins to change the -/// fields of an attached volume of a server. Policy defaults enable only users -/// with the administrative role to change `volumeId` via this operation. Cloud -/// providers can change these permissions through the `policy.json` file. -/// -/// Updating, or what is commonly referred to as “swapping”, volume attachments -/// with volumes that have more than one read/write attachment, is not -/// supported. +/// Policy default role is ‘rule:admin_or_owner’, its scope is [project], which +/// allow project members or admins to change the fields of an attached volume +/// of a server. Cloud providers can change these permissions through the +/// `policy.yaml` file. /// /// Normal response codes: 202 /// @@ -129,7 +124,7 @@ struct VolumeAttachment { #[arg(help_heading = "Body parameters", long)] tag: Option, - /// The UUID of the volume to attach instead of the attached volume. + /// The UUID of the attached volume. #[arg(help_heading = "Body parameters", long)] volume_id: String, } diff --git a/openstack_cli/src/image/v2/image/file/upload.rs b/openstack_cli/src/image/v2/image/file/upload.rs index e855751ed..a4145dc1f 100644 --- a/openstack_cli/src/image/v2/image/file/upload.rs +++ b/openstack_cli/src/image/v2/image/file/upload.rs @@ -46,6 +46,12 @@ use openstack_sdk::api::image::v2::image::file::upload; /// is returned. When the header is not present, the image data is placed into /// the default backing store. /// +/// An optional `x-openstack-image-size` header may be added to the request. +/// When present, the server will validate that the uploaded data size matches +/// this value. If the actual size does not match the expected size, a 400 (Bad +/// Request) response is returned. When not present, the server will calculate +/// the image size based on the actual request body size. +/// /// Example call: /// /// **Preconditions** diff --git a/openstack_sdk/src/api/block_storage/v3/quota_class_set/get.rs b/openstack_sdk/src/api/block_storage/v3/quota_class_set/get.rs index 05e2eaee1..6e28aa41c 100644 --- a/openstack_sdk/src/api/block_storage/v3/quota_class_set/get.rs +++ b/openstack_sdk/src/api/block_storage/v3/quota_class_set/get.rs @@ -85,7 +85,7 @@ impl RestEndpoint for Request<'_> { } fn response_key(&self) -> Option> { - None + Some("quota_class_set".into()) } /// Returns headers to be set into the request @@ -120,7 +120,10 @@ mod tests { #[test] fn test_response_key() { - assert!(Request::builder().build().unwrap().response_key().is_none()) + assert_eq!( + Request::builder().build().unwrap().response_key().unwrap(), + "quota_class_set" + ); } #[cfg(feature = "sync")] @@ -134,7 +137,7 @@ mod tests { then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_class_set": {} })); }); let endpoint = Request::builder().id("id").build().unwrap(); @@ -154,7 +157,7 @@ mod tests { .header("not_foo", "not_bar"); then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_class_set": {} })); }); let endpoint = Request::builder() diff --git a/openstack_sdk/src/api/block_storage/v3/quota_class_set/set.rs b/openstack_sdk/src/api/block_storage/v3/quota_class_set/set.rs index 7236e5b8f..7d474c26b 100644 --- a/openstack_sdk/src/api/block_storage/v3/quota_class_set/set.rs +++ b/openstack_sdk/src/api/block_storage/v3/quota_class_set/set.rs @@ -112,7 +112,7 @@ impl RestEndpoint for Request<'_> { } fn response_key(&self) -> Option> { - None + Some("quota_class_set".into()) } /// Returns headers to be set into the request @@ -151,12 +151,15 @@ mod tests { #[test] fn test_response_key() { - assert!(Request::builder() - .quota_class_set(BTreeMap::::new().into_iter()) - .build() - .unwrap() - .response_key() - .is_none()) + assert_eq!( + Request::builder() + .quota_class_set(BTreeMap::::new().into_iter()) + .build() + .unwrap() + .response_key() + .unwrap(), + "quota_class_set" + ); } #[cfg(feature = "sync")] @@ -170,7 +173,7 @@ mod tests { then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_class_set": {} })); }); let endpoint = Request::builder() @@ -194,7 +197,7 @@ mod tests { .header("not_foo", "not_bar"); then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_class_set": {} })); }); let endpoint = Request::builder() diff --git a/openstack_sdk/src/api/block_storage/v3/quota_set/defaults.rs b/openstack_sdk/src/api/block_storage/v3/quota_set/defaults.rs index 728518325..404b06628 100644 --- a/openstack_sdk/src/api/block_storage/v3/quota_set/defaults.rs +++ b/openstack_sdk/src/api/block_storage/v3/quota_set/defaults.rs @@ -85,7 +85,7 @@ impl RestEndpoint for Request<'_> { } fn response_key(&self) -> Option> { - None + Some("quota_set".into()) } /// Returns headers to be set into the request @@ -120,7 +120,10 @@ mod tests { #[test] fn test_response_key() { - assert!(Request::builder().build().unwrap().response_key().is_none()) + assert_eq!( + Request::builder().build().unwrap().response_key().unwrap(), + "quota_set" + ); } #[cfg(feature = "sync")] @@ -134,7 +137,7 @@ mod tests { then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_set": {} })); }); let endpoint = Request::builder().id("id").build().unwrap(); @@ -154,7 +157,7 @@ mod tests { .header("not_foo", "not_bar"); then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_set": {} })); }); let endpoint = Request::builder() diff --git a/openstack_sdk/src/api/block_storage/v3/quota_set/get.rs b/openstack_sdk/src/api/block_storage/v3/quota_set/get.rs index 558d540dd..dfdb79576 100644 --- a/openstack_sdk/src/api/block_storage/v3/quota_set/get.rs +++ b/openstack_sdk/src/api/block_storage/v3/quota_set/get.rs @@ -90,7 +90,7 @@ impl RestEndpoint for Request<'_> { } fn response_key(&self) -> Option> { - None + Some("quota_set".into()) } /// Returns headers to be set into the request @@ -125,7 +125,10 @@ mod tests { #[test] fn test_response_key() { - assert!(Request::builder().build().unwrap().response_key().is_none()) + assert_eq!( + Request::builder().build().unwrap().response_key().unwrap(), + "quota_set" + ); } #[cfg(feature = "sync")] @@ -139,7 +142,7 @@ mod tests { then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_set": {} })); }); let endpoint = Request::builder().id("id").build().unwrap(); @@ -159,7 +162,7 @@ mod tests { .header("not_foo", "not_bar"); then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_set": {} })); }); let endpoint = Request::builder() diff --git a/openstack_sdk/src/api/block_storage/v3/quota_set/set.rs b/openstack_sdk/src/api/block_storage/v3/quota_set/set.rs index c1b39edce..fceac063b 100644 --- a/openstack_sdk/src/api/block_storage/v3/quota_set/set.rs +++ b/openstack_sdk/src/api/block_storage/v3/quota_set/set.rs @@ -116,7 +116,7 @@ impl RestEndpoint for Request<'_> { } fn response_key(&self) -> Option> { - None + Some("quota_set".into()) } /// Returns headers to be set into the request @@ -155,12 +155,15 @@ mod tests { #[test] fn test_response_key() { - assert!(Request::builder() - .quota_set(BTreeMap::::new().into_iter()) - .build() - .unwrap() - .response_key() - .is_none()) + assert_eq!( + Request::builder() + .quota_set(BTreeMap::::new().into_iter()) + .build() + .unwrap() + .response_key() + .unwrap(), + "quota_set" + ); } #[cfg(feature = "sync")] @@ -174,7 +177,7 @@ mod tests { then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_set": {} })); }); let endpoint = Request::builder() @@ -198,7 +201,7 @@ mod tests { .header("not_foo", "not_bar"); then.status(200) .header("content-type", "application/json") - .json_body(json!({ "dummy": {} })); + .json_body(json!({ "quota_set": {} })); }); let endpoint = Request::builder() diff --git a/openstack_sdk/src/api/compute/v2/server/volume_attachment/set_20.rs b/openstack_sdk/src/api/compute/v2/server/volume_attachment/set_20.rs index e3768182e..9685954b2 100644 --- a/openstack_sdk/src/api/compute/v2/server/volume_attachment/set_20.rs +++ b/openstack_sdk/src/api/compute/v2/server/volume_attachment/set_20.rs @@ -17,15 +17,10 @@ //! Update a volume attachment. //! -//! Policy default role is ‘rule:system_admin_or_owner’, its scope is \[system, -//! project\], which allow project members or system admins to change the -//! fields of an attached volume of a server. Policy defaults enable only users -//! with the administrative role to change `volumeId` via this operation. Cloud -//! providers can change these permissions through the `policy.json` file. -//! -//! Updating, or what is commonly referred to as “swapping”, volume attachments -//! with volumes that have more than one read/write attachment, is not -//! supported. +//! Policy default role is ‘rule:admin_or_owner’, its scope is [project], which +//! allow project members or admins to change the fields of an attached volume +//! of a server. Cloud providers can change these permissions through the +//! `policy.yaml` file. //! //! Normal response codes: 202 //! @@ -47,7 +42,7 @@ use std::borrow::Cow; #[derive(Builder, Debug, Deserialize, Clone, Serialize)] #[builder(setter(strip_option))] pub struct VolumeAttachment<'a> { - /// The UUID of the volume to attach instead of the attached volume. + /// The UUID of the attached volume. #[serde(rename = "volumeId")] #[builder(setter(into))] pub(crate) volume_id: Cow<'a, str>, diff --git a/openstack_sdk/src/api/compute/v2/server/volume_attachment/set_285.rs b/openstack_sdk/src/api/compute/v2/server/volume_attachment/set_285.rs index 4c4a8c708..5f8bb8e4c 100644 --- a/openstack_sdk/src/api/compute/v2/server/volume_attachment/set_285.rs +++ b/openstack_sdk/src/api/compute/v2/server/volume_attachment/set_285.rs @@ -17,15 +17,10 @@ //! Update a volume attachment. //! -//! Policy default role is ‘rule:system_admin_or_owner’, its scope is \[system, -//! project\], which allow project members or system admins to change the -//! fields of an attached volume of a server. Policy defaults enable only users -//! with the administrative role to change `volumeId` via this operation. Cloud -//! providers can change these permissions through the `policy.json` file. -//! -//! Updating, or what is commonly referred to as “swapping”, volume attachments -//! with volumes that have more than one read/write attachment, is not -//! supported. +//! Policy default role is ‘rule:admin_or_owner’, its scope is [project], which +//! allow project members or admins to change the fields of an attached volume +//! of a server. Cloud providers can change these permissions through the +//! `policy.yaml` file. //! //! Normal response codes: 202 //! @@ -83,7 +78,7 @@ pub struct VolumeAttachment<'a> { #[builder(default, setter(into))] pub(crate) tag: Option>, - /// The UUID of the volume to attach instead of the attached volume. + /// The UUID of the attached volume. #[serde(rename = "volumeId")] #[builder(setter(into))] pub(crate) volume_id: Cow<'a, str>, diff --git a/openstack_sdk/src/api/image/v2/image/file/upload.rs b/openstack_sdk/src/api/image/v2/image/file/upload.rs index 704643ca3..08ac22d1c 100644 --- a/openstack_sdk/src/api/image/v2/image/file/upload.rs +++ b/openstack_sdk/src/api/image/v2/image/file/upload.rs @@ -29,6 +29,12 @@ //! is returned. When the header is not present, the image data is placed into //! the default backing store. //! +//! An optional `x-openstack-image-size` header may be added to the request. +//! When present, the server will validate that the uploaded data size matches +//! this value. If the actual size does not match the expected size, a 400 (Bad +//! Request) response is returned. When not present, the server will calculate +//! the image size based on the actual request body size. +//! //! Example call: //! //! **Preconditions** diff --git a/openstack_sdk/src/api/image/v2/image/stage/stage.rs b/openstack_sdk/src/api/image/v2/image/stage/stage.rs index a53da7135..c449d8de5 100644 --- a/openstack_sdk/src/api/image/v2/image/stage/stage.rs +++ b/openstack_sdk/src/api/image/v2/image/stage/stage.rs @@ -21,6 +21,12 @@ //! //! Set the `Content-Type` request header to `application/octet-stream`. //! +//! An optional `x-openstack-image-size` header may be added to the request. +//! When present, the server will validate that the uploaded data size matches +//! this value. If the actual size does not match the expected size, a 400 (Bad +//! Request) response is returned. When not present, the server will calculate +//! the image size based on the actual request body size. +//! //! Example call: //! //! **Preconditions** diff --git a/openstack_types/data/compute/v2.100.yaml b/openstack_types/data/compute/v2.100.yaml index 7707e17d6..83f0c84d1 100644 --- a/openstack_types/data/compute/v2.100.yaml +++ b/openstack_types/data/compute/v2.100.yaml @@ -2939,8 +2939,6 @@ paths: summary: Show A Quota tags: - quota-sets-os-quota-sets - x-openstack: - min-ver: '2.1' parameters: - $ref: '#/components/parameters/os_quota_sets_id' put: @@ -2975,8 +2973,6 @@ paths: summary: Update Quotas tags: - quota-sets-os-quota-sets - x-openstack: - min-ver: '2.1' /v2.1/os-quota-sets/{id}/defaults: get: description: |- @@ -3413,8 +3409,6 @@ paths: summary: Create Server Group tags: - os-server-groups - x-openstack: - min-ver: '2.1' /v2.1/os-server-groups/{id}: delete: description: |- @@ -5654,15 +5648,10 @@ paths: description: |- Update a volume attachment. - Policy default role is ‘rule:system_admin_or_owner’, its scope is - [system, project], which allow project members or system admins to - change the fields of an attached volume of a server. Policy defaults - enable only users with the administrative role to change `volumeId` - via this operation. Cloud providers can change these permissions - through the `policy.json` file. - - Updating, or what is commonly referred to as “swapping”, volume attachments - with volumes that have more than one read/write attachment, is not supported. + Policy default role is ‘rule:admin_or_owner’, its scope is [project], which + allow project members or admins to change the fields of an attached volume of + a server. Cloud providers can change these permissions through the + `policy.yaml` file. Normal response codes: 202 @@ -8904,6 +8893,7 @@ components: - integer - string x-openstack: + max-ver: '2.74' min-ver: '2.0' servers_os_volume_attachments_offset: in: query @@ -8916,6 +8906,7 @@ components: - integer - string x-openstack: + max-ver: '2.74' min-ver: '2.0' servers_os_volume_attachments_server_id: description: server_id parameter for @@ -10705,7 +10696,8 @@ components: - status - updated type: object - required: [] + required: + - image type: object ImagesDetailResponse: additionalProperties: false @@ -11040,7 +11032,8 @@ components: maxItems: 1 minItems: 1 type: array - required: [] + required: + - images type: object ImagesMetadataCreateResponse: additionalProperties: false @@ -18866,7 +18859,7 @@ components: additionalProperties: false patternProperties: ^[a-zA-Z0-9_:. ]{1,255}$: - max_Length: 255 + maxLength: 255 type: string type: object type: object @@ -45312,7 +45305,7 @@ components: properties: volumeId: description: |- - The UUID of the volume to attach instead of the attached volume. + The UUID of the attached volume. format: uuid type: string required: @@ -45400,7 +45393,7 @@ components: type: string volumeId: description: |- - The UUID of the volume to attach instead of the attached volume. + The UUID of the attached volume. format: uuid type: string required: diff --git a/openstack_types/data/compute/v2.yaml b/openstack_types/data/compute/v2.yaml index 7707e17d6..83f0c84d1 100644 --- a/openstack_types/data/compute/v2.yaml +++ b/openstack_types/data/compute/v2.yaml @@ -2939,8 +2939,6 @@ paths: summary: Show A Quota tags: - quota-sets-os-quota-sets - x-openstack: - min-ver: '2.1' parameters: - $ref: '#/components/parameters/os_quota_sets_id' put: @@ -2975,8 +2973,6 @@ paths: summary: Update Quotas tags: - quota-sets-os-quota-sets - x-openstack: - min-ver: '2.1' /v2.1/os-quota-sets/{id}/defaults: get: description: |- @@ -3413,8 +3409,6 @@ paths: summary: Create Server Group tags: - os-server-groups - x-openstack: - min-ver: '2.1' /v2.1/os-server-groups/{id}: delete: description: |- @@ -5654,15 +5648,10 @@ paths: description: |- Update a volume attachment. - Policy default role is ‘rule:system_admin_or_owner’, its scope is - [system, project], which allow project members or system admins to - change the fields of an attached volume of a server. Policy defaults - enable only users with the administrative role to change `volumeId` - via this operation. Cloud providers can change these permissions - through the `policy.json` file. - - Updating, or what is commonly referred to as “swapping”, volume attachments - with volumes that have more than one read/write attachment, is not supported. + Policy default role is ‘rule:admin_or_owner’, its scope is [project], which + allow project members or admins to change the fields of an attached volume of + a server. Cloud providers can change these permissions through the + `policy.yaml` file. Normal response codes: 202 @@ -8904,6 +8893,7 @@ components: - integer - string x-openstack: + max-ver: '2.74' min-ver: '2.0' servers_os_volume_attachments_offset: in: query @@ -8916,6 +8906,7 @@ components: - integer - string x-openstack: + max-ver: '2.74' min-ver: '2.0' servers_os_volume_attachments_server_id: description: server_id parameter for @@ -10705,7 +10696,8 @@ components: - status - updated type: object - required: [] + required: + - image type: object ImagesDetailResponse: additionalProperties: false @@ -11040,7 +11032,8 @@ components: maxItems: 1 minItems: 1 type: array - required: [] + required: + - images type: object ImagesMetadataCreateResponse: additionalProperties: false @@ -18866,7 +18859,7 @@ components: additionalProperties: false patternProperties: ^[a-zA-Z0-9_:. ]{1,255}$: - max_Length: 255 + maxLength: 255 type: string type: object type: object @@ -45312,7 +45305,7 @@ components: properties: volumeId: description: |- - The UUID of the volume to attach instead of the attached volume. + The UUID of the attached volume. format: uuid type: string required: @@ -45400,7 +45393,7 @@ components: type: string volumeId: description: |- - The UUID of the volume to attach instead of the attached volume. + The UUID of the attached volume. format: uuid type: string required: diff --git a/openstack_types/data/container-infrastructure-management/v1.12.yaml b/openstack_types/data/container-infrastructure-management/v1.12.yaml new file mode 100644 index 000000000..10e9df8ac --- /dev/null +++ b/openstack_types/data/container-infrastructure-management/v1.12.yaml @@ -0,0 +1,4538 @@ +openapi: 3.1.0 +info: + description: |- + None + title: OpenStack Container Managent Infrastructure API + version: '1.12' +paths: + /v1: + get: + operationId: :get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RootGetResponse' + description: Ok + tags: + - v1 + /v1/certificates: + post: + description: |- + Sign a new certificate by the CA. + + | param certificate: | | + | --- | --- | + | | a certificate within the request body. | + operationId: certificates:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Certificate' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CertificatesCreateResponse' + description: Ok + tags: + - certificates + /v1/certificates/{certificate_id}: + get: + description: |- + Show CA certificate details that are associated with the created cluster based on the + given CA certificate type. + operationId: certificates/certificate_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateShowResponse' + description: Ok + summary: Show details about the CA certificate for a cluster + tags: + - certificates + parameters: + - $ref: '#/components/parameters/certificates_certificate_id' + /v1/clusters: + get: + description: |- + List all clusters in Magnum. + operationId: clusters:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersListResponse' + description: Ok + summary: List all clusters + tags: + - clusters + post: + description: |- + Create new cluster based on cluster template. + operationId: clusters:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersCreateResponse' + description: Ok + summary: Create new cluster + tags: + - clusters + /v1/clusters/actions/resize: + post: + operationId: clusters/actions/resize:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterResizeRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersActionsResizeResponse' + description: Ok + tags: + - clusters + /v1/clusters/actions/upgrade: + post: + operationId: clusters/actions/upgrade:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterUpgradeRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersActionsUpgradeResponse' + description: Ok + tags: + - clusters + /v1/clusters/nodegroups: + delete: + description: |- + Delete NodeGroup for a given project_id and resource. + + | param cluster_id: | | + | --- | --- | + | | cluster id. | + | param nodegroup_id: | | + | | resource name. | + operationId: clusters/nodegroups:delete + responses: + '204': + description: Ok + tags: + - clusters + get: + description: |- + Retrieve a list of nodegroups. + + | param cluster_id: | | + | --- | --- | + | | the cluster id or name | + | param marker: | pagination marker for large data sets. | + | param limit: | maximum number of resources to return in a single result. | + | param sort_key: | column to sort results by. Default: id. | + | param sort_dir: | direction to sort. "asc" or "desc". Default: asc. | + | param role: | list all nodegroups with the specified role. | + operationId: clusters/nodegroups:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersNodegroupsListResponse' + description: Ok + tags: + - clusters + post: + description: |- + Retrieve a list of nodegroups. + + | param cluster_id: | | + | --- | --- | + | | the cluster id or name | + | param marker: | pagination marker for large data sets. | + | param limit: | maximum number of resources to return in a single result. | + | param sort_key: | column to sort results by. Default: id. | + | param sort_dir: | direction to sort. "asc" or "desc". Default: asc. | + | param role: | list all nodegroups with the specified role. | + operationId: clusters/nodegroups:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroup' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersNodegroupsGet_OneResponse' + description: Ok + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersNodegroupsCreateResponse' + description: Ok + tags: + - clusters + /v1/clusters/nodegroups/{nodegroup_id}: + delete: + description: |- + Delete NodeGroup for a given project_id and resource. + + | param cluster_id: | | + | --- | --- | + | | cluster id. | + | param nodegroup_id: | | + | | resource name. | + operationId: clusters/nodegroups/nodegroup_id:delete + responses: + '204': + description: Ok + tags: + - clusters + get: + description: |- + Retrieve information for the given nodegroup in a cluster. + + | | | + | --- | --- | + | param id: | cluster id. | + | param resource: | nodegroup id. | + operationId: clusters/nodegroups/nodegroup_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersNodegroupShowResponse' + description: Ok + tags: + - clusters + parameters: + - $ref: '#/components/parameters/clusters_nodegroups_nodegroup_id' + patch: + description: |- + Update NodeGroup. + + | param cluster_id: | | + | --- | --- | + | | cluster id. | + + System Message: WARNING/2 (, line 4) + + Field list ends without a blank line; unexpected unindent. + + :param : resource name. + :param values: a json document to update a nodegroup. + operationId: clusters/nodegroups/nodegroup_id:patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersNodegroupPatchRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustersNodegroupPatchResponse' + description: Ok + tags: + - clusters + /v1/clusters/{cluster_id}: + delete: + description: |- + Delete a cluster. + operationId: clusters/cluster_id:delete + responses: + '204': + description: Ok + summary: Delete a cluster + tags: + - clusters + get: + description: |- + Get all information of a cluster in Magnum. + operationId: clusters/cluster_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterShowResponse' + description: Ok + summary: Show details of a cluster + tags: + - clusters + parameters: + - $ref: '#/components/parameters/clusters_cluster_id' + patch: + description: |- + Update information of one cluster attributes using operations + including: `add`, `replace` or `remove`. The attributes to `add` and + `replace` in the form of `key=value` while `remove` only needs the keys. + operationId: clusters/cluster_id:patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterPatchRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterPatchResponse' + description: Ok + summary: Update information of cluster + tags: + - clusters + /v1/clustertemplates: + get: + description: |- + List all available cluster templates in Magnum. + operationId: clustertemplates:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustertemplatesListResponse' + description: Ok + summary: List all cluster templates + tags: + - clustertemplates + post: + description: |- + Create new cluster template. + operationId: clustertemplates:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterTemplate' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustertemplatesCreateResponse' + description: Ok + summary: Create new cluster template + tags: + - clustertemplates + /v1/clustertemplates/{clustertemplate_id}: + delete: + description: |- + Delete a cluster template. + operationId: clustertemplates/clustertemplate_id:delete + responses: + '204': + description: Ok + summary: Delete a cluster template + tags: + - clustertemplates + get: + description: |- + Get all information of a cluster template in Magnum. + operationId: clustertemplates/clustertemplate_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClustertemplateShowResponse' + description: Ok + summary: Show details of a cluster template + tags: + - clustertemplates + parameters: + - $ref: '#/components/parameters/clustertemplates_clustertemplate_id' + patch: + description: |- + Update information of one cluster template attributes using operations + including: `add`, `replace` or `remove`. The attributes to `add` and + `replace` in the form of `key=value` while `remove` only needs the keys. + summary: Update information of cluster template + /v1/credentials/{credential_id}: + parameters: + - $ref: '#/components/parameters/credentials_credential_id' + patch: + description: |- + Rotate the credential in use by a cluster. + + | param cluster_ident: | | + | --- | --- | + | | UUID of a cluster or logical name of the cluster. | + operationId: credentials/credential_id:patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CredentialPatchRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/CredentialPatchResponse' + description: Ok + tags: + - credentials + /v1/federations: + get: + description: |- + Retrieve a list of federations. + + | | | + | --- | --- | + | param marker: | pagination marker for large data sets. | + | param limit: | maximum number of resources to return in a single result. | + | param sort_key: | column to sort results by. Default: id. | + | param sort_dir: | direction to sort. "asc" or "desc". Default: asc. | + operationId: federations:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FederationsListResponse' + description: Ok + tags: + - federations + post: + description: |- + Create a new federation. + + | param federation: | | + | --- | --- | + | | a federation within the request body. | + operationId: federations:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Federation' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/FederationsCreateResponse' + description: Ok + tags: + - federations + /v1/federations/{federation_id}: + delete: + description: |- + Delete a federation. + + | param federation_ident: | | + | --- | --- | + | | UUID of federation or logical name of the federation. | + operationId: federations/federation_id:delete + responses: + '204': + description: Ok + tags: + - federations + get: + description: |- + Retrieve information about a given Federation. + + | param federation_ident: | | + | --- | --- | + | | UUID or logical name of the Federation. | + operationId: federations/federation_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FederationShowResponse' + description: Ok + tags: + - federations + parameters: + - $ref: '#/components/parameters/federations_federation_id' + /v1/mservices: + get: + description: |- + Enables administrative users to list all Magnum services. + + Container infrastructure service information include service id, binary, + host, report count, creation time, last updated time, health status, and + the reason for disabling service. + operationId: mservices:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MservicesListResponse' + description: Ok + summary: List container infrastructure management services + tags: + - mservices + /v1/quotas: + get: + description: |- + List all quotas in Magnum. + operationId: quotas:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/QuotasListResponse' + description: Ok + summary: List all quotas + tags: + - quotas + post: + description: |- + Create new quota for a project. + operationId: quotas:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Quota' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/QuotasCreateResponse' + description: Ok + summary: Set new quota + tags: + - quotas + /v1/quotas/{quota_id}: + delete: + description: |- + Delete Quota for a given project_id and resource. + + | param project_id: | | + | --- | --- | + | | project id. | + | param resource: | resource name. | + operationId: quotas/quota_id:delete + responses: + '204': + description: Ok + tags: + - quotas + get: + description: |- + Retrieve Quota information for the given project_id. + + | | | + | --- | --- | + | param id: | project id. | + | param resource: | resource name. | + operationId: quotas/quota_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/QuotaShowResponse' + description: Ok + tags: + - quotas + parameters: + - $ref: '#/components/parameters/quotas_quota_id' + /v1/stats: + get: + description: |- + Show overall Magnum system stats. + If the requester is non-admin user show self stats. + operationId: stats:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StatsListResponse' + description: Ok + summary: Show overall stats + tags: + - stats +components: + parameters: + certificates_certificate_id: + description: certificate_id parameter for + /v1/certificates/{certificate_id} API + in: path + name: certificate_id + required: true + schema: + type: string + clusters_cluster_id: + description: cluster_id parameter for /v1/clusters/{cluster_id} API + in: path + name: cluster_id + required: true + schema: + type: string + clusters_nodegroups_nodegroup_id: + description: nodegroup_id parameter for + /v1/clusters/nodegroups/{nodegroup_id} API + in: path + name: nodegroup_id + required: true + schema: + type: string + clustertemplates_clustertemplate_id: + description: clustertemplate_id parameter for + /v1/clustertemplates/{clustertemplate_id} API + in: path + name: clustertemplate_id + required: true + schema: + type: string + credentials_credential_id: + description: credential_id parameter for /v1/credentials/{credential_id} + API + in: path + name: credential_id + required: true + schema: + type: string + federations_federation_id: + description: federation_id parameter for /v1/federations/{federation_id} + API + in: path + name: federation_id + required: true + schema: + type: string + quotas_quota_id: + description: quota_id parameter for /v1/quotas/{quota_id} API + in: path + name: quota_id + required: true + schema: + type: string + schemas: + Certificate: + description: "API representation of a certificate.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a\ncertificate." + properties: + ca_cert_type: + type: string + cluster_uuid: + type: string + created_at: + format: date-time + type: string + csr: + minLength: 1 + type: string + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + pem: + type: string + updated_at: + format: date-time + type: string + type: object + CertificateShowResponse: + description: "API representation of a certificate.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a\ncertificate." + properties: + ca_cert_type: + type: string + cluster_uuid: + description: |- + The UUID of the cluster. + type: string + created_at: + format: date-time + type: string + csr: + minLength: 1 + type: string + links: + description: |- + Links to the resources in question. + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + pem: + description: |- + CA certificate for the cluster. + type: string + updated_at: + format: date-time + type: string + type: object + CertificatesCreateResponse: + description: "API representation of a certificate.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a\ncertificate." + properties: + ca_cert_type: + type: string + cluster_uuid: + type: string + created_at: + format: date-time + type: string + csr: + minLength: 1 + type: string + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + pem: + type: string + updated_at: + format: date-time + type: string + type: object + Cluster: + description: "API representation of a cluster.\n\nThis class enforces type checking + and value constraints, and converts\nbetween the internal object model and + the API representation of a Cluster." + properties: + api_address: + type: string + cluster_template_id: + description: |- + The UUID of the cluster template. + type: string + coe_version: + type: string + container_version: + type: string + create_timeout: + description: |- + The timeout for cluster creation in minutes. The value expected is a + positive integer and the default is 60 minutes. If the timeout is reached + during cluster creation process, the operation will be aborted and the + cluster status will be set to `CREATE_FAILED`. + type: integer + created_at: + format: date-time + type: string + discovery_url: + description: |- + The custom discovery url for node discovery. This is used by the COE to + discover the servers that have been created to host the containers. The + actual discovery mechanism varies with the COE. In some cases, Magnum fills + in the server info in the discovery service. In other cases, if the + `discovery_url` is not specified, Magnum will use the public discovery + service at: + + ``` + https://discovery.etcd.io + ``` + + In this case, Magnum will generate a unique url here for each uster and + store the info for the servers. + type: string + docker_volume_size: + minimum: 1 + type: integer + faults: + additionalProperties: + type: string + type: object + fixed_network: + description: |- + The name or network ID of a Neutron network to provide connectivity to + the internal network for the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_subnet: + description: |- + Fixed subnet that are using to allocate network address for nodes in + cluster. + maxLength: 255 + minLength: 1 + type: string + flavor_id: + description: |- + The nova flavor ID or name for booting the node servers. The default is + `m1.small`. + maxLength: 255 + minLength: 1 + type: string + floating_ip_enabled: + description: |- + Whether enable or not using the floating IP of cloud provider. Some + cloud providers used floating IP, some used public IP, thus Magnum + provide this option for specifying the choice of using floating IP. + If it’s not set, the value of floating_ip_enabled in template + will be used. + format: boolean + type: string + health_status: + enum: + - HEALTHY + - UNHEALTHY + - UNKNOWN + type: string + health_status_reason: + additionalProperties: + type: string + type: object + keypair: + description: |- + The name of the SSH keypair to configure in the cluster servers + for ssh access. Users will need the key to be able to ssh to the servers in + the cluster. The login name is specific to the cluster driver, for + example with fedora-atomic image, default login name is `fedora`. + maxLength: 255 + minLength: 1 + type: string + labels: + additionalProperties: + format: + type: string + description: |- + Arbitrary labels in the form of `key=value` pairs. The accepted keys and + valid values are defined in the cluster drivers. They are used as a way + to pass additional parameters that are specific to a cluster driver. + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + master_addresses: + items: + type: string + type: array + master_count: + description: |- + The number of servers that will serve as master for the cluster. The + default is 1. Set to more than 1 master to enable High Availability. If + the option `master-lb-enabled` is specified in the cluster + template, the master servers will be placed in a load balancer pool. + minimum: 1 + type: integer + master_flavor_id: + description: |- + The flavor of the master node for this cluster template. + maxLength: 255 + minLength: 1 + type: string + master_lb_enabled: + description: |- + Since multiple masters may exist in a cluster, a Neutron load balancer + is created to provide the API endpoint for the cluster and to direct + requests to the masters. In some cases, such as when the LBaaS service is + not available, this option can be set to `false` to create a cluster + without the load balancer. In this case, one of the masters will serve as + the API endpoint. The default is `true`, i.e. to create the load + balancer for the cluster. + format: boolean + type: string + merge_labels: + format: boolean + type: string + name: + description: |- + Name of the resource. + maxLength: 242 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + description: |- + The number of servers that will serve as node in the cluster. The + default is 1. + type: integer + project_id: + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + user_id: + type: string + uuid: + format: uuid + type: string + required: + - cluster_template_id + type: object + ClusterPatchRequest: + items: + description: |- + A complex type that represents a single json-patch operation. + properties: + op: + description: |- + The operation used to modify resource’s attributes. Supported operations + are following: `add`, `replace` and `remove`. In case of + `remove`, users only need to provide `path` for deleting attribute. + enum: + - add + - remove + - replace + type: string + path: + description: |- + Resource attribute’s name. + type: string + value: + description: |- + Resource attribute’s value. + format: + type: string + required: + - op + - path + type: object + type: array + ClusterPatchResponse: + description: "API representation of a cluster ID\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a cluster\nID." + properties: + uuid: + description: |- + The UUID of the cluster. + format: uuid + type: string + type: object + ClusterResizeRequest: + description: "API object for handling resize requests.\n\nThis class enforces + type checking and value constraints." + properties: + created_at: + format: date-time + type: string + node_count: + type: integer + nodegroup: + maxLength: 255 + minLength: 1 + type: string + nodes_to_remove: + items: + type: string + type: array + updated_at: + format: date-time + type: string + required: + - node_count + type: object + ClusterShowResponse: + description: "API representation of a cluster.\n\nThis class enforces type checking + and value constraints, and converts\nbetween the internal object model and + the API representation of a Cluster." + properties: + api_address: + description: |- + The endpoint URL of COE API exposed to end-users. + type: string + cluster_template_id: + description: |- + The UUID of the cluster template. + type: string + coe_version: + description: |- + Version info of chosen COE in cluster for helping client in picking + the right version of client. + type: string + container_version: + type: string + create_timeout: + description: |- + The timeout for cluster creation in minutes. The value expected is a + positive integer and the default is 60 minutes. If the timeout is reached + during cluster creation process, the operation will be aborted and the + cluster status will be set to `CREATE_FAILED`. + type: integer + created_at: + format: date-time + type: string + discovery_url: + description: |- + The custom discovery url for node discovery. This is used by the COE to + discover the servers that have been created to host the containers. The + actual discovery mechanism varies with the COE. In some cases, Magnum fills + in the server info in the discovery service. In other cases, if the + `discovery_url` is not specified, Magnum will use the public discovery + service at: + + ``` + https://discovery.etcd.io + ``` + + In this case, Magnum will generate a unique url here for each uster and + store the info for the servers. + type: string + docker_volume_size: + minimum: 1 + type: integer + faults: + additionalProperties: + type: string + type: object + fixed_network: + maxLength: 255 + minLength: 1 + type: string + fixed_subnet: + maxLength: 255 + minLength: 1 + type: string + flavor_id: + maxLength: 255 + minLength: 1 + type: string + floating_ip_enabled: + description: |- + Whether enable or not using the floating IP of cloud provider. Some + cloud providers used floating IP, some used public IP, thus Magnum + provide this option for specifying the choice of using floating IP. + If it’s not set, the value of floating_ip_enabled in template + will be used. + format: boolean + type: string + health_status: + enum: + - HEALTHY + - UNHEALTHY + - UNKNOWN + type: string + health_status_reason: + additionalProperties: + type: string + type: object + keypair: + description: |- + The name of the SSH keypair to configure in the cluster servers + for ssh access. Users will need the key to be able to ssh to the servers in + the cluster. The login name is specific to the cluster driver, for + example with fedora-atomic image, default login name is `fedora`. + maxLength: 255 + minLength: 1 + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + description: |- + Links to the resources in question. + items: + description: |- + A link representation. + properties: + created_at: + description: |- + The date and time when the resource was created. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + description: |- + The date and time when the resource was updated. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. In the previous example, the offset value is `-05:00`. + + If the `updated_at` date and time stamp is not set, its value is + `null`. + format: date-time + type: string + type: object + type: array + master_addresses: + description: |- + List of floating IP of all master nodes. + items: + type: string + type: array + master_count: + description: |- + The number of servers that will serve as master for the cluster. The + default is 1. Set to more than 1 master to enable High Availability. If + the option `master-lb-enabled` is specified in the cluster + template, the master servers will be placed in a load balancer pool. + minimum: 1 + type: integer + master_flavor_id: + maxLength: 255 + minLength: 1 + type: string + master_lb_enabled: + description: |- + Since multiple masters may exist in a cluster, a Neutron load balancer + is created to provide the API endpoint for the cluster and to direct + requests to the masters. In some cases, such as when the LBaaS service is + not available, this option can be set to `false` to create a cluster + without the load balancer. In this case, one of the masters will serve as + the API endpoint. The default is `true`, i.e. to create the load + balancer for the cluster. + format: boolean + type: string + merge_labels: + format: boolean + type: string + name: + description: |- + Name of the resource. + maxLength: 242 + minLength: 1 + type: string + node_addresses: + description: |- + List of floating IP of all servers that serve as node. + items: + type: string + type: array + node_count: + description: |- + The number of servers that will serve as node in the cluster. The + default is 1. + type: integer + project_id: + type: string + stack_id: + description: |- + The reference UUID of orchestration stack from Heat orchestration service. + type: string + status: + description: |- + The current state of the cluster. + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + description: |- + The reason of cluster current status. + type: string + updated_at: + format: date-time + type: string + user_id: + type: string + uuid: + description: |- + The UUID of the cluster. + format: uuid + type: string + required: + - cluster_template_id + type: object + ClusterTemplate: + description: "API representation of a ClusterTemplate.\n\nThis class enforces + type checking and value constraints, and converts\nbetween the internal object + model and the API representation of\na ClusterTemplate." + properties: + apiserver_port: + maximum: 65535 + minimum: 1024 + type: integer + cluster_distro: + maxLength: 255 + minLength: 1 + type: string + coe: + description: |- + Specify the Container Orchestration Engine to use. Supported COEs + include `kubernetes`. If your environment has additional cluster drivers + installed, refer to the cluster driver documentation for the new COE names. + enum: + - kubernetes + type: string + created_at: + format: date-time + type: string + dns_nameserver: + description: |- + The DNS nameserver for the servers and containers in the cluster to + use. This is configured in the private Neutron network for the cluster. + The default is `8.8.8.8`. + format: dnslist + type: string + docker_storage_driver: + description: |- + The name of a driver to manage the storage for the images and the + container’s writable layer. The default is `devicemapper`. + maxLength: 255 + minLength: 1 + type: string + docker_volume_size: + description: |- + The size in GB for the local storage on each server for the Docker daemon + to cache the images and host the containers. Cinder volumes provide the + storage. The default is 25 GB. For the `devicemapper` storage driver, + the minimum value is 3GB. For the `overlay` storage driver, the minimum + value is 1GB. + minimum: 1 + type: integer + driver: + maxLength: 255 + type: string + external_network_id: + description: |- + The name or network ID of a Neutron network to provide connectivity to the + external internet for the cluster. This network must be an external + network, i.e. its attribute `router:external` must be `True`. The + servers in the cluster will be connected to a private network and + Magnum will create a router between this private network and the external + network. This will allow the servers to download images, access discovery + service, etc, and the containers to install packages, etc. In the opposite + direction, floating IPs will be allocated from the external network to + provide access from the external internet to servers and the container + services hosted in the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_network: + description: |- + The name or network ID of a Neutron network to provide connectivity to + the internal network for the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_subnet: + description: |- + Fixed subnet that are using to allocate network address for nodes in + cluster. + maxLength: 255 + minLength: 1 + type: string + flavor_id: + description: |- + The nova flavor ID or name for booting the node servers. The default is + `m1.small`. + maxLength: 255 + minLength: 1 + type: string + floating_ip_enabled: + description: |- + Whether enable or not using the floating IP of cloud provider. Some + cloud providers used floating IP, some used public IP, thus Magnum + provide this option for specifying the choice of using floating IP. + format: boolean + type: string + hidden: + description: |- + Indicates whether the ClusterTemplate is hidden or not, the default + value is false. + format: boolean + type: string + http_proxy: + description: |- + The IP address for a proxy to use when direct http access from the servers + to sites on the external internet is blocked. This may happen in certain + countries or enterprises, and the proxy allows the servers and + containers to access these sites. The format is a URL including a port + number. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + https_proxy: + description: |- + The IP address for a proxy to use when direct https access from the + servers to sites on the external internet is blocked. This may happen in + certain countries or enterprises, and the proxy allows the servers and + containers to access these sites. The format is a URL including a port + number. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + image_id: + description: |- + The name or UUID of the base image in Glance to boot the servers for the + cluster. The image must have the attribute `os_distro` defined as + appropriate for the cluster driver. + maxLength: 255 + minLength: 1 + type: string + insecure_registry: + description: |- + The URL pointing to users’s own private insecure docker registry to + deploy and run docker containers. + maxLength: 255 + minLength: 1 + type: string + keypair_id: + description: |- + The name of the SSH keypair to configure in the cluster servers + for ssh access. Users will need the key to be able to ssh to the servers in + the cluster. The login name is specific to the cluster driver, for + example with fedora-atomic image, default login name is `fedora`. + maxLength: 255 + minLength: 1 + type: string + labels: + additionalProperties: + format: + type: string + description: |- + Arbitrary labels in the form of `key=value` pairs. The accepted keys and + valid values are defined in the cluster drivers. They are used as a way + to pass additional parameters that are specific to a cluster driver. + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + master_flavor_id: + description: |- + The flavor of the master node for this cluster template. + maxLength: 255 + minLength: 1 + type: string + master_lb_enabled: + description: |- + Since multiple masters may exist in a cluster, a Neutron load balancer + is created to provide the API endpoint for the cluster and to direct + requests to the masters. In some cases, such as when the LBaaS service is + not available, this option can be set to `false` to create a cluster + without the load balancer. In this case, one of the masters will serve as + the API endpoint. The default is `true`, i.e. to create the load + balancer for the cluster. + format: boolean + type: string + name: + description: |- + Name of the resource. + maxLength: 255 + minLength: 1 + type: string + network_driver: + description: |- + The name of a network driver for providing the networks for the containers. + Note that this is different and separate from the Neutron network for the + cluster. The operation and networking model are specific to the + particular driver. + maxLength: 255 + minLength: 1 + type: string + no_proxy: + description: |- + When a proxy server is used, some sites should not go through the proxy + and should be accessed normally. In this case, users can specify these + sites as a comma separated list of IPs. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + project_id: + type: string + public: + description: |- + Access to a cluster template is normally limited to the admin, + owner or users within the same tenant as the owners. Setting this flag + makes the cluster template public and accessible by other users. + The default is not public. + format: boolean + type: string + registry_enabled: + description: |- + Docker images by default are pulled from the public Docker registry, + but in some cases, users may want to use a private registry. This option + provides an alternative registry based on the Registry V2: Magnum will + create a local registry in the cluster backed by swift to host the + images. The default is to use the public registry. + format: boolean + type: string + server_type: + description: |- + The servers in the cluster can be `vm` or `baremetal`. This + parameter selects the type of server to create for the cluster. + The default is `vm`. + enum: + - bm + - vm + type: string + tags: + description: |- + Administrator tags for the cluster template. + maxLength: 255 + type: string + tls_disabled: + description: |- + Transport Layer Security (TLS) is normally enabled to secure the + cluster. In some cases, users may want to disable TLS in the + cluster, for instance during development or to troubleshoot certain + problems. Specifying this parameter will disable TLS so that users can + access the COE endpoints without a certificate. The default is TLS enabled. + format: boolean + type: string + updated_at: + format: date-time + type: string + user_id: + type: string + uuid: + format: uuid + type: string + volume_driver: + description: |- + The name of a volume driver for managing the persistent storage for the containers. The functionality supported are specific to the driver. + maxLength: 255 + minLength: 1 + type: string + required: + - image_id + type: object + ClusterUpgradeRequest: + description: "API object for handling upgrade requests.\n\nThis class enforces + type checking and value constraints." + properties: + cluster_template: + maxLength: 255 + minLength: 1 + type: string + created_at: + format: date-time + type: string + max_batch_size: + minimum: 1 + type: integer + nodegroup: + maxLength: 255 + minLength: 1 + type: string + updated_at: + format: date-time + type: string + type: object + ClustersActionsResizeResponse: + description: "API representation of a cluster ID\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a cluster\nID." + properties: + uuid: + format: uuid + type: string + type: object + ClustersActionsUpgradeResponse: + description: "API representation of a cluster ID\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a cluster\nID." + properties: + uuid: + format: uuid + type: string + type: object + ClustersCreateResponse: + description: "API representation of a cluster ID\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a cluster\nID." + properties: + uuid: + description: |- + The UUID of the cluster. + format: uuid + type: string + type: object + ClustersListResponse: + description: API representation of a collection of clusters. + properties: + clusters: + description: |- + The list of all clusters in Magnum. + items: + description: |- + API representation of a cluster. + + This class enforces type checking and value constraints, and converts + between the internal object model and the API representation of a Cluster. + properties: + api_address: + type: string + cluster_template_id: + description: |- + The UUID of the cluster template. + type: string + coe_version: + type: string + container_version: + type: string + create_timeout: + description: |- + The timeout for cluster creation in minutes. The value expected is a + positive integer and the default is 60 minutes. If the timeout is reached + during cluster creation process, the operation will be aborted and the + cluster status will be set to `CREATE_FAILED`. + type: integer + created_at: + format: date-time + type: string + discovery_url: + type: string + docker_volume_size: + minimum: 1 + type: integer + faults: + additionalProperties: + type: string + type: object + fixed_network: + maxLength: 255 + minLength: 1 + type: string + fixed_subnet: + maxLength: 255 + minLength: 1 + type: string + flavor_id: + maxLength: 255 + minLength: 1 + type: string + floating_ip_enabled: + format: boolean + type: string + health_status: + enum: + - HEALTHY + - UNHEALTHY + - UNKNOWN + type: string + health_status_reason: + additionalProperties: + type: string + type: object + keypair: + description: |- + The name of the SSH keypair to configure in the cluster servers + for ssh access. Users will need the key to be able to ssh to the servers in + the cluster. The login name is specific to the cluster driver, for + example with fedora-atomic image, default login name is `fedora`. + maxLength: 255 + minLength: 1 + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + description: |- + Links to the resources in question. + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + master_addresses: + items: + type: string + type: array + master_count: + description: |- + The number of servers that will serve as master for the cluster. The + default is 1. Set to more than 1 master to enable High Availability. If + the option `master-lb-enabled` is specified in the cluster + template, the master servers will be placed in a load balancer pool. + minimum: 1 + type: integer + master_flavor_id: + maxLength: 255 + minLength: 1 + type: string + master_lb_enabled: + format: boolean + type: string + merge_labels: + format: boolean + type: string + name: + description: |- + Name of the resource. + maxLength: 242 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + description: |- + The number of servers that will serve as node in the cluster. The + default is 1. + type: integer + project_id: + type: string + stack_id: + description: |- + The reference UUID of orchestration stack from Heat orchestration service. + type: string + status: + description: |- + The current state of the cluster. + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + user_id: + type: string + uuid: + description: |- + The UUID of the cluster. + format: uuid + type: string + required: + - cluster_template_id + type: object + type: array + created_at: + format: date-time + type: string + next: + type: string + updated_at: + format: date-time + type: string + type: object + ClustersNodegroupPatchRequest: + items: + description: |- + A complex type that represents a single json-patch operation. + properties: + op: + enum: + - add + - remove + - replace + type: string + path: + type: string + value: + format: + type: string + required: + - op + - path + type: object + type: array + ClustersNodegroupPatchResponse: + description: "API representation of a Node group.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of NodeGroup." + properties: + cluster_id: + format: uuid + type: string + created_at: + format: date-time + type: string + docker_volume_size: + minimum: 1 + type: integer + flavor_id: + maxLength: 255 + minLength: 1 + type: string + id: + minimum: 1 + type: integer + image_id: + maxLength: 255 + minLength: 1 + type: string + is_default: + format: boolean + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + max_node_count: + type: integer + merge_labels: + format: boolean + type: string + min_node_count: + type: integer + name: + maxLength: 255 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + type: integer + project_id: + type: string + role: + maxLength: 255 + minLength: 1 + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + version: + type: string + type: object + ClustersNodegroupShowResponse: + description: "API representation of a Node group.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of NodeGroup." + properties: + cluster_id: + format: uuid + type: string + created_at: + format: date-time + type: string + docker_volume_size: + minimum: 1 + type: integer + flavor_id: + maxLength: 255 + minLength: 1 + type: string + id: + minimum: 1 + type: integer + image_id: + maxLength: 255 + minLength: 1 + type: string + is_default: + format: boolean + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + max_node_count: + type: integer + merge_labels: + format: boolean + type: string + min_node_count: + type: integer + name: + maxLength: 255 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + type: integer + project_id: + type: string + role: + maxLength: 255 + minLength: 1 + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + version: + type: string + type: object + ClustersNodegroupsCreateResponse: + description: "API representation of a Node group.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of NodeGroup." + properties: + cluster_id: + format: uuid + type: string + created_at: + format: date-time + type: string + docker_volume_size: + minimum: 1 + type: integer + flavor_id: + maxLength: 255 + minLength: 1 + type: string + id: + minimum: 1 + type: integer + image_id: + maxLength: 255 + minLength: 1 + type: string + is_default: + format: boolean + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + max_node_count: + type: integer + merge_labels: + format: boolean + type: string + min_node_count: + type: integer + name: + maxLength: 255 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + type: integer + project_id: + type: string + role: + maxLength: 255 + minLength: 1 + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + version: + type: string + type: object + ClustersNodegroupsGet_AllRequest: + description: Request of the clusters/nodegroups:post operation + type: object + x-openstack: + action-name: get_all + ClustersNodegroupsGet_AllResponse: + description: API representation of a collection of Node Groups. + properties: + created_at: + format: date-time + type: string + next: + type: string + nodegroups: + items: + description: |- + API representation of a Node group. + + This class enforces type checking and value constraints, and converts + between the internal object model and the API representation of NodeGroup. + properties: + cluster_id: + format: uuid + type: string + created_at: + format: date-time + type: string + docker_volume_size: + minimum: 1 + type: integer + flavor_id: + maxLength: 255 + minLength: 1 + type: string + id: + minimum: 1 + type: integer + image_id: + maxLength: 255 + minLength: 1 + type: string + is_default: + format: boolean + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + max_node_count: + type: integer + merge_labels: + format: boolean + type: string + min_node_count: + type: integer + name: + maxLength: 255 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + type: integer + project_id: + type: string + role: + maxLength: 255 + minLength: 1 + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + version: + type: string + type: object + type: array + updated_at: + format: date-time + type: string + type: object + ClustersNodegroupsGet_OneRequest: + description: Request of the clusters/nodegroups:post operation + type: object + x-openstack: + action-name: get_one + ClustersNodegroupsGet_OneResponse: + description: "API representation of a Node group.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of NodeGroup." + properties: + cluster_id: + format: uuid + type: string + created_at: + format: date-time + type: string + docker_volume_size: + minimum: 1 + type: integer + flavor_id: + maxLength: 255 + minLength: 1 + type: string + id: + minimum: 1 + type: integer + image_id: + maxLength: 255 + minLength: 1 + type: string + is_default: + format: boolean + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + max_node_count: + type: integer + merge_labels: + format: boolean + type: string + min_node_count: + type: integer + name: + maxLength: 255 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + type: integer + project_id: + type: string + role: + maxLength: 255 + minLength: 1 + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + version: + type: string + type: object + ClustersNodegroupsListResponse: + description: API representation of a collection of Node Groups. + properties: + created_at: + format: date-time + type: string + next: + type: string + nodegroups: + items: + description: |- + API representation of a Node group. + + This class enforces type checking and value constraints, and converts + between the internal object model and the API representation of NodeGroup. + properties: + cluster_id: + format: uuid + type: string + created_at: + format: date-time + type: string + docker_volume_size: + minimum: 1 + type: integer + flavor_id: + maxLength: 255 + minLength: 1 + type: string + id: + minimum: 1 + type: integer + image_id: + maxLength: 255 + minLength: 1 + type: string + is_default: + format: boolean + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + max_node_count: + type: integer + merge_labels: + format: boolean + type: string + min_node_count: + type: integer + name: + maxLength: 255 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + type: integer + project_id: + type: string + role: + maxLength: 255 + minLength: 1 + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + version: + type: string + type: object + type: array + updated_at: + format: date-time + type: string + type: object + ClustersNodegroupsPostResponse: + description: "API representation of a Node group.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of NodeGroup." + properties: + cluster_id: + format: uuid + type: string + created_at: + format: date-time + type: string + docker_volume_size: + minimum: 1 + type: integer + flavor_id: + maxLength: 255 + minLength: 1 + type: string + id: + minimum: 1 + type: integer + image_id: + maxLength: 255 + minLength: 1 + type: string + is_default: + format: boolean + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + max_node_count: + type: integer + merge_labels: + format: boolean + type: string + min_node_count: + type: integer + name: + maxLength: 255 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + type: integer + project_id: + type: string + role: + maxLength: 255 + minLength: 1 + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + version: + type: string + type: object + ClustersPostResponse: + description: "API representation of a cluster ID\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a cluster\nID." + properties: + uuid: + format: uuid + type: string + type: object + ClustertemplateShowResponse: + description: "API representation of a ClusterTemplate.\n\nThis class enforces + type checking and value constraints, and converts\nbetween the internal object + model and the API representation of\na ClusterTemplate." + properties: + apiserver_port: + description: |- + The exposed port of COE API server. + maximum: 65535 + minimum: 1024 + type: integer + cluster_distro: + description: |- + Display the attribute `os_distro` defined as appropriate metadata in + image for the cluster driver. + maxLength: 255 + minLength: 1 + type: string + coe: + description: |- + Specify the Container Orchestration Engine to use. Supported COEs + include `kubernetes`. If your environment has additional cluster drivers + installed, refer to the cluster driver documentation for the new COE names. + enum: + - kubernetes + type: string + created_at: + format: date-time + type: string + dns_nameserver: + description: |- + The DNS nameserver for the servers and containers in the cluster to + use. This is configured in the private Neutron network for the cluster. + The default is `8.8.8.8`. + format: dnslist + type: string + docker_storage_driver: + description: |- + The name of a driver to manage the storage for the images and the + container’s writable layer. The default is `devicemapper`. + maxLength: 255 + minLength: 1 + type: string + docker_volume_size: + description: |- + The size in GB for the local storage on each server for the Docker daemon + to cache the images and host the containers. Cinder volumes provide the + storage. The default is 25 GB. For the `devicemapper` storage driver, + the minimum value is 3GB. For the `overlay` storage driver, the minimum + value is 1GB. + minimum: 1 + type: integer + driver: + maxLength: 255 + type: string + external_network_id: + description: |- + The name or network ID of a Neutron network to provide connectivity to the + external internet for the cluster. This network must be an external + network, i.e. its attribute `router:external` must be `True`. The + servers in the cluster will be connected to a private network and + Magnum will create a router between this private network and the external + network. This will allow the servers to download images, access discovery + service, etc, and the containers to install packages, etc. In the opposite + direction, floating IPs will be allocated from the external network to + provide access from the external internet to servers and the container + services hosted in the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_network: + description: |- + The name or network ID of a Neutron network to provide connectivity to + the internal network for the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_subnet: + description: |- + Fixed subnet that are using to allocate network address for nodes in + cluster. + maxLength: 255 + minLength: 1 + type: string + flavor_id: + description: |- + The nova flavor ID or name for booting the node servers. The default is + `m1.small`. + maxLength: 255 + minLength: 1 + type: string + floating_ip_enabled: + description: |- + Whether enable or not using the floating IP of cloud provider. Some + cloud providers used floating IP, some used public IP, thus Magnum + provide this option for specifying the choice of using floating IP. + format: boolean + type: string + hidden: + description: |- + Indicates whether the ClusterTemplate is hidden or not, the default + value is false. + format: boolean + type: string + http_proxy: + description: |- + The IP address for a proxy to use when direct http access from the servers + to sites on the external internet is blocked. This may happen in certain + countries or enterprises, and the proxy allows the servers and + containers to access these sites. The format is a URL including a port + number. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + https_proxy: + description: |- + The IP address for a proxy to use when direct https access from the + servers to sites on the external internet is blocked. This may happen in + certain countries or enterprises, and the proxy allows the servers and + containers to access these sites. The format is a URL including a port + number. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + image_id: + description: |- + The name or UUID of the base image in Glance to boot the servers for the + cluster. The image must have the attribute `os_distro` defined as + appropriate for the cluster driver. + maxLength: 255 + minLength: 1 + type: string + insecure_registry: + description: |- + The URL pointing to users’s own private insecure docker registry to + deploy and run docker containers. + maxLength: 255 + minLength: 1 + type: string + keypair_id: + description: |- + The name of the SSH keypair to configure in the cluster servers + for ssh access. Users will need the key to be able to ssh to the servers in + the cluster. The login name is specific to the cluster driver, for + example with fedora-atomic image, default login name is `fedora`. + maxLength: 255 + minLength: 1 + type: string + labels: + additionalProperties: + format: + type: string + description: |- + Arbitrary labels in the form of `key=value` pairs. The accepted keys and + valid values are defined in the cluster drivers. They are used as a way + to pass additional parameters that are specific to a cluster driver. + type: object + links: + description: |- + Links to the resources in question. + items: + description: |- + A link representation. + properties: + created_at: + description: |- + The date and time when the resource was created. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + description: |- + The date and time when the resource was updated. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. In the previous example, the offset value is `-05:00`. + + If the `updated_at` date and time stamp is not set, its value is + `null`. + format: date-time + type: string + type: object + type: array + master_flavor_id: + description: |- + The flavor of the master node for this cluster template. + maxLength: 255 + minLength: 1 + type: string + master_lb_enabled: + description: |- + Since multiple masters may exist in a cluster, a Neutron load balancer + is created to provide the API endpoint for the cluster and to direct + requests to the masters. In some cases, such as when the LBaaS service is + not available, this option can be set to `false` to create a cluster + without the load balancer. In this case, one of the masters will serve as + the API endpoint. The default is `true`, i.e. to create the load + balancer for the cluster. + format: boolean + type: string + name: + description: |- + Name of the resource. + maxLength: 255 + minLength: 1 + type: string + network_driver: + description: |- + The name of a network driver for providing the networks for the containers. + Note that this is different and separate from the Neutron network for the + cluster. The operation and networking model are specific to the + particular driver. + maxLength: 255 + minLength: 1 + type: string + no_proxy: + description: |- + When a proxy server is used, some sites should not go through the proxy + and should be accessed normally. In this case, users can specify these + sites as a comma separated list of IPs. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + project_id: + type: string + public: + description: |- + Access to a cluster template is normally limited to the admin, + owner or users within the same tenant as the owners. Setting this flag + makes the cluster template public and accessible by other users. + The default is not public. + format: boolean + type: string + registry_enabled: + description: |- + Docker images by default are pulled from the public Docker registry, + but in some cases, users may want to use a private registry. This option + provides an alternative registry based on the Registry V2: Magnum will + create a local registry in the cluster backed by swift to host the + images. The default is to use the public registry. + format: boolean + type: string + server_type: + description: |- + The servers in the cluster can be `vm` or `baremetal`. This + parameter selects the type of server to create for the cluster. + The default is `vm`. + enum: + - bm + - vm + type: string + tags: + description: |- + Administrator tags for the cluster template. + maxLength: 255 + type: string + tls_disabled: + description: |- + Transport Layer Security (TLS) is normally enabled to secure the + cluster. In some cases, users may want to disable TLS in the + cluster, for instance during development or to troubleshoot certain + problems. Specifying this parameter will disable TLS so that users can + access the COE endpoints without a certificate. The default is TLS enabled. + format: boolean + type: string + updated_at: + format: date-time + type: string + user_id: + type: string + uuid: + description: |- + The UUID of the cluster template. + format: uuid + type: string + volume_driver: + description: |- + The name of a volume driver for managing the persistent storage for the containers. The functionality supported are specific to the driver. + maxLength: 255 + minLength: 1 + type: string + required: + - image_id + type: object + ClustertemplatesCreateResponse: + description: "API representation of a ClusterTemplate.\n\nThis class enforces + type checking and value constraints, and converts\nbetween the internal object + model and the API representation of\na ClusterTemplate." + properties: + apiserver_port: + description: |- + The exposed port of COE API server. + maximum: 65535 + minimum: 1024 + type: integer + cluster_distro: + description: |- + Display the attribute `os_distro` defined as appropriate metadata in + image for the cluster driver. + maxLength: 255 + minLength: 1 + type: string + coe: + description: |- + Specify the Container Orchestration Engine to use. Supported COEs + include `kubernetes`. If your environment has additional cluster drivers + installed, refer to the cluster driver documentation for the new COE names. + enum: + - kubernetes + type: string + created_at: + format: date-time + type: string + dns_nameserver: + description: |- + The DNS nameserver for the servers and containers in the cluster to + use. This is configured in the private Neutron network for the cluster. + The default is `8.8.8.8`. + format: dnslist + type: string + docker_storage_driver: + description: |- + The name of a driver to manage the storage for the images and the + container’s writable layer. The default is `devicemapper`. + maxLength: 255 + minLength: 1 + type: string + docker_volume_size: + description: |- + The size in GB for the local storage on each server for the Docker daemon + to cache the images and host the containers. Cinder volumes provide the + storage. The default is 25 GB. For the `devicemapper` storage driver, + the minimum value is 3GB. For the `overlay` storage driver, the minimum + value is 1GB. + minimum: 1 + type: integer + driver: + maxLength: 255 + type: string + external_network_id: + description: |- + The name or network ID of a Neutron network to provide connectivity to the + external internet for the cluster. This network must be an external + network, i.e. its attribute `router:external` must be `True`. The + servers in the cluster will be connected to a private network and + Magnum will create a router between this private network and the external + network. This will allow the servers to download images, access discovery + service, etc, and the containers to install packages, etc. In the opposite + direction, floating IPs will be allocated from the external network to + provide access from the external internet to servers and the container + services hosted in the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_network: + description: |- + The name or network ID of a Neutron network to provide connectivity to + the internal network for the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_subnet: + description: |- + Fixed subnet that are using to allocate network address for nodes in + cluster. + maxLength: 255 + minLength: 1 + type: string + flavor_id: + description: |- + The nova flavor ID or name for booting the node servers. The default is + `m1.small`. + maxLength: 255 + minLength: 1 + type: string + floating_ip_enabled: + description: |- + Whether enable or not using the floating IP of cloud provider. Some + cloud providers used floating IP, some used public IP, thus Magnum + provide this option for specifying the choice of using floating IP. + format: boolean + type: string + hidden: + description: |- + Indicates whether the ClusterTemplate is hidden or not, the default + value is false. + format: boolean + type: string + http_proxy: + description: |- + The IP address for a proxy to use when direct http access from the servers + to sites on the external internet is blocked. This may happen in certain + countries or enterprises, and the proxy allows the servers and + containers to access these sites. The format is a URL including a port + number. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + https_proxy: + description: |- + The IP address for a proxy to use when direct https access from the + servers to sites on the external internet is blocked. This may happen in + certain countries or enterprises, and the proxy allows the servers and + containers to access these sites. The format is a URL including a port + number. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + image_id: + description: |- + The name or UUID of the base image in Glance to boot the servers for the + cluster. The image must have the attribute `os_distro` defined as + appropriate for the cluster driver. + maxLength: 255 + minLength: 1 + type: string + insecure_registry: + description: |- + The URL pointing to users’s own private insecure docker registry to + deploy and run docker containers. + maxLength: 255 + minLength: 1 + type: string + keypair_id: + description: |- + The name of the SSH keypair to configure in the cluster servers + for ssh access. Users will need the key to be able to ssh to the servers in + the cluster. The login name is specific to the cluster driver, for + example with fedora-atomic image, default login name is `fedora`. + maxLength: 255 + minLength: 1 + type: string + labels: + additionalProperties: + format: + type: string + description: |- + Arbitrary labels in the form of `key=value` pairs. The accepted keys and + valid values are defined in the cluster drivers. They are used as a way + to pass additional parameters that are specific to a cluster driver. + type: object + links: + description: |- + Links to the resources in question. + items: + description: |- + A link representation. + properties: + created_at: + description: |- + The date and time when the resource was created. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + description: |- + The date and time when the resource was updated. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. In the previous example, the offset value is `-05:00`. + + If the `updated_at` date and time stamp is not set, its value is + `null`. + format: date-time + type: string + type: object + type: array + master_flavor_id: + description: |- + The flavor of the master node for this cluster template. + maxLength: 255 + minLength: 1 + type: string + master_lb_enabled: + description: |- + Since multiple masters may exist in a cluster, a Neutron load balancer + is created to provide the API endpoint for the cluster and to direct + requests to the masters. In some cases, such as when the LBaaS service is + not available, this option can be set to `false` to create a cluster + without the load balancer. In this case, one of the masters will serve as + the API endpoint. The default is `true`, i.e. to create the load + balancer for the cluster. + format: boolean + type: string + name: + description: |- + Name of the resource. + maxLength: 255 + minLength: 1 + type: string + network_driver: + description: |- + The name of a network driver for providing the networks for the containers. + Note that this is different and separate from the Neutron network for the + cluster. The operation and networking model are specific to the + particular driver. + maxLength: 255 + minLength: 1 + type: string + no_proxy: + description: |- + When a proxy server is used, some sites should not go through the proxy + and should be accessed normally. In this case, users can specify these + sites as a comma separated list of IPs. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + project_id: + type: string + public: + description: |- + Access to a cluster template is normally limited to the admin, + owner or users within the same tenant as the owners. Setting this flag + makes the cluster template public and accessible by other users. + The default is not public. + format: boolean + type: string + registry_enabled: + description: |- + Docker images by default are pulled from the public Docker registry, + but in some cases, users may want to use a private registry. This option + provides an alternative registry based on the Registry V2: Magnum will + create a local registry in the cluster backed by swift to host the + images. The default is to use the public registry. + format: boolean + type: string + server_type: + description: |- + The servers in the cluster can be `vm` or `baremetal`. This + parameter selects the type of server to create for the cluster. + The default is `vm`. + enum: + - bm + - vm + type: string + tags: + description: |- + Administrator tags for the cluster template. + maxLength: 255 + type: string + tls_disabled: + description: |- + Transport Layer Security (TLS) is normally enabled to secure the + cluster. In some cases, users may want to disable TLS in the + cluster, for instance during development or to troubleshoot certain + problems. Specifying this parameter will disable TLS so that users can + access the COE endpoints without a certificate. The default is TLS enabled. + format: boolean + type: string + updated_at: + format: date-time + type: string + user_id: + type: string + uuid: + description: |- + The UUID of the cluster template. + format: uuid + type: string + volume_driver: + description: |- + The name of a volume driver for managing the persistent storage for the containers. The functionality supported are specific to the driver. + maxLength: 255 + minLength: 1 + type: string + required: + - image_id + type: object + ClustertemplatesListResponse: + description: API representation of a collection of ClusterTemplates. + properties: + clustertemplates: + description: |- + The list of all cluster templates in Magnum. + items: + description: |- + API representation of a ClusterTemplate. + + This class enforces type checking and value constraints, and converts + between the internal object model and the API representation of + a ClusterTemplate. + properties: + apiserver_port: + description: |- + The exposed port of COE API server. + maximum: 65535 + minimum: 1024 + type: integer + cluster_distro: + description: |- + Display the attribute `os_distro` defined as appropriate metadata in + image for the cluster driver. + maxLength: 255 + minLength: 1 + type: string + coe: + description: |- + Specify the Container Orchestration Engine to use. Supported COEs + include `kubernetes`. If your environment has additional cluster drivers + installed, refer to the cluster driver documentation for the new COE names. + enum: + - kubernetes + type: string + created_at: + format: date-time + type: string + dns_nameserver: + description: |- + The DNS nameserver for the servers and containers in the cluster to + use. This is configured in the private Neutron network for the cluster. + The default is `8.8.8.8`. + format: dnslist + type: string + docker_storage_driver: + description: |- + The name of a driver to manage the storage for the images and the + container’s writable layer. The default is `devicemapper`. + maxLength: 255 + minLength: 1 + type: string + docker_volume_size: + description: |- + The size in GB for the local storage on each server for the Docker daemon + to cache the images and host the containers. Cinder volumes provide the + storage. The default is 25 GB. For the `devicemapper` storage driver, + the minimum value is 3GB. For the `overlay` storage driver, the minimum + value is 1GB. + minimum: 1 + type: integer + driver: + maxLength: 255 + type: string + external_network_id: + description: |- + The name or network ID of a Neutron network to provide connectivity to the + external internet for the cluster. This network must be an external + network, i.e. its attribute `router:external` must be `True`. The + servers in the cluster will be connected to a private network and + Magnum will create a router between this private network and the external + network. This will allow the servers to download images, access discovery + service, etc, and the containers to install packages, etc. In the opposite + direction, floating IPs will be allocated from the external network to + provide access from the external internet to servers and the container + services hosted in the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_network: + description: |- + The name or network ID of a Neutron network to provide connectivity to + the internal network for the cluster. + maxLength: 255 + minLength: 1 + type: string + fixed_subnet: + description: |- + Fixed subnet that are using to allocate network address for nodes in + cluster. + maxLength: 255 + minLength: 1 + type: string + flavor_id: + description: |- + The nova flavor ID or name for booting the node servers. The default is + `m1.small`. + maxLength: 255 + minLength: 1 + type: string + floating_ip_enabled: + description: |- + Whether enable or not using the floating IP of cloud provider. Some + cloud providers used floating IP, some used public IP, thus Magnum + provide this option for specifying the choice of using floating IP. + format: boolean + type: string + hidden: + description: |- + Indicates whether the ClusterTemplate is hidden or not, the default + value is false. + format: boolean + type: string + http_proxy: + description: |- + The IP address for a proxy to use when direct http access from the servers + to sites on the external internet is blocked. This may happen in certain + countries or enterprises, and the proxy allows the servers and + containers to access these sites. The format is a URL including a port + number. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + https_proxy: + description: |- + The IP address for a proxy to use when direct https access from the + servers to sites on the external internet is blocked. This may happen in + certain countries or enterprises, and the proxy allows the servers and + containers to access these sites. The format is a URL including a port + number. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + image_id: + description: |- + The name or UUID of the base image in Glance to boot the servers for the + cluster. The image must have the attribute `os_distro` defined as + appropriate for the cluster driver. + maxLength: 255 + minLength: 1 + type: string + insecure_registry: + description: |- + The URL pointing to users’s own private insecure docker registry to + deploy and run docker containers. + maxLength: 255 + minLength: 1 + type: string + keypair_id: + description: |- + The name of the SSH keypair to configure in the cluster servers + for ssh access. Users will need the key to be able to ssh to the servers in + the cluster. The login name is specific to the cluster driver, for + example with fedora-atomic image, default login name is `fedora`. + maxLength: 255 + minLength: 1 + type: string + labels: + additionalProperties: + format: + type: string + description: |- + Arbitrary labels in the form of `key=value` pairs. The accepted keys and + valid values are defined in the cluster drivers. They are used as a way + to pass additional parameters that are specific to a cluster driver. + type: object + links: + description: |- + Links to the resources in question. + items: + description: |- + A link representation. + properties: + created_at: + description: |- + The date and time when the resource was created. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + description: |- + The date and time when the resource was updated. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. In the previous example, the offset value is `-05:00`. + + If the `updated_at` date and time stamp is not set, its value is + `null`. + format: date-time + type: string + type: object + type: array + master_flavor_id: + description: |- + The flavor of the master node for this cluster template. + maxLength: 255 + minLength: 1 + type: string + master_lb_enabled: + description: |- + Since multiple masters may exist in a cluster, a Neutron load balancer + is created to provide the API endpoint for the cluster and to direct + requests to the masters. In some cases, such as when the LBaaS service is + not available, this option can be set to `false` to create a cluster + without the load balancer. In this case, one of the masters will serve as + the API endpoint. The default is `true`, i.e. to create the load + balancer for the cluster. + format: boolean + type: string + name: + description: |- + Name of the resource. + maxLength: 255 + minLength: 1 + type: string + network_driver: + description: |- + The name of a network driver for providing the networks for the containers. + Note that this is different and separate from the Neutron network for the + cluster. The operation and networking model are specific to the + particular driver. + maxLength: 255 + minLength: 1 + type: string + no_proxy: + description: |- + When a proxy server is used, some sites should not go through the proxy + and should be accessed normally. In this case, users can specify these + sites as a comma separated list of IPs. The default is `None`. + maxLength: 255 + minLength: 1 + type: string + project_id: + type: string + public: + description: |- + Access to a cluster template is normally limited to the admin, + owner or users within the same tenant as the owners. Setting this flag + makes the cluster template public and accessible by other users. + The default is not public. + format: boolean + type: string + registry_enabled: + description: |- + Docker images by default are pulled from the public Docker registry, + but in some cases, users may want to use a private registry. This option + provides an alternative registry based on the Registry V2: Magnum will + create a local registry in the cluster backed by swift to host the + images. The default is to use the public registry. + format: boolean + type: string + server_type: + description: |- + The servers in the cluster can be `vm` or `baremetal`. This + parameter selects the type of server to create for the cluster. + The default is `vm`. + enum: + - bm + - vm + type: string + tags: + description: |- + Administrator tags for the cluster template. + maxLength: 255 + type: string + tls_disabled: + description: |- + Transport Layer Security (TLS) is normally enabled to secure the + cluster. In some cases, users may want to disable TLS in the + cluster, for instance during development or to troubleshoot certain + problems. Specifying this parameter will disable TLS so that users can + access the COE endpoints without a certificate. The default is TLS enabled. + format: boolean + type: string + updated_at: + format: date-time + type: string + user_id: + type: string + uuid: + description: |- + The UUID of the cluster template. + format: uuid + type: string + volume_driver: + description: |- + The name of a volume driver for managing the persistent storage for the containers. The functionality supported are specific to the driver. + maxLength: 255 + minLength: 1 + type: string + required: + - image_id + type: object + type: array + created_at: + format: date-time + type: string + next: + type: string + updated_at: + format: date-time + type: string + type: object + CredentialPatchRequest: + description: Request of the credentials/credential_id:patch operation + type: object + x-openstack: + action-name: patch + CredentialPatchResponse: + description: "API representation of a cluster ID\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a cluster\nID." + properties: + uuid: + format: uuid + type: string + type: object + Federation: + description: "API representation of a federation.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a\nFederation." + properties: + created_at: + format: date-time + type: string + hostcluster_id: + type: string + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + member_ids: + items: + type: string + type: array + name: + maxLength: 242 + minLength: 1 + type: string + properties: + additionalProperties: + type: string + type: object + status: + enum: + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + type: object + FederationShowResponse: + description: "API representation of a federation.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a\nFederation." + properties: + created_at: + format: date-time + type: string + hostcluster_id: + type: string + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + member_ids: + items: + type: string + type: array + name: + maxLength: 242 + minLength: 1 + type: string + properties: + additionalProperties: + type: string + type: object + status: + enum: + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + type: object + FederationsCreateResponse: + description: "API representation of a federation ID\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a\nfederation ID." + properties: + uuid: + format: uuid + type: string + type: object + FederationsListResponse: + description: API representation of a collection of federations. + properties: + created_at: + format: date-time + type: string + federations: + items: + description: |- + API representation of a federation. + + This class enforces type checking and value constraints, and converts + between the internal object model and the API representation of a + Federation. + properties: + created_at: + format: date-time + type: string + hostcluster_id: + type: string + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + member_ids: + items: + type: string + type: array + name: + maxLength: 242 + minLength: 1 + type: string + properties: + additionalProperties: + type: string + type: object + status: + enum: + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + type: object + type: array + next: + type: string + updated_at: + format: date-time + type: string + type: object + MservicesListResponse: + description: Base type for complex types + properties: + created_at: + format: date-time + type: string + mservices: + description: |- + A list of Magnum services. + items: + description: |- + Base type for complex types + properties: + binary: + description: |- + The name of the binary form of the Magnum service. + enum: + - magnum-conductor + type: string + created_at: + description: |- + The date and time when the resource was created. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. + format: date-time + type: string + disabled: + format: boolean + type: string + disabled_reason: + description: |- + The disable reason of the service, `null` if the service is enabled or + disabled without reason provided. + maxLength: 255 + type: string + host: + description: |- + The host for the service. + maxLength: 255 + minLength: 1 + type: string + id: + description: |- + The ID of the Magnum service. + minimum: 1 + type: integer + report_count: + description: |- + The total number of report. + type: integer + state: + description: |- + The current state of Magnum services. + enum: + - down + - up + type: string + updated_at: + description: |- + The date and time when the resource was updated. + + The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` + + For example, `2015-08-27T09:49:58-05:00`. + + The `±hh:mm` value, if included, is the time zone as an offset + from UTC. In the previous example, the offset value is `-05:00`. + + If the `updated_at` date and time stamp is not set, its value is + `null`. + format: date-time + type: string + type: object + type: array + next: + type: string + updated_at: + format: date-time + type: string + type: object + NodeGroup: + description: "API representation of a Node group.\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of NodeGroup." + properties: + cluster_id: + format: uuid + type: string + created_at: + format: date-time + type: string + docker_volume_size: + minimum: 1 + type: integer + flavor_id: + maxLength: 255 + minLength: 1 + type: string + id: + minimum: 1 + type: integer + image_id: + maxLength: 255 + minLength: 1 + type: string + is_default: + format: boolean + type: string + labels: + additionalProperties: + format: + type: string + type: object + labels_added: + additionalProperties: + format: + type: string + type: object + labels_overridden: + additionalProperties: + format: + type: string + type: object + labels_skipped: + additionalProperties: + format: + type: string + type: object + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + max_node_count: + type: integer + merge_labels: + format: boolean + type: string + min_node_count: + type: integer + name: + maxLength: 255 + minLength: 1 + type: string + node_addresses: + items: + type: string + type: array + node_count: + type: integer + project_id: + type: string + role: + maxLength: 255 + minLength: 1 + type: string + stack_id: + type: string + status: + enum: + - ADOPT_COMPLETE + - CHECK_COMPLETE + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + - RESTORE_COMPLETE + - RESUME_COMPLETE + - RESUME_FAILED + - ROLLBACK_COMPLETE + - ROLLBACK_FAILED + - ROLLBACK_IN_PROGRESS + - SNAPSHOT_COMPLETE + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_IN_PROGRESS + type: string + status_reason: + type: string + updated_at: + format: date-time + type: string + uuid: + format: uuid + type: string + version: + type: string + type: object + Quota: + description: "API representation of a project Quota.\n\nThis class enforces + type checking and value constraints, and converts\nbetween the internal object + model and the API representation of Quota." + properties: + created_at: + format: date-time + type: string + hard_limit: + type: integer + id: + minimum: 1 + type: integer + project_id: + maxLength: 255 + minLength: 1 + type: string + resource: + enum: + - Cluster + type: string + updated_at: + format: date-time + type: string + type: object + QuotaShowResponse: + description: "API representation of a project Quota.\n\nThis class enforces + type checking and value constraints, and converts\nbetween the internal object + model and the API representation of Quota." + properties: + created_at: + format: date-time + type: string + hard_limit: + type: integer + id: + minimum: 1 + type: integer + project_id: + maxLength: 255 + minLength: 1 + type: string + resource: + enum: + - Cluster + type: string + updated_at: + format: date-time + type: string + type: object + QuotasCreateResponse: + description: "API representation of a project Quota.\n\nThis class enforces + type checking and value constraints, and converts\nbetween the internal object + model and the API representation of Quota." + properties: + created_at: + format: date-time + type: string + hard_limit: + type: integer + id: + minimum: 1 + type: integer + project_id: + maxLength: 255 + minLength: 1 + type: string + resource: + enum: + - Cluster + type: string + updated_at: + format: date-time + type: string + type: object + QuotasListResponse: + description: API representation of a collection of quotas. + properties: + created_at: + format: date-time + type: string + next: + type: string + quotas: + items: + description: |- + API representation of a project Quota. + + This class enforces type checking and value constraints, and converts + between the internal object model and the API representation of Quota. + properties: + created_at: + format: date-time + type: string + hard_limit: + type: integer + id: + minimum: 1 + type: integer + project_id: + maxLength: 255 + minLength: 1 + type: string + resource: + enum: + - Cluster + type: string + updated_at: + format: date-time + type: string + type: object + type: array + updated_at: + format: date-time + type: string + type: object + RootGetResponse: + description: The representation of the version 1 of the API. + properties: + certificates: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + clusters: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + clustertemplates: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + created_at: + format: date-time + type: string + credentials: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + federations: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + id: + type: string + links: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + media_types: + items: + description: |- + A media type representation. + properties: + base: + type: string + created_at: + format: date-time + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + mservices: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + nodegroups: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + quotas: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + stats: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array + updated_at: + format: date-time + type: string + type: object + StatsListResponse: + description: Base type for complex types + properties: + clusters: + description: |- + The number of clusters. + type: integer + created_at: + format: date-time + type: string + nodes: + description: |- + The total number of nodes including master nodes. + type: integer + updated_at: + format: date-time + type: string + type: object + securitySchemes: + ApiKeyAuth: + in: header + name: X-Auth-Token + type: apiKey +security: + - ApiKeyAuth: [] +tags: + - name: certificates + - name: clusters + - name: clustertemplates + - name: credentials + - name: federations + - name: mservices + - name: quotas + - name: stats + - name: v1 diff --git a/openstack_types/data/container-infrastructure-management/v1.yaml b/openstack_types/data/container-infrastructure-management/v1.yaml index 10d925973..10e9df8ac 100644 --- a/openstack_types/data/container-infrastructure-management/v1.yaml +++ b/openstack_types/data/container-infrastructure-management/v1.yaml @@ -3,7 +3,7 @@ info: description: |- None title: OpenStack Container Managent Infrastructure API - version: '1.11' + version: '1.12' paths: /v1: get: @@ -377,6 +377,31 @@ paths: including: `add`, `replace` or `remove`. The attributes to `add` and `replace` in the form of `key=value` while `remove` only needs the keys. summary: Update information of cluster template + /v1/credentials/{credential_id}: + parameters: + - $ref: '#/components/parameters/credentials_credential_id' + patch: + description: |- + Rotate the credential in use by a cluster. + + | param cluster_ident: | | + | --- | --- | + | | UUID of a cluster or logical name of the cluster. | + operationId: credentials/credential_id:patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CredentialPatchRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/CredentialPatchResponse' + description: Ok + tags: + - credentials /v1/federations: get: description: |- @@ -590,6 +615,14 @@ components: required: true schema: type: string + credentials_credential_id: + description: credential_id parameter for /v1/credentials/{credential_id} + API + in: path + name: credential_id + required: true + schema: + type: string federations_federation_id: description: federation_id parameter for /v1/federations/{federation_id} API @@ -3690,6 +3723,20 @@ components: format: date-time type: string type: object + CredentialPatchRequest: + description: Request of the credentials/credential_id:patch operation + type: object + x-openstack: + action-name: patch + CredentialPatchResponse: + description: "API representation of a cluster ID\n\nThis class enforces type + checking and value constraints, and converts\nbetween the internal object + model and the API representation of a cluster\nID." + properties: + uuid: + format: uuid + type: string + type: object Federation: description: "API representation of a federation.\n\nThis class enforces type checking and value constraints, and converts\nbetween the internal object @@ -4298,6 +4345,25 @@ components: created_at: format: date-time type: string + credentials: + items: + description: |- + A link representation. + properties: + created_at: + format: date-time + type: string + href: + type: string + rel: + type: string + type: + type: string + updated_at: + format: date-time + type: string + type: object + type: array federations: items: description: |- @@ -4464,6 +4530,7 @@ tags: - name: certificates - name: clusters - name: clustertemplates + - name: credentials - name: federations - name: mservices - name: quotas diff --git a/openstack_types/data/image/v2.16.yaml b/openstack_types/data/image/v2.16.yaml index e1d7a4f7c..39f469362 100644 --- a/openstack_types/data/image/v2.16.yaml +++ b/openstack_types/data/image/v2.16.yaml @@ -494,6 +494,12 @@ paths: Request) response is returned. When the header is not present, the image data is placed into the default backing store. + An optional `x-openstack-image-size` header may be added to the request. + When present, the server will validate that the uploaded data size matches + this value. If the actual size does not match the expected size, a 400 + (Bad Request) response is returned. When not present, the server will + calculate the image size based on the actual request body size. + Example call: **Preconditions** @@ -830,6 +836,12 @@ paths: Set the `Content-Type` request header to `application/octet-stream`. + An optional `x-openstack-image-size` header may be added to the request. + When present, the server will validate that the uploaded data size matches + this value. If the actual size does not match the expected size, a 400 + (Bad Request) response is returned. When not present, the server will + calculate the image size based on the actual request body size. + Example call: **Preconditions** diff --git a/openstack_types/data/image/v2.yaml b/openstack_types/data/image/v2.yaml index e1d7a4f7c..39f469362 100644 --- a/openstack_types/data/image/v2.yaml +++ b/openstack_types/data/image/v2.yaml @@ -494,6 +494,12 @@ paths: Request) response is returned. When the header is not present, the image data is placed into the default backing store. + An optional `x-openstack-image-size` header may be added to the request. + When present, the server will validate that the uploaded data size matches + this value. If the actual size does not match the expected size, a 400 + (Bad Request) response is returned. When not present, the server will + calculate the image size based on the actual request body size. + Example call: **Preconditions** @@ -830,6 +836,12 @@ paths: Set the `Content-Type` request header to `application/octet-stream`. + An optional `x-openstack-image-size` header may be added to the request. + When present, the server will validate that the uploaded data size matches + this value. If the actual size does not match the expected size, a 400 + (Bad Request) response is returned. When not present, the server will + calculate the image size based on the actual request body size. + Example call: **Preconditions** diff --git a/openstack_types/data/shared-file-system/v2.91.yaml b/openstack_types/data/shared-file-system/v2.91.yaml new file mode 100644 index 000000000..9f6e86ea0 --- /dev/null +++ b/openstack_types/data/shared-file-system/v2.91.yaml @@ -0,0 +1,7023 @@ +openapi: 3.1.0 +info: + description: |- + This is a reference for version 2 of the OpenStack Shared File Systems API + which is provided by the Manila project. Manila provides a RESTful HTTP service + through which it offers on-demand, scalable, self-service access to + shared file system storage resources. + title: OpenStack Shared-File-System API + version: '2.91' +paths: + /: + get: + deprecated: true + description: |- + This fetches all the information about all known major API versions in + the deployment. Links to more specific information will be provided + for each API version, as well as information about supported min and + max microversions. + operationId: :get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RootListResponse' + description: Ok + summary: List All Major Versions + tags: + - version + x-openstack: + max-ver: '1.0' + min-ver: '1.0' + /availability-zones: + get: + operationId: availability-zones:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Availability_ZonesListResponse' + description: Ok + tags: + - availability-zones + x-openstack: + min-ver: '2.7' + /extensions: + get: + operationId: extensions:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionsListResponse' + description: Ok + tags: + - extensions + post: + operationId: extensions:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionsCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionsCreateResponse' + description: Ok + tags: + - extensions + /extensions/{id}: + delete: + operationId: extensions/id:delete + responses: + '204': + description: Ok + tags: + - extensions + get: + operationId: extensions/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionShowResponse' + description: Ok + tags: + - extensions + parameters: + - $ref: '#/components/parameters/extensions_id' + /limits: + get: + description: |- + Return all global and rate limit information. + operationId: limits:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LimitsListResponse' + description: Ok + tags: + - limits + /messages: + get: + deprecated: true + description: |- + Returns a list of messages, transformed through view builder. + operationId: messages:get + parameters: + - $ref: '#/components/parameters/messages_action_id' + - $ref: '#/components/parameters/messages_created_before' + - $ref: '#/components/parameters/messages_created_since' + - $ref: '#/components/parameters/messages_detail_id' + - $ref: '#/components/parameters/messages_limit' + - $ref: '#/components/parameters/messages_message_level' + - $ref: '#/components/parameters/messages_offset' + - $ref: '#/components/parameters/messages_request_id' + - $ref: '#/components/parameters/messages_resource_id' + - $ref: '#/components/parameters/messages_resource_type' + - $ref: '#/components/parameters/messages_sort_dir' + - $ref: '#/components/parameters/messages_sort_key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MessagesListResponse' + description: Ok + tags: + - messages + x-openstack: + max-ver: '2.51' + min-ver: '2.37' + /messages/{id}: + delete: + description: |- + Delete a message. + operationId: messages/id:delete + responses: + '204': + description: Ok + tags: + - messages + x-openstack: + min-ver: '2.37' + get: + description: |- + Return the given message. + operationId: messages/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MessageShowResponse' + description: Ok + tags: + - messages + x-openstack: + min-ver: '2.37' + parameters: + - $ref: '#/components/parameters/messages_id' + /os-availability-zone: + get: + deprecated: true + operationId: os-availability-zone:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Availability_ZoneListResponse' + description: Ok + tags: + - os-availability-zone + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + /os-quota-class-sets/{id}: + get: + deprecated: true + operationId: os-quota-class-sets/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse' + description: Ok + tags: + - os-quota-class-sets + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + parameters: + - $ref: '#/components/parameters/os_quota_class_sets_id' + put: + deprecated: true + operationId: os-quota-class-sets/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Quota_Class_SetUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse' + description: Ok + tags: + - os-quota-class-sets + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + /os-quota-sets/{id}: + delete: + deprecated: true + operationId: os-quota-sets/id:delete + responses: + '204': + description: Ok + tags: + - os-quota-sets + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + get: + deprecated: true + operationId: os-quota-sets/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Quota_SetShowResponse' + description: Ok + tags: + - os-quota-sets + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + parameters: + - $ref: '#/components/parameters/os_quota_sets_id' + put: + deprecated: true + operationId: os-quota-sets/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Quota_SetUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Quota_SetUpdateResponse' + description: Ok + tags: + - os-quota-sets + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + /os-quota-sets/{id}/defaults: + get: + deprecated: true + operationId: os-quota-sets/id/defaults:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Quota_SetsDefaultsResponse' + description: Ok + tags: + - os-quota-sets + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + parameters: + - $ref: '#/components/parameters/os_quota_sets_defaults_id' + /os-services: + get: + deprecated: true + operationId: os-services:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_ServicesListResponse' + description: Ok + tags: + - os-services + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + /os-services/{id}: + parameters: + - $ref: '#/components/parameters/os_services_id' + put: + deprecated: true + operationId: os-services/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Os_ServiceUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_ServiceUpdateResponse' + description: Ok + tags: + - os-services + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + /os-share-manage: + post: + deprecated: true + description: |- + Legacy method for 'manage share' operation. + + Should be removed when minimum API version becomes equal to or + greater than v2.7 + operationId: os-share-manage:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Share_ManageCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Share_ManageCreateResponse' + description: Ok + tags: + - os-share-manage + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + /os-share-unmanage/{id}/unmanage: + parameters: + - $ref: '#/components/parameters/os_share_unmanage_unmanage_id' + post: + deprecated: true + operationId: os-share-unmanage/id/unmanage:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Share_UnmanageUnmanageUnmanageRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Os_Share_UnmanageUnmanageResponse' + description: Ok + tags: + - os-share-unmanage + x-openstack: + max-ver: '2.6' + min-ver: '1.0' + /quota-class-sets/{id}: + get: + operationId: quota-class-sets/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Quota_Class_SetShowResponse' + description: Ok + tags: + - quota-class-sets + x-openstack: + min-ver: '2.7' + parameters: + - $ref: '#/components/parameters/quota_class_sets_id' + put: + operationId: quota-class-sets/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Quota_Class_SetUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Quota_Class_SetUpdateResponse' + description: Ok + tags: + - quota-class-sets + x-openstack: + min-ver: '2.7' + /quota-sets/{id}: + delete: + operationId: quota-sets/id:delete + responses: + '204': + description: Ok + tags: + - quota-sets + x-openstack: + min-ver: '2.7' + get: + operationId: quota-sets/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Quota_SetShowResponse' + description: Ok + tags: + - quota-sets + x-openstack: + min-ver: '2.7' + parameters: + - $ref: '#/components/parameters/quota_sets_id' + put: + operationId: quota-sets/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Quota_SetUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Quota_SetUpdateResponse' + description: Ok + tags: + - quota-sets + x-openstack: + min-ver: '2.7' + /quota-sets/{id}/defaults: + get: + operationId: quota-sets/id/defaults:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Quota_SetsDefaultsResponse' + description: Ok + tags: + - quota-sets + x-openstack: + min-ver: '2.7' + parameters: + - $ref: '#/components/parameters/quota_sets_defaults_id' + /quota-sets/{id}/detail: + get: + operationId: quota-sets/id/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Quota_SetsDetailResponse' + description: Ok + tags: + - quota-sets + x-openstack: + min-ver: '2.25' + parameters: + - $ref: '#/components/parameters/quota_sets_detail_id' + /resource-locks: + get: + description: |- + Returns a list of locks, transformed through view builder. + operationId: resource-locks:get + parameters: + - $ref: '#/components/parameters/resource_locks_all_projects' + - $ref: '#/components/parameters/resource_locks_created_before' + - $ref: '#/components/parameters/resource_locks_created_since' + - $ref: '#/components/parameters/resource_locks_limit' + - $ref: '#/components/parameters/resource_locks_lock_context' + - $ref: '#/components/parameters/resource_locks_lock_reason' + - $ref: '#/components/parameters/resource_locks_offset' + - $ref: '#/components/parameters/resource_locks_project_id' + - $ref: '#/components/parameters/resource_locks_resource_action' + - $ref: '#/components/parameters/resource_locks_resource_id' + - $ref: '#/components/parameters/resource_locks_resource_type' + - $ref: '#/components/parameters/resource_locks_sort_dir' + - $ref: '#/components/parameters/resource_locks_sort_key' + - $ref: '#/components/parameters/resource_locks_user_id' + - $ref: '#/components/parameters/resource_locks_with_count' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Resource_LocksListResponse' + description: Ok + tags: + - resource-locks + x-openstack: + min-ver: '2.81' + post: + description: |- + Create a resource lock. + operationId: resource-locks:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Resource_LocksCreate_281' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Resource_LocksCreateResponse' + description: Ok + tags: + - resource-locks + x-openstack: + min-ver: '2.81' + /resource-locks/{id}: + delete: + description: |- + Delete an existing resource lock. + operationId: resource-locks/id:delete + responses: + '204': + description: Ok + tags: + - resource-locks + x-openstack: + min-ver: '2.81' + get: + description: |- + Return an existing resource lock by ID. + operationId: resource-locks/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Resource_LockShowResponse' + description: Ok + tags: + - resource-locks + x-openstack: + min-ver: '2.81' + parameters: + - $ref: '#/components/parameters/resource_locks_id' + put: + description: |- + Update an existing resource lock. + operationId: resource-locks/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Resource_LockUpdate_281' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Resource_LockUpdateResponse' + description: Ok + tags: + - resource-locks + x-openstack: + min-ver: '2.81' + /scheduler-stats/pools: + get: + deprecated: true + description: |- + Returns a list of storage pools known to the scheduler. + operationId: scheduler-stats/pools:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Scheduler_StatsPoolsPools_ListResponse' + description: Ok + tags: + - scheduler-stats + x-openstack: + max-ver: '2.22' + min-ver: '1.0' + /scheduler-stats/pools/detail: + get: + deprecated: true + description: |- + Returns a detailed list of storage pools known to the scheduler. + operationId: scheduler-stats/pools/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Scheduler_StatsPoolsDetailPools_DetailResponse' + description: Ok + tags: + - scheduler-stats + x-openstack: + max-ver: '2.22' + min-ver: '1.0' + /security-services: + get: + description: |- + Returns a summary list of security services. + operationId: security-services:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Security_ServicesListResponse' + description: Ok + tags: + - security-services + post: + description: |- + Creates a new security service. + operationId: security-services:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Security_ServicesCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Security_ServicesCreateResponse' + description: Ok + tags: + - security-services + /security-services/detail: + get: + description: |- + Returns a detailed list of security services. + operationId: security-services/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Security_ServicesDetailResponse' + description: Ok + tags: + - security-services + /security-services/{id}: + delete: + description: |- + Delete a security service. + operationId: security-services/id:delete + responses: + '204': + description: Ok + tags: + - security-services + get: + description: |- + Return data about the given security service. + operationId: security-services/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Security_ServiceShowResponse' + description: Ok + tags: + - security-services + parameters: + - $ref: '#/components/parameters/security_services_id' + put: + description: |- + Update a security service. + operationId: security-services/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Security_ServiceUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Security_ServiceUpdateResponse' + description: Ok + tags: + - security-services + /services: + get: + deprecated: true + operationId: services:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServicesListResponse' + description: Ok + tags: + - services + x-openstack: + max-ver: '2.85' + min-ver: '2.7' + /services/ensure-shares: + post: + description: |- + Starts ensure shares for a given manila-share binary. + operationId: services/ensure-shares:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServicesEnsure_SharesEnsure_SharesRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ServicesEnsure_SharesResponse' + description: Ok + tags: + - services + x-openstack: + min-ver: '2.86' + /services/{id}: + parameters: + - $ref: '#/components/parameters/services_id' + put: + deprecated: true + operationId: services/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUpdateResponse' + description: Ok + tags: + - services + x-openstack: + max-ver: '2.82' + min-ver: '2.7' + /share-access-rules: + get: + deprecated: true + operationId: share-access-rules:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Access_RulesListResponse' + description: Ok + tags: + - share-access-rules + x-openstack: + max-ver: '2.81' + min-ver: '2.45' + /share-access-rules/{access_id}/metadata: + parameters: + - $ref: '#/components/parameters/share_access_rules_metadata_access_id' + put: + operationId: share-access-rules/access_id/metadata:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Access_RulesMetadataUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Access_RulesMetadataUpdateResponse' + description: Ok + tags: + - share-access-rules + x-openstack: + min-ver: '2.45' + /share-access-rules/{access_id}/metadata/{key}: + delete: + description: |- + Deletes an existing access metadata. + operationId: share-access-rules/access_id/metadata/key:delete + responses: + '200': + description: Ok + tags: + - share-access-rules + x-openstack: + min-ver: '2.45' + parameters: + - $ref: '#/components/parameters/share_access_rules_metadata_access_id' + - $ref: '#/components/parameters/share_access_rules_metadata_key' + /share-access-rules/{id}: + get: + description: |- + Return data about the given share access rule. + operationId: share-access-rules/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Access_RuleShowResponse' + description: Ok + tags: + - share-access-rules + x-openstack: + min-ver: '2.45' + parameters: + - $ref: '#/components/parameters/share_access_rules_id' + put: + description: |- + Update access_level about the given share access rule. + operationId: share-access-rules/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Access_RuleUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Access_RuleUpdateResponse' + description: Ok + tags: + - share-access-rules + x-openstack: + min-ver: '2.88' + /share-backups: + get: + description: |- + Return a summary list of backups. + operationId: share-backups:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupsListResponse' + description: Ok + tags: + - share-backups + x-openstack: + min-ver: '2.80' + post: + description: |- + Add a backup to an existing share. + operationId: share-backups:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupsCreateRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupsCreateResponse' + description: Ok + tags: + - share-backups + x-openstack: + min-ver: '2.80' + /share-backups/detail: + get: + description: |- + Returns a detailed list of backups. + operationId: share-backups/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupsDetailResponse' + description: Ok + tags: + - share-backups + x-openstack: + min-ver: '2.80' + /share-backups/{id}: + delete: + description: |- + Delete a backup. + operationId: share-backups/id:delete + responses: + '204': + description: Ok + tags: + - share-backups + x-openstack: + min-ver: '2.80' + get: + description: |- + Return data about the given backup. + operationId: share-backups/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupShowResponse' + description: Ok + tags: + - share-backups + x-openstack: + min-ver: '2.80' + parameters: + - $ref: '#/components/parameters/share_backups_id' + put: + description: |- + Update a backup. + operationId: share-backups/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupUpdateResponse' + description: Ok + tags: + - share-backups + x-openstack: + min-ver: '2.80' + /share-backups/{id}/action: + parameters: + - $ref: '#/components/parameters/share_backups_action_id' + post: + operationId: share-backups/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_BackupsActionReset_StatusRequest' + - $ref: '#/components/schemas/Share_BackupsActionRestoreRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupsActionReset_StatusResponse' + description: Ok + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_BackupsActionRestoreResponse' + description: Ok + tags: + - share-backups + /share-group-snapshots: + get: + deprecated: true + description: |- + Returns a summary list of share group snapshots. + operationId: share-group-snapshots:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_SnapshotsListResponse' + description: Ok + tags: + - share-group-snapshots + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + post: + deprecated: true + operationId: share-group-snapshots:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_SnapshotsCreateRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_SnapshotsCreateResponse' + description: Ok + tags: + - share-group-snapshots + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-group-snapshots/detail: + get: + deprecated: true + description: |- + Returns a detailed list of share group snapshots. + operationId: share-group-snapshots/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_SnapshotsDetailResponse' + description: Ok + tags: + - share-group-snapshots + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-group-snapshots/{id}: + delete: + deprecated: true + operationId: share-group-snapshots/id:delete + responses: + '204': + description: Ok + tags: + - share-group-snapshots + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + get: + deprecated: true + operationId: share-group-snapshots/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_SnapshotShowResponse' + description: Ok + tags: + - share-group-snapshots + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + parameters: + - $ref: '#/components/parameters/share_group_snapshots_id' + put: + deprecated: true + operationId: share-group-snapshots/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_SnapshotUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_SnapshotUpdateResponse' + description: Ok + tags: + - share-group-snapshots + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-group-snapshots/{id}/action: + parameters: + - $ref: '#/components/parameters/share_group_snapshots_action_id' + post: + operationId: share-group-snapshots/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_Group_SnapshotsActionForce_DeleteRequest' + - $ref: '#/components/schemas/Share_Group_SnapshotsActionReset_StatusRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_Group_SnapshotsActionForce_DeleteResponse' + - $ref: '#/components/schemas/Share_Group_SnapshotsActionReset_StatusResponse' + description: Ok + tags: + - share-group-snapshots + /share-group-snapshots/{id}/members: + get: + deprecated: true + operationId: share-group-snapshots/id/members:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_SnapshotsMembersResponse' + description: Ok + tags: + - share-group-snapshots + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + parameters: + - $ref: '#/components/parameters/share_group_snapshots_members_id' + /share-group-types: + get: + deprecated: true + operationId: share-group-types:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesListResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + post: + deprecated: true + operationId: share-group-types:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesCreateResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-group-types/default: + get: + deprecated: true + operationId: share-group-types/default:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesDefaultResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-group-types/{id}: + delete: + deprecated: true + operationId: share-group-types/id:delete + responses: + '204': + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + get: + deprecated: true + operationId: share-group-types/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypeShowResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + parameters: + - $ref: '#/components/parameters/share_group_types_id' + /share-group-types/{id}/access: + get: + deprecated: true + operationId: share-group-types/id/access:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesAccessShare_Group_Type_AccessResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + parameters: + - $ref: '#/components/parameters/share_group_types_access_id' + /share-group-types/{id}/action: + parameters: + - $ref: '#/components/parameters/share_group_types_action_id' + post: + operationId: share-group-types/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_Group_TypesActionAddprojectaccessRequest' + - $ref: '#/components/schemas/Share_Group_TypesActionCreateRequest' + - $ref: '#/components/schemas/Share_Group_TypesActionDeleteRequest' + - $ref: '#/components/schemas/Share_Group_TypesActionRemoveprojectaccessRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_Group_TypesActionAddprojectaccessResponse' + - $ref: '#/components/schemas/Share_Group_TypesActionCreateResponse' + - $ref: '#/components/schemas/Share_Group_TypesActionDeleteResponse' + - $ref: '#/components/schemas/Share_Group_TypesActionRemoveprojectaccessResponse' + description: Ok + tags: + - share-group-types + /share-group-types/{id}/group-specs: + get: + deprecated: true + operationId: share-group-types/id/group-specs:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsListResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + parameters: + - $ref: '#/components/parameters/share_group_types_group_specs_id' + post: + deprecated: true + operationId: share-group-types/id/group-specs:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsCreateResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-group-types/{id}/group-specs/{key}: + delete: + deprecated: true + operationId: share-group-types/id/group-specs/key:delete + responses: + '204': + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + get: + deprecated: true + operationId: share-group-types/id/group-specs/key:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesGroup_SpecShowResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + parameters: + - $ref: '#/components/parameters/share_group_types_group_specs_id' + - $ref: '#/components/parameters/share_group_types_group_specs_key' + put: + deprecated: true + operationId: share-group-types/id/group-specs/key:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesGroup_SpecUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_Group_TypesGroup_SpecUpdateResponse' + description: Ok + tags: + - share-group-types + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-groups: + get: + deprecated: true + operationId: share-groups:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_GroupsListResponse' + description: Ok + tags: + - share-groups + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + post: + deprecated: true + operationId: share-groups:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_GroupsCreateRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_GroupsCreateResponse' + description: Ok + tags: + - share-groups + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-groups/detail: + get: + deprecated: true + operationId: share-groups/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_GroupsDetailResponse' + description: Ok + tags: + - share-groups + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-groups/{id}: + delete: + deprecated: true + operationId: share-groups/id:delete + responses: + '204': + description: Ok + tags: + - share-groups + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + get: + deprecated: true + operationId: share-groups/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_GroupShowResponse' + description: Ok + tags: + - share-groups + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + parameters: + - $ref: '#/components/parameters/share_groups_id' + put: + deprecated: true + operationId: share-groups/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_GroupUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_GroupUpdateResponse' + description: Ok + tags: + - share-groups + x-openstack: + max-ver: '2.54' + min-ver: '2.31' + /share-groups/{id}/action: + parameters: + - $ref: '#/components/parameters/share_groups_action_id' + post: + operationId: share-groups/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_GroupsActionForce_DeleteRequest' + - $ref: '#/components/schemas/Share_GroupsActionReset_StatusRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_GroupsActionForce_DeleteResponse' + - $ref: '#/components/schemas/Share_GroupsActionReset_StatusResponse' + description: Ok + tags: + - share-groups + /share-networks: + get: + description: |- + Returns a summary list of share networks. + operationId: share-networks:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksListResponse' + description: Ok + tags: + - share-networks + post: + description: |- + Creates a new share network. + operationId: share-networks:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksCreateResponse' + description: Ok + tags: + - share-networks + /share-networks/detail: + get: + description: |- + Returns a detailed list of share networks. + operationId: share-networks/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksDetailResponse' + description: Ok + tags: + - share-networks + /share-networks/{id}: + delete: + description: |- + Delete specified share network. + operationId: share-networks/id:delete + responses: + '204': + description: Ok + tags: + - share-networks + get: + description: |- + Return data about the requested network info. + operationId: share-networks/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworkShowResponse' + description: Ok + tags: + - share-networks + parameters: + - $ref: '#/components/parameters/share_networks_id' + put: + description: |- + Update specified share network. + operationId: share-networks/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworkUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworkUpdateResponse' + description: Ok + tags: + - share-networks + /share-networks/{id}/action: + parameters: + - $ref: '#/components/parameters/share_networks_action_id' + post: + operationId: share-networks/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_NetworksActionAdd_Security_ServiceRequest' + - $ref: '#/components/schemas/Share_NetworksActionAdd_Security_Service_CheckRequest' + - $ref: '#/components/schemas/Share_NetworksActionRemove_Security_ServiceRequest' + - $ref: '#/components/schemas/Share_NetworksActionReset_StatusRequest' + - $ref: '#/components/schemas/Share_NetworksActionShare_Network_Subnet_Create_CheckRequest' + - $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_ServiceRequest' + - $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_Service_CheckRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_NetworksActionAdd_Security_ServiceResponse' + - $ref: '#/components/schemas/Share_NetworksActionRemove_Security_ServiceResponse' + - $ref: '#/components/schemas/Share_NetworksActionReset_StatusResponse' + description: Ok + '202': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_NetworksActionAdd_Security_Service_CheckResponse' + - $ref: '#/components/schemas/Share_NetworksActionShare_Network_Subnet_Create_CheckResponse' + - $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_ServiceResponse' + - $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_Service_CheckResponse' + description: Ok + tags: + - share-networks + /share-networks/{share_network_id}/subnets: + get: + description: |- + Returns a list of share network subnets. + operationId: share-networks/share_network_id/subnets:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsListResponse' + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.51' + parameters: + - $ref: '#/components/parameters/share_networks_subnets_share_network_id' + post: + description: |- + Add a new share network subnet into the share network. + operationId: share-networks/share_network_id/subnets:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsCreateResponse' + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.51' + /share-networks/{share_network_id}/subnets/{resource_id}/metadata: + get: + description: |- + Returns the list of metadata for a given share network subnet. + operationId: + share-networks/share_network_id/subnets/resource_id/metadata:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsMetadataList_MetadataResponse' + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.78' + parameters: + - $ref: '#/components/parameters/share_networks_subnets_metadata_resource_id' + - $ref: '#/components/parameters/share_networks_subnets_metadata_share_network_id' + post: + description: |- + Create metadata for a given share network subnet. + operationId: + share-networks/share_network_id/subnets/resource_id/metadata:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsMetadataCreate_MetadataRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsMetadataCreate_MetadataResponse' + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.78' + put: + description: |- + Update entire metadata for a given share network subnet. + operationId: + share-networks/share_network_id/subnets/resource_id/metadata:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_All_MetadataRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_All_MetadataResponse' + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.78' + /share-networks/{share_network_id}/subnets/{resource_id}/metadata/{key}: + delete: + description: |- + Delete metadata for a given share network subnet. + operationId: + share-networks/share_network_id/subnets/resource_id/metadata/key:delete + responses: + '204': + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.78' + get: + description: |- + Show metadata for a given share network subnet. + operationId: + share-networks/share_network_id/subnets/resource_id/metadata/key:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsMetadataShow_MetadataResponse' + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.78' + parameters: + - $ref: '#/components/parameters/share_networks_subnets_metadata_key' + - $ref: '#/components/parameters/share_networks_subnets_metadata_resource_id' + - $ref: '#/components/parameters/share_networks_subnets_metadata_share_network_id' + post: + description: |- + Update metadata item for a given share network subnet. + operationId: + share-networks/share_network_id/subnets/resource_id/metadata/key:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_Metadata_ItemRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_Metadata_ItemResponse' + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.78' + /share-networks/{share_network_id}/subnets/{share_network_subnet_id}: + delete: + description: |- + Delete specified share network subnet. + operationId: + share-networks/share_network_id/subnets/share_network_subnet_id:delete + responses: + '204': + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.51' + get: + description: |- + Show share network subnet. + operationId: + share-networks/share_network_id/subnets/share_network_subnet_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_NetworksSubnetShowResponse' + description: Ok + tags: + - share-networks + x-openstack: + min-ver: '2.51' + parameters: + - $ref: '#/components/parameters/share_networks_subnets_share_network_id' + - $ref: '#/components/parameters/share_networks_subnets_share_network_subnet_id' + /share-replicas: + get: + deprecated: true + description: |- + Return a summary list of replicas. + operationId: share-replicas:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ReplicasListResponse' + description: Ok + tags: + - share-replicas + x-openstack: + max-ver: '2.55' + min-ver: '2.11' + post: + deprecated: true + operationId: share-replicas:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ReplicasCreateRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ReplicasCreateResponse' + description: Ok + tags: + - share-replicas + x-openstack: + max-ver: '2.66' + min-ver: '2.11' + /share-replicas/detail: + get: + deprecated: true + description: |- + Returns a detailed list of replicas. + operationId: share-replicas/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ReplicasDetailResponse' + description: Ok + tags: + - share-replicas + x-openstack: + max-ver: '2.55' + min-ver: '2.11' + /share-replicas/{id}: + delete: + deprecated: true + operationId: share-replicas/id:delete + responses: + '204': + description: Ok + tags: + - share-replicas + x-openstack: + max-ver: '2.55' + min-ver: '2.11' + get: + deprecated: true + description: |- + Return data about the given replica. + operationId: share-replicas/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ReplicaShowResponse' + description: Ok + tags: + - share-replicas + x-openstack: + max-ver: '2.55' + min-ver: '2.11' + parameters: + - $ref: '#/components/parameters/share_replicas_id' + /share-replicas/{id}/action: + parameters: + - $ref: '#/components/parameters/share_replicas_action_id' + post: + operationId: share-replicas/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_ReplicasActionForce_DeleteRequest' + - $ref: '#/components/schemas/Share_ReplicasActionPromoteRequest' + - $ref: '#/components/schemas/Share_ReplicasActionReset_Replica_StateRequest' + - $ref: '#/components/schemas/Share_ReplicasActionReset_StatusRequest' + - $ref: '#/components/schemas/Share_ReplicasActionResyncRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_ReplicasActionForce_DeleteResponse' + - $ref: '#/components/schemas/Share_ReplicasActionReset_Replica_StateResponse' + - $ref: '#/components/schemas/Share_ReplicasActionReset_StatusResponse' + description: Ok + '202': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_ReplicasActionPromoteResponse' + - $ref: '#/components/schemas/Share_ReplicasActionResyncResponse' + description: Ok + tags: + - share-replicas + /share-replicas/{share_replica_id}/export-locations: + get: + deprecated: true + operationId: share-replicas/share_replica_id/export-locations:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ReplicasExport_LocationsListResponse' + description: Ok + tags: + - share-replicas + x-openstack: + max-ver: '2.55' + min-ver: '2.47' + parameters: + - $ref: '#/components/parameters/share_replicas_export_locations_share_replica_id' + /share-replicas/{share_replica_id}/export-locations/{export_location_uuid}: + get: + deprecated: true + operationId: + share-replicas/share_replica_id/export-locations/export_location_uuid:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ReplicasExport_LocationShowResponse' + description: Ok + tags: + - share-replicas + x-openstack: + max-ver: '2.55' + min-ver: '2.47' + parameters: + - $ref: '#/components/parameters/share_replicas_export_locations_export_location_uuid' + - $ref: '#/components/parameters/share_replicas_export_locations_share_replica_id' + /share-servers: + get: + description: |- + Returns a list of share servers. + operationId: share-servers:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ServersListResponse' + description: Ok + tags: + - share-servers + /share-servers/manage: + post: + operationId: share-servers/manage:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ServersManageManageRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ServersManageResponse' + description: Ok + tags: + - share-servers + x-openstack: + min-ver: '2.49' + /share-servers/{id}: + delete: + description: |- + Delete specified share server. + operationId: share-servers/id:delete + responses: + '204': + description: Ok + tags: + - share-servers + get: + description: |- + Return data about the requested share server. + operationId: share-servers/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ServerShowResponse' + description: Ok + tags: + - share-servers + parameters: + - $ref: '#/components/parameters/share_servers_id' + /share-servers/{id}/action: + parameters: + - $ref: '#/components/parameters/share_servers_action_id' + post: + operationId: share-servers/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_ServersActionMigration_CancelRequest' + - $ref: '#/components/schemas/Share_ServersActionMigration_CheckRequest' + - $ref: '#/components/schemas/Share_ServersActionMigration_CompleteRequest' + - $ref: '#/components/schemas/Share_ServersActionMigration_Get_ProgressRequest' + - $ref: '#/components/schemas/Share_ServersActionMigration_StartRequest' + - $ref: '#/components/schemas/Share_ServersActionReset_StatusRequest' + - $ref: '#/components/schemas/Share_ServersActionReset_Task_StateRequest' + - $ref: '#/components/schemas/Share_ServersActionUnmanageRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_ServersActionMigration_CheckResponse' + - $ref: '#/components/schemas/Share_ServersActionMigration_CompleteResponse' + - $ref: '#/components/schemas/Share_ServersActionMigration_Get_ProgressResponse' + - $ref: '#/components/schemas/Share_ServersActionReset_StatusResponse' + - $ref: '#/components/schemas/Share_ServersActionReset_Task_StateResponse' + - $ref: '#/components/schemas/Share_ServersActionUnmanageResponse' + description: Ok + '202': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_ServersActionMigration_CancelResponse' + - $ref: '#/components/schemas/Share_ServersActionMigration_StartResponse' + description: Ok + tags: + - share-servers + /share-servers/{id}/details: + get: + description: |- + Return details for requested share server. + operationId: share-servers/id/details:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_ServersDetailsResponse' + description: Ok + tags: + - share-servers + parameters: + - $ref: '#/components/parameters/share_servers_details_id' + /share-transfers: + get: + description: |- + Returns a summary list of transfers. + operationId: share-transfers:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_TransfersListResponse' + description: Ok + tags: + - share-transfers + x-openstack: + min-ver: '2.77' + post: + description: |- + Create a new share transfer. + operationId: share-transfers:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_TransfersCreateRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_TransfersCreateResponse' + description: Ok + tags: + - share-transfers + x-openstack: + min-ver: '2.77' + /share-transfers/detail: + get: + description: |- + Returns a detailed list of transfers. + operationId: share-transfers/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_TransfersDetailResponse' + description: Ok + tags: + - share-transfers + x-openstack: + min-ver: '2.77' + /share-transfers/{id}: + delete: + description: |- + Delete a transfer. + operationId: share-transfers/id:delete + responses: + '204': + description: Ok + tags: + - share-transfers + x-openstack: + min-ver: '2.77' + get: + description: |- + Return data about active transfers. + operationId: share-transfers/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_TransferShowResponse' + description: Ok + tags: + - share-transfers + x-openstack: + min-ver: '2.77' + parameters: + - $ref: '#/components/parameters/share_transfers_id' + /share-transfers/{id}/accept: + parameters: + - $ref: '#/components/parameters/share_transfers_accept_id' + post: + description: |- + Accept a new share transfer. + operationId: share-transfers/id/accept:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Share_TransfersAcceptAcceptRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_TransfersAcceptResponse' + description: Ok + tags: + - share-transfers + x-openstack: + min-ver: '2.77' + /share_instances: + get: + deprecated: true + operationId: share_instances:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_InstancesListResponse' + description: Ok + tags: + - share_instances + x-openstack: + max-ver: '2.68' + min-ver: '2.3' + /share_instances/{id}: + get: + operationId: share_instances/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_InstanceShowResponse' + description: Ok + tags: + - share_instances + x-openstack: + min-ver: '2.3' + parameters: + - $ref: '#/components/parameters/share_instances_id' + /share_instances/{id}/action: + parameters: + - $ref: '#/components/parameters/share_instances_action_id' + post: + operationId: share_instances/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_InstancesActionForce_DeleteRequest' + - $ref: '#/components/schemas/Share_InstancesActionOs-Force_DeleteRequest' + - $ref: '#/components/schemas/Share_InstancesActionOs-Reset_StatusRequest' + - $ref: '#/components/schemas/Share_InstancesActionReset_StatusRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Share_InstancesActionForce_DeleteResponse' + - $ref: '#/components/schemas/Share_InstancesActionOs-Force_DeleteResponse' + - $ref: '#/components/schemas/Share_InstancesActionOs-Reset_StatusResponse' + - $ref: '#/components/schemas/Share_InstancesActionReset_StatusResponse' + description: Ok + tags: + - share_instances + /share_instances/{share_instance_id}/export_locations: + get: + description: |- + Return a list of export locations for the share instance. + operationId: share_instances/share_instance_id/export_locations:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_InstancesExport_LocationsListResponse' + description: Ok + tags: + - share_instances + x-openstack: + min-ver: '2.9' + parameters: + - $ref: '#/components/parameters/share_instances_export_locations_share_instance_id' + /share_instances/{share_instance_id}/export_locations/{export_location_uuid}: + get: + description: |- + Return data about the requested export location. + operationId: + share_instances/share_instance_id/export_locations/export_location_uuid:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse' + description: Ok + tags: + - share_instances + x-openstack: + min-ver: '2.9' + parameters: + - $ref: '#/components/parameters/share_instances_export_locations_export_location_uuid' + - $ref: '#/components/parameters/share_instances_export_locations_share_instance_id' + /shares: + get: + description: |- + Returns a summary list of shares. + operationId: shares:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesListResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.0' + post: + deprecated: true + operationId: shares:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharesCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesCreateResponse' + description: Ok + tags: + - shares + x-openstack: + max-ver: '2.89' + min-ver: '2.0' + /shares/detail: + get: + description: |- + Returns a detailed list of shares. + operationId: shares/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesDetailResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.0' + /shares/manage: + post: + deprecated: true + operationId: shares/manage:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharesManageManageRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesManageResponse' + description: Ok + tags: + - shares + x-openstack: + max-ver: '2.48' + min-ver: '2.7' + /shares/{id}: + delete: + description: |- + Delete a share. + operationId: shares/id:delete + responses: + '204': + description: Ok + tags: + - shares + get: + description: |- + Return data about the given share. + operationId: shares/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ShareShowResponse' + description: Ok + tags: + - shares + parameters: + - $ref: '#/components/parameters/shares_id' + put: + description: |- + Update a share. + operationId: shares/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShareUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ShareUpdateResponse' + description: Ok + tags: + - shares + /shares/{id}/action: + parameters: + - $ref: '#/components/parameters/shares_action_id' + post: + operationId: shares/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SharesActionAccess_ListRequest' + - $ref: '#/components/schemas/SharesActionAllow_AccessRequest' + - $ref: '#/components/schemas/SharesActionDeny_AccessRequest' + - $ref: '#/components/schemas/SharesActionExtendRequest' + - $ref: '#/components/schemas/SharesActionForce_DeleteRequest' + - $ref: '#/components/schemas/SharesActionMigration_CancelRequest' + - $ref: '#/components/schemas/SharesActionMigration_CompleteRequest' + - $ref: '#/components/schemas/SharesActionMigration_Get_ProgressRequest' + - $ref: '#/components/schemas/SharesActionMigration_StartRequest' + - $ref: '#/components/schemas/SharesActionOs-Access_ListRequest' + - $ref: '#/components/schemas/SharesActionOs-Allow_AccessRequest' + - $ref: '#/components/schemas/SharesActionOs-Deny_AccessRequest' + - $ref: '#/components/schemas/SharesActionOs-ExtendRequest' + - $ref: '#/components/schemas/SharesActionOs-Force_DeleteRequest' + - $ref: '#/components/schemas/SharesActionOs-Reset_StatusRequest' + - $ref: '#/components/schemas/SharesActionOs-ShrinkRequest' + - $ref: '#/components/schemas/SharesActionReset_StatusRequest' + - $ref: '#/components/schemas/SharesActionReset_Task_StateRequest' + - $ref: '#/components/schemas/SharesActionRestoreRequest' + - $ref: '#/components/schemas/SharesActionRevertRequest' + - $ref: '#/components/schemas/SharesActionShrinkRequest' + - $ref: '#/components/schemas/SharesActionSoft_DeleteRequest' + - $ref: '#/components/schemas/SharesActionUnmanageRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SharesActionAccess_ListResponse' + - $ref: '#/components/schemas/SharesActionAllow_AccessResponse' + - $ref: '#/components/schemas/SharesActionDeny_AccessResponse' + - $ref: '#/components/schemas/SharesActionExtendResponse' + - $ref: '#/components/schemas/SharesActionForce_DeleteResponse' + - $ref: '#/components/schemas/SharesActionMigration_CancelResponse' + - $ref: '#/components/schemas/SharesActionMigration_CompleteResponse' + - $ref: '#/components/schemas/SharesActionMigration_Get_ProgressResponse' + - $ref: '#/components/schemas/SharesActionMigration_StartResponse' + - $ref: '#/components/schemas/SharesActionOs-Access_ListResponse' + - $ref: '#/components/schemas/SharesActionOs-Allow_AccessResponse' + - $ref: '#/components/schemas/SharesActionOs-Deny_AccessResponse' + - $ref: '#/components/schemas/SharesActionOs-ExtendResponse' + - $ref: '#/components/schemas/SharesActionOs-Force_DeleteResponse' + - $ref: '#/components/schemas/SharesActionOs-Reset_StatusResponse' + - $ref: '#/components/schemas/SharesActionOs-ShrinkResponse' + - $ref: '#/components/schemas/SharesActionReset_StatusResponse' + - $ref: '#/components/schemas/SharesActionReset_Task_StateResponse' + - $ref: '#/components/schemas/SharesActionRestoreResponse' + - $ref: '#/components/schemas/SharesActionRevertResponse' + - $ref: '#/components/schemas/SharesActionShrinkResponse' + - $ref: '#/components/schemas/SharesActionSoft_DeleteResponse' + - $ref: '#/components/schemas/SharesActionUnmanageResponse' + description: Ok + tags: + - shares + /shares/{resource_id}/metadata: + get: + description: |- + Returns the list of metadata for a given share. + operationId: shares/resource_id/metadata:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesMetadataList_MetadataResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.0' + parameters: + - $ref: '#/components/parameters/shares_metadata_resource_id' + post: + operationId: shares/resource_id/metadata:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharesMetadataCreate_MetadataRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesMetadataCreate_MetadataResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.0' + put: + operationId: shares/resource_id/metadata:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharesMetadataUpdate_All_MetadataRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesMetadataUpdate_All_MetadataResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.0' + /shares/{resource_id}/metadata/{key}: + delete: + operationId: shares/resource_id/metadata/key:delete + responses: + '204': + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.0' + get: + operationId: shares/resource_id/metadata/key:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesMetadataShow_MetadataResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.0' + parameters: + - $ref: '#/components/parameters/shares_metadata_key' + - $ref: '#/components/parameters/shares_metadata_resource_id' + post: + operationId: shares/resource_id/metadata/key:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharesMetadataUpdate_Metadata_ItemRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesMetadataUpdate_Metadata_ItemResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.0' + /shares/{share_id}/export_locations: + get: + deprecated: true + description: |- + Return a list of export locations for share. + operationId: shares/share_id/export_locations:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsListResponse' + description: Ok + tags: + - shares + x-openstack: + max-ver: '2.46' + min-ver: '2.9' + parameters: + - $ref: '#/components/parameters/shares_export_locations_share_id' + /shares/{share_id}/export_locations/{export_location_uuid}: + get: + deprecated: true + description: |- + Return data about the requested export location. + operationId: shares/share_id/export_locations/export_location_uuid:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationShowResponse' + description: Ok + tags: + - shares + x-openstack: + max-ver: '2.46' + min-ver: '2.9' + parameters: + - $ref: '#/components/parameters/shares_export_locations_export_location_uuid' + - $ref: '#/components/parameters/shares_export_locations_share_id' + /shares/{share_id}/export_locations/{resource_id}/metadata: + get: + description: |- + Returns the list of metadata for a given share export location. + operationId: shares/share_id/export_locations/resource_id/metadata:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsMetadataList_MetadataResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.87' + parameters: + - $ref: '#/components/parameters/shares_export_locations_metadata_resource_id' + - $ref: '#/components/parameters/shares_export_locations_metadata_share_id' + post: + description: |- + Create metadata for a given share export location. + operationId: shares/share_id/export_locations/resource_id/metadata:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsMetadataCreate_MetadataRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsMetadataCreate_MetadataResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.87' + put: + description: |- + Update entire metadata for a given share export location. + operationId: shares/share_id/export_locations/resource_id/metadata:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_All_MetadataRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_All_MetadataResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.87' + /shares/{share_id}/export_locations/{resource_id}/metadata/{key}: + delete: + description: |- + Delete metadata for a given share export location. + operationId: + shares/share_id/export_locations/resource_id/metadata/key:delete + responses: + '204': + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.87' + get: + description: |- + Show metadata for a given share export location. + operationId: shares/share_id/export_locations/resource_id/metadata/key:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsMetadataShow_MetadataResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.87' + parameters: + - $ref: '#/components/parameters/shares_export_locations_metadata_key' + - $ref: '#/components/parameters/shares_export_locations_metadata_resource_id' + - $ref: '#/components/parameters/shares_export_locations_metadata_share_id' + post: + description: |- + Update metadata item for a given share export location. + operationId: + shares/share_id/export_locations/resource_id/metadata/key:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_Metadata_ItemRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.87' + /shares/{share_id}/instances: + get: + operationId: shares/share_id/instances:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SharesInstancesGet_Share_InstancesResponse' + description: Ok + tags: + - shares + x-openstack: + min-ver: '2.3' + parameters: + - $ref: '#/components/parameters/shares_instances_share_id' + /snapshot-instances: + get: + description: |- + Return a summary list of snapshot instances. + operationId: snapshot-instances:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot_InstancesListResponse' + description: Ok + tags: + - snapshot-instances + x-openstack: + min-ver: '2.19' + /snapshot-instances/detail: + get: + description: |- + Returns a detailed list of snapshot instances. + operationId: snapshot-instances/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot_InstancesDetailResponse' + description: Ok + tags: + - snapshot-instances + x-openstack: + min-ver: '2.19' + /snapshot-instances/{id}: + get: + operationId: snapshot-instances/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot_InstanceShowResponse' + description: Ok + tags: + - snapshot-instances + x-openstack: + min-ver: '2.19' + parameters: + - $ref: '#/components/parameters/snapshot_instances_id' + /snapshot-instances/{id}/action: + parameters: + - $ref: '#/components/parameters/snapshot_instances_action_id' + post: + operationId: snapshot-instances/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/Snapshot_InstancesActionReset_StatusRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot_InstancesActionReset_StatusResponse' + description: Ok + tags: + - snapshot-instances + /snapshot-instances/{snapshot_instance_id}/export-locations: + get: + operationId: snapshot-instances/snapshot_instance_id/export-locations:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot_InstancesExport_LocationsListResponse' + description: Ok + tags: + - snapshot-instances + x-openstack: + min-ver: '2.32' + parameters: + - $ref: '#/components/parameters/snapshot_instances_export_locations_snapshot_instance_id' + /snapshot-instances/{snapshot_instance_id}/export-locations/{export_location_id}: + get: + operationId: + snapshot-instances/snapshot_instance_id/export-locations/export_location_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot_InstancesExport_LocationShowResponse' + description: Ok + tags: + - snapshot-instances + x-openstack: + min-ver: '2.32' + parameters: + - $ref: '#/components/parameters/snapshot_instances_export_locations_export_location_id' + - $ref: '#/components/parameters/snapshot_instances_export_locations_snapshot_instance_id' + /snapshots: + get: + description: |- + Returns a summary list of shares. + operationId: snapshots:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsListResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.0' + post: + description: |- + Creates a new snapshot. + operationId: snapshots:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsCreateRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsCreateResponse' + description: Ok + tags: + - snapshots + /snapshots/detail: + get: + description: |- + Returns a detailed list of shares. + operationId: snapshots/detail:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsDetailResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.0' + /snapshots/manage: + post: + operationId: snapshots/manage:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsManageManageRequest' + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsManageResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.12' + /snapshots/{id}: + delete: + description: |- + Delete a snapshot. + operationId: snapshots/id:delete + responses: + '204': + description: Ok + tags: + - snapshots + get: + description: |- + Return data about the given snapshot. + operationId: snapshots/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotShowResponse' + description: Ok + tags: + - snapshots + parameters: + - $ref: '#/components/parameters/snapshots_id' + put: + description: |- + Update a snapshot. + operationId: snapshots/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotUpdateResponse' + description: Ok + tags: + - snapshots + /snapshots/{id}/action: + parameters: + - $ref: '#/components/parameters/snapshots_action_id' + post: + operationId: snapshots/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SnapshotsActionAllow_AccessRequest' + - $ref: '#/components/schemas/SnapshotsActionDeny_AccessRequest' + - $ref: '#/components/schemas/SnapshotsActionForce_DeleteRequest' + - $ref: '#/components/schemas/SnapshotsActionOs-Force_DeleteRequest' + - $ref: '#/components/schemas/SnapshotsActionOs-Reset_StatusRequest' + - $ref: '#/components/schemas/SnapshotsActionReset_StatusRequest' + - $ref: '#/components/schemas/SnapshotsActionUnmanageRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SnapshotsActionDeny_AccessResponse' + - $ref: '#/components/schemas/SnapshotsActionForce_DeleteResponse' + - $ref: '#/components/schemas/SnapshotsActionOs-Force_DeleteResponse' + - $ref: '#/components/schemas/SnapshotsActionOs-Reset_StatusResponse' + - $ref: '#/components/schemas/SnapshotsActionReset_StatusResponse' + - $ref: '#/components/schemas/SnapshotsActionUnmanageResponse' + description: Ok + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsActionAllow_AccessResponse' + description: Ok + tags: + - snapshots + /snapshots/{resource_id}/metadata: + get: + description: |- + Returns the list of metadata for a given share snapshot. + operationId: snapshots/resource_id/metadata:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsMetadataList_MetadataResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.73' + parameters: + - $ref: '#/components/parameters/snapshots_metadata_resource_id' + post: + operationId: snapshots/resource_id/metadata:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsMetadataCreate_MetadataRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsMetadataCreate_MetadataResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.73' + put: + operationId: snapshots/resource_id/metadata:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsMetadataUpdate_All_MetadataRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsMetadataUpdate_All_MetadataResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.73' + /snapshots/{resource_id}/metadata/{key}: + delete: + operationId: snapshots/resource_id/metadata/key:delete + responses: + '204': + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.73' + get: + operationId: snapshots/resource_id/metadata/key:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsMetadataShow_MetadataResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.73' + parameters: + - $ref: '#/components/parameters/snapshots_metadata_key' + - $ref: '#/components/parameters/snapshots_metadata_resource_id' + post: + operationId: snapshots/resource_id/metadata/key:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsMetadataUpdate_Metadata_ItemRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsMetadataUpdate_Metadata_ItemResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.73' + /snapshots/{snapshot_id}/access-list: + get: + operationId: snapshots/snapshot_id/access-list:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsAccess_ListResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.32' + parameters: + - $ref: '#/components/parameters/snapshots_access_list_snapshot_id' + /snapshots/{snapshot_id}/export-locations: + get: + operationId: snapshots/snapshot_id/export-locations:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsExport_LocationsListResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.32' + parameters: + - $ref: '#/components/parameters/snapshots_export_locations_snapshot_id' + /snapshots/{snapshot_id}/export-locations/{export_location_id}: + get: + operationId: snapshots/snapshot_id/export-locations/export_location_id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotsExport_LocationShowResponse' + description: Ok + tags: + - snapshots + x-openstack: + min-ver: '2.32' + parameters: + - $ref: '#/components/parameters/snapshots_export_locations_export_location_id' + - $ref: '#/components/parameters/snapshots_export_locations_snapshot_id' + /types: + get: + description: |- + Returns the list of share types. + operationId: types:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesListResponse' + description: Ok + tags: + - types + post: + deprecated: true + operationId: types:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TypesCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesCreateResponse' + description: Ok + tags: + - types + x-openstack: + max-ver: '2.23' + min-ver: '1.0' + /types/default: + get: + description: |- + Return default volume type. + operationId: types/default:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesDefaultResponse' + description: Ok + tags: + - types + /types/{id}: + delete: + description: |- + Deletes an existing share type. + operationId: types/id:delete + responses: + '204': + description: Ok + tags: + - types + get: + description: |- + Return a single share type item. + operationId: types/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypeShowResponse' + description: Ok + tags: + - types + parameters: + - $ref: '#/components/parameters/types_id' + put: + description: |- + Update name description is_public for a given share type. + operationId: types/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TypeUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypeUpdateResponse' + description: Ok + tags: + - types + x-openstack: + min-ver: '2.50' + /types/{id}/action: + parameters: + - $ref: '#/components/parameters/types_action_id' + post: + operationId: types/id/action:post + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/TypesActionAddprojectaccessRequest' + - $ref: '#/components/schemas/TypesActionCreateRequest' + - $ref: '#/components/schemas/TypesActionDeleteRequest' + - $ref: '#/components/schemas/TypesActionRemoveprojectaccessRequest' + - $ref: '#/components/schemas/TypesActionUpdateRequest' + x-openstack: + discriminator: action + responses: + '201': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/TypesActionAddprojectaccessResponse' + - $ref: '#/components/schemas/TypesActionCreateResponse' + - $ref: '#/components/schemas/TypesActionDeleteResponse' + - $ref: '#/components/schemas/TypesActionRemoveprojectaccessResponse' + - $ref: '#/components/schemas/TypesActionUpdateResponse' + description: Ok + tags: + - types + /types/{id}/os-share-type-access: + get: + operationId: types/id/os-share-type-access:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesOs_Share_Type_AccessOs-Share-Type-AccessResponse' + description: Ok + tags: + - types + parameters: + - $ref: '#/components/parameters/types_os_share_type_access_id' + /types/{id}/share_type_access: + get: + operationId: types/id/share_type_access:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesShare_Type_AccessResponse' + description: Ok + tags: + - types + parameters: + - $ref: '#/components/parameters/types_share_type_access_id' + /types/{type_id}/extra_specs: + get: + description: |- + Returns the list of extra specs for a given share type. + operationId: types/type_id/extra_specs:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesExtra_SpecsListResponse' + description: Ok + tags: + - types + parameters: + - $ref: '#/components/parameters/types_extra_specs_type_id' + post: + operationId: types/type_id/extra_specs:post + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TypesExtra_SpecsCreateRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesExtra_SpecsCreateResponse' + description: Ok + tags: + - types + /types/{type_id}/extra_specs/{id}: + delete: + deprecated: true + description: |- + Deletes an existing extra spec. + operationId: types/type_id/extra_specs/id:delete + responses: + '204': + description: Ok + tags: + - types + x-openstack: + max-ver: '2.23' + min-ver: '1.0' + get: + description: |- + Return a single extra spec item. + operationId: types/type_id/extra_specs/id:get + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesExtra_SpecShowResponse' + description: Ok + tags: + - types + parameters: + - $ref: '#/components/parameters/types_extra_specs_id' + - $ref: '#/components/parameters/types_extra_specs_type_id' + put: + operationId: types/type_id/extra_specs/id:put + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TypesExtra_SpecUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TypesExtra_SpecUpdateResponse' + description: Ok + tags: + - types +components: + parameters: + availability_zones_edit_id: + description: id parameter for /availability-zones/{id}/edit API + in: path + name: id + required: true + schema: + type: string + availability_zones_id: + description: id parameter for /availability-zones/{id} API + in: path + name: id + required: true + schema: + type: string + extensions_edit_id: + description: id parameter for /extensions/{id}/edit API + in: path + name: id + required: true + schema: + type: string + extensions_id: + description: id parameter for /extensions/{id} API + in: path + name: id + required: true + schema: + type: string + limits_edit_id: + description: id parameter for /limits/{id}/edit API + in: path + name: id + required: true + schema: + type: string + limits_id: + description: id parameter for /limits/{id} API + in: path + name: id + required: true + schema: + type: string + messages_action_id: + in: query + name: action_id + schema: + type: string + x-openstack: + min-ver: '2.37' + messages_created_before: + in: query + name: created_before + schema: + format: date-time + type: string + x-openstack: + min-ver: '2.52' + messages_created_since: + in: query + name: created_since + schema: + format: date-time + type: string + x-openstack: + min-ver: '2.52' + messages_detail_id: + in: query + name: detail_id + schema: + type: string + x-openstack: + min-ver: '2.37' + messages_edit_id: + description: id parameter for /messages/{id}/edit API + in: path + name: id + required: true + schema: + type: string + messages_id: + description: id parameter for /messages/{id} API + in: path + name: id + required: true + schema: + type: string + messages_limit: + in: query + name: limit + schema: + maximum: 2147483647 + minLength: 1 + minimum: 0 + pattern: ^[0-9]*$ + type: + - integer + - string + x-openstack: + min-ver: '2.37' + messages_message_level: + in: query + name: message_level + schema: + type: string + x-openstack: + min-ver: '2.37' + messages_offset: + in: query + name: offset + schema: + maximum: 2147483647 + minLength: 1 + minimum: 0 + pattern: ^[0-9]*$ + type: + - integer + - string + x-openstack: + min-ver: '2.37' + messages_request_id: + in: query + name: request_id + schema: + type: string + x-openstack: + min-ver: '2.37' + messages_resource_id: + in: query + name: resource_id + schema: + type: string + x-openstack: + min-ver: '2.37' + messages_resource_type: + in: query + name: resource_type + schema: + type: string + x-openstack: + min-ver: '2.37' + messages_sort_dir: + in: query + name: sort_dir + schema: + default: desc + type: string + x-openstack: + min-ver: '2.37' + messages_sort_key: + in: query + name: sort_key + schema: + default: created_at + type: string + x-openstack: + min-ver: '2.37' + os_availability_zone_edit_id: + description: id parameter for /os-availability-zone/{id}/edit API + in: path + name: id + required: true + schema: + type: string + os_availability_zone_id: + description: id parameter for /os-availability-zone/{id} API + in: path + name: id + required: true + schema: + type: string + os_quota_class_sets_edit_id: + description: id parameter for /os-quota-class-sets/{id}/edit API + in: path + name: id + required: true + schema: + type: string + os_quota_class_sets_id: + description: id parameter for /os-quota-class-sets/{id} API + in: path + name: id + required: true + schema: + type: string + os_quota_sets_defaults_id: + description: id parameter for /os-quota-sets/{id}/defaults API + in: path + name: id + required: true + schema: + type: string + os_quota_sets_edit_id: + description: id parameter for /os-quota-sets/{id}/edit API + in: path + name: id + required: true + schema: + type: string + os_quota_sets_id: + description: id parameter for /os-quota-sets/{id} API + in: path + name: id + required: true + schema: + type: string + os_services_edit_id: + description: id parameter for /os-services/{id}/edit API + in: path + name: id + required: true + schema: + type: string + os_services_id: + description: id parameter for /os-services/{id} API + in: path + name: id + required: true + schema: + type: string + os_share_manage_edit_id: + description: id parameter for /os-share-manage/{id}/edit API + in: path + name: id + required: true + schema: + type: string + os_share_manage_id: + description: id parameter for /os-share-manage/{id} API + in: path + name: id + required: true + schema: + type: string + os_share_unmanage_edit_id: + description: id parameter for /os-share-unmanage/{id}/edit API + in: path + name: id + required: true + schema: + type: string + os_share_unmanage_id: + description: id parameter for /os-share-unmanage/{id} API + in: path + name: id + required: true + schema: + type: string + os_share_unmanage_unmanage_id: + description: id parameter for /os-share-unmanage/{id}/unmanage API + in: path + name: id + required: true + schema: + type: string + quota_class_sets_edit_id: + description: id parameter for /quota-class-sets/{id}/edit API + in: path + name: id + required: true + schema: + type: string + quota_class_sets_id: + description: id parameter for /quota-class-sets/{id} API + in: path + name: id + required: true + schema: + type: string + quota_sets_defaults_id: + description: id parameter for /quota-sets/{id}/defaults API + in: path + name: id + required: true + schema: + type: string + quota_sets_detail_id: + description: id parameter for /quota-sets/{id}/detail API + in: path + name: id + required: true + schema: + type: string + quota_sets_edit_id: + description: id parameter for /quota-sets/{id}/edit API + in: path + name: id + required: true + schema: + type: string + quota_sets_id: + description: id parameter for /quota-sets/{id} API + in: path + name: id + required: true + schema: + type: string + resource_locks_all_projects: + in: query + name: all_projects + schema: + description: "Set this parameter to True to get resource locks across all + project\nnamespaces.\n" + enum: + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - NO + - No + - OFF + - ON + - Off + - On + - 'TRUE' + - true + - 'True' + - YES + - Yes + - f + - 'false' + - n + - no + - off + - on + - t + - 'true' + - y + - yes + type: + - boolean + - string + x-openstack: + min-ver: '2.81' + resource_locks_created_before: + in: query + name: created_before + schema: + description: "Search for the list of resources that were created prior to + the specified\ndate. The date is in 'yyyy-mm-dd' format.\n" + format: date-time + type: string + x-openstack: + min-ver: '2.81' + resource_locks_created_since: + in: query + name: created_since + schema: + description: "Search for the list of resources that were created after the + specified\ndate. The date is in 'yyyy-mm-dd' format.\n" + format: date-time + type: string + x-openstack: + min-ver: '2.81' + resource_locks_edit_id: + description: id parameter for /resource-locks/{id}/edit API + in: path + name: id + required: true + schema: + type: string + resource_locks_id: + description: id parameter for /resource-locks/{id} API + in: path + name: id + required: true + schema: + type: string + resource_locks_limit: + in: query + name: limit + schema: + description: "The maximum number of resource records to return.\n" + maximum: 2147483647 + minLength: 1 + minimum: 0 + pattern: ^[0-9]*$ + type: + - integer + - string + x-openstack: + min-ver: '2.81' + resource_locks_lock_context: + in: query + name: lock_context + schema: + description: "The lock creator's context to filter locks by.\n" + maxLength: 10 + type: + - 'null' + - string + x-openstack: + min-ver: '2.81' + resource_locks_lock_reason: + in: query + name: lock_reason + schema: + description: "The lock reason that can be used to filter resource locks.\n" + maxLength: 1023 + type: + - 'null' + - string + x-openstack: + min-ver: '2.81' + resource_locks_offset: + in: query + name: offset + schema: + description: "The offset to define start point of resource listing.\n" + maximum: 2147483647 + minLength: 1 + minimum: 0 + pattern: ^[0-9]*$ + type: + - integer + - string + x-openstack: + min-ver: '2.81' + resource_locks_project_id: + in: query + name: project_id + schema: + description: "The ID of a project to filter resource locks by.\n" + format: uuid + type: + - 'null' + - string + x-openstack: + min-ver: '2.81' + resource_link: identity/v3/project.id + resource_locks_resource_action: + in: query + name: resource_action + schema: + description: "The ``action`` prevented by the filtered resource locks.\n" + enum: + - + - delete + - show + type: + - 'null' + - string + x-openstack: + min-ver: '2.81' + resource_locks_resource_id: + in: query + name: resource_id + schema: + description: "The ID of the resource that the locks pertain to to filter resource\n\ + locks by.\n" + format: uuid + type: + - 'null' + - string + x-openstack: + min-ver: '2.81' + resource_locks_resource_type: + in: query + name: resource_type + schema: + description: "The type of the resource that the locks pertain to to filter + resource\nlocks by.\n" + enum: + - + - access_rule + - share + type: + - 'null' + - string + x-openstack: + min-ver: '2.81' + resource_locks_sort_dir: + in: query + name: sort_dir + schema: + default: desc + description: "The direction to sort a list of resources. A valid\nvalue is + ``asc``, or ``desc``.\n" + type: string + x-openstack: + min-ver: '2.81' + resource_locks_sort_key: + in: query + name: sort_key + schema: + default: created_at + description: "The key to sort a list of resource locks. A valid value\nis + ``id``, ``resource_id``, ``resource_type``, ``resource_action``,\n``user_id``, + ``project_id``, ``created_at``, ``updated_act``,\n``lock_context``.\n" + type: string + x-openstack: + min-ver: '2.81' + resource_locks_user_id: + in: query + name: user_id + schema: + description: "The ID of a user to filter resource locks by.\n" + format: uuid + type: + - 'null' + - string + x-openstack: + min-ver: '2.81' + resource_link: identity/v3/user.id + resource_locks_with_count: + in: query + name: with_count + schema: + enum: + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - NO + - No + - OFF + - ON + - Off + - On + - 'TRUE' + - true + - 'True' + - YES + - Yes + - f + - 'false' + - n + - no + - off + - on + - t + - 'true' + - y + - yes + type: + - boolean + - string + x-openstack: + min-ver: '2.81' + security_services_edit_id: + description: id parameter for /security-services/{id}/edit API + in: path + name: id + required: true + schema: + type: string + security_services_id: + description: id parameter for /security-services/{id} API + in: path + name: id + required: true + schema: + type: string + services_edit_id: + description: id parameter for /services/{id}/edit API + in: path + name: id + required: true + schema: + type: string + services_id: + description: id parameter for /services/{id} API + in: path + name: id + required: true + schema: + type: string + share_access_rules_edit_id: + description: id parameter for /share-access-rules/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_access_rules_id: + description: id parameter for /share-access-rules/{id} API + in: path + name: id + required: true + schema: + type: string + share_access_rules_metadata_access_id: + description: access_id parameter for + /share-access-rules/{access_id}/metadata/{key} API + in: path + name: access_id + required: true + schema: + type: string + share_access_rules_metadata_key: + description: key parameter for + /share-access-rules/{access_id}/metadata/{key} API + in: path + name: key + required: true + schema: + type: string + share_backups_action_id: + description: id parameter for /share-backups/{id}/action API + in: path + name: id + required: true + schema: + type: string + share_backups_edit_id: + description: id parameter for /share-backups/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_backups_id: + description: id parameter for /share-backups/{id} API + in: path + name: id + required: true + schema: + type: string + share_group_snapshots_action_id: + description: id parameter for /share-group-snapshots/{id}/action API + in: path + name: id + required: true + schema: + type: string + share_group_snapshots_edit_id: + description: id parameter for /share-group-snapshots/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_group_snapshots_id: + description: id parameter for /share-group-snapshots/{id} API + in: path + name: id + required: true + schema: + type: string + share_group_snapshots_members_id: + description: id parameter for /share-group-snapshots/{id}/members API + in: path + name: id + required: true + schema: + type: string + share_group_types_access_id: + description: id parameter for /share-group-types/{id}/access API + in: path + name: id + required: true + schema: + type: string + share_group_types_action_id: + description: id parameter for /share-group-types/{id}/action API + in: path + name: id + required: true + schema: + type: string + share_group_types_edit_id: + description: id parameter for /share-group-types/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_group_types_group_specs_id: + description: id parameter for /share-group-types/{id}/group-specs/{key} + API + in: path + name: id + required: true + schema: + type: string + share_group_types_group_specs_key: + description: key parameter for /share-group-types/{id}/group-specs/{key} + API + in: path + name: key + required: true + schema: + type: string + share_group_types_id: + description: id parameter for /share-group-types/{id} API + in: path + name: id + required: true + schema: + type: string + share_groups_action_id: + description: id parameter for /share-groups/{id}/action API + in: path + name: id + required: true + schema: + type: string + share_groups_edit_id: + description: id parameter for /share-groups/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_groups_id: + description: id parameter for /share-groups/{id} API + in: path + name: id + required: true + schema: + type: string + share_instances_action_id: + description: id parameter for /share_instances/{id}/action API + in: path + name: id + required: true + schema: + type: string + share_instances_edit_id: + description: id parameter for /share_instances/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_instances_export_locations_export_location_uuid: + description: export_location_uuid parameter for + /share_instances/{share_instance_id}/export_locations/{export_location_uuid} + API + in: path + name: export_location_uuid + required: true + schema: + type: string + share_instances_export_locations_share_instance_id: + description: share_instance_id parameter for + /share_instances/{share_instance_id}/export_locations/{export_location_uuid} + API + in: path + name: share_instance_id + required: true + schema: + type: string + share_instances_id: + description: id parameter for /share_instances/{id} API + in: path + name: id + required: true + schema: + type: string + share_networks_action_id: + description: id parameter for /share-networks/{id}/action API + in: path + name: id + required: true + schema: + type: string + share_networks_edit_id: + description: id parameter for /share-networks/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_networks_id: + description: id parameter for /share-networks/{id} API + in: path + name: id + required: true + schema: + type: string + share_networks_subnets_metadata_key: + description: key parameter for + /share-networks/{share_network_id}/subnets/{resource_id}/metadata/{key} + API + in: path + name: key + required: true + schema: + type: string + share_networks_subnets_metadata_resource_id: + description: resource_id parameter for + /share-networks/{share_network_id}/subnets/{resource_id}/metadata/{key} + API + in: path + name: resource_id + required: true + schema: + type: string + share_networks_subnets_metadata_share_network_id: + description: share_network_id parameter for + /share-networks/{share_network_id}/subnets/{resource_id}/metadata/{key} + API + in: path + name: share_network_id + required: true + schema: + type: string + share_networks_subnets_share_network_id: + description: share_network_id parameter for + /share-networks/{share_network_id}/subnets API + in: path + name: share_network_id + required: true + schema: + type: string + share_networks_subnets_share_network_subnet_id: + description: share_network_subnet_id parameter for + /share-networks/{share_network_id}/subnets/{share_network_subnet_id} API + in: path + name: share_network_subnet_id + required: true + schema: + type: string + share_replicas_action_id: + description: id parameter for /share-replicas/{id}/action API + in: path + name: id + required: true + schema: + type: string + share_replicas_edit_id: + description: id parameter for /share-replicas/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_replicas_export_locations_export_location_uuid: + description: export_location_uuid parameter for + /share-replicas/{share_replica_id}/export-locations/{export_location_uuid} + API + in: path + name: export_location_uuid + required: true + schema: + type: string + share_replicas_export_locations_share_replica_id: + description: share_replica_id parameter for + /share-replicas/{share_replica_id}/export-locations/{export_location_uuid} + API + in: path + name: share_replica_id + required: true + schema: + type: string + share_replicas_id: + description: id parameter for /share-replicas/{id} API + in: path + name: id + required: true + schema: + type: string + share_servers_action_id: + description: id parameter for /share-servers/{id}/action API + in: path + name: id + required: true + schema: + type: string + share_servers_details_id: + description: id parameter for /share-servers/{id}/details API + in: path + name: id + required: true + schema: + type: string + share_servers_edit_id: + description: id parameter for /share-servers/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_servers_id: + description: id parameter for /share-servers/{id} API + in: path + name: id + required: true + schema: + type: string + share_transfers_accept_id: + description: id parameter for /share-transfers/{id}/accept API + in: path + name: id + required: true + schema: + type: string + share_transfers_edit_id: + description: id parameter for /share-transfers/{id}/edit API + in: path + name: id + required: true + schema: + type: string + share_transfers_id: + description: id parameter for /share-transfers/{id} API + in: path + name: id + required: true + schema: + type: string + shares_action_id: + description: id parameter for /shares/{id}/action API + in: path + name: id + required: true + schema: + type: string + shares_edit_id: + description: id parameter for /shares/{id}/edit API + in: path + name: id + required: true + schema: + type: string + shares_export_locations_export_location_uuid: + description: export_location_uuid parameter for + /shares/{share_id}/export_locations/{export_location_uuid} API + in: path + name: export_location_uuid + required: true + schema: + type: string + shares_export_locations_metadata_key: + description: key parameter for + /shares/{share_id}/export_locations/{resource_id}/metadata/{key} API + in: path + name: key + required: true + schema: + type: string + shares_export_locations_metadata_resource_id: + description: resource_id parameter for + /shares/{share_id}/export_locations/{resource_id}/metadata/{key} API + in: path + name: resource_id + required: true + schema: + type: string + shares_export_locations_metadata_share_id: + description: share_id parameter for + /shares/{share_id}/export_locations/{resource_id}/metadata/{key} API + in: path + name: share_id + required: true + schema: + type: string + shares_export_locations_share_id: + description: share_id parameter for + /shares/{share_id}/export_locations/{export_location_uuid} API + in: path + name: share_id + required: true + schema: + type: string + shares_id: + description: id parameter for /shares/{id} API + in: path + name: id + required: true + schema: + type: string + shares_instances_share_id: + description: share_id parameter for /shares/{share_id}/instances API + in: path + name: share_id + required: true + schema: + type: string + shares_metadata_key: + description: key parameter for /shares/{resource_id}/metadata/{key} API + in: path + name: key + required: true + schema: + type: string + shares_metadata_resource_id: + description: resource_id parameter for + /shares/{resource_id}/metadata/{key} API + in: path + name: resource_id + required: true + schema: + type: string + snapshot_instances_action_id: + description: id parameter for /snapshot-instances/{id}/action API + in: path + name: id + required: true + schema: + type: string + snapshot_instances_edit_id: + description: id parameter for /snapshot-instances/{id}/edit API + in: path + name: id + required: true + schema: + type: string + snapshot_instances_export_locations_export_location_id: + description: export_location_id parameter for + /snapshot-instances/{snapshot_instance_id}/export-locations/{export_location_id} + API + in: path + name: export_location_id + required: true + schema: + type: string + snapshot_instances_export_locations_snapshot_instance_id: + description: snapshot_instance_id parameter for + /snapshot-instances/{snapshot_instance_id}/export-locations/{export_location_id} + API + in: path + name: snapshot_instance_id + required: true + schema: + type: string + snapshot_instances_id: + description: id parameter for /snapshot-instances/{id} API + in: path + name: id + required: true + schema: + type: string + snapshots_access_list_snapshot_id: + description: snapshot_id parameter for + /snapshots/{snapshot_id}/access-list API + in: path + name: snapshot_id + required: true + schema: + type: string + snapshots_action_id: + description: id parameter for /snapshots/{id}/action API + in: path + name: id + required: true + schema: + type: string + snapshots_edit_id: + description: id parameter for /snapshots/{id}/edit API + in: path + name: id + required: true + schema: + type: string + snapshots_export_locations_export_location_id: + description: export_location_id parameter for + /snapshots/{snapshot_id}/export-locations/{export_location_id} API + in: path + name: export_location_id + required: true + schema: + type: string + snapshots_export_locations_snapshot_id: + description: snapshot_id parameter for + /snapshots/{snapshot_id}/export-locations/{export_location_id} API + in: path + name: snapshot_id + required: true + schema: + type: string + snapshots_id: + description: id parameter for /snapshots/{id} API + in: path + name: id + required: true + schema: + type: string + snapshots_metadata_key: + description: key parameter for /snapshots/{resource_id}/metadata/{key} API + in: path + name: key + required: true + schema: + type: string + snapshots_metadata_resource_id: + description: resource_id parameter for + /snapshots/{resource_id}/metadata/{key} API + in: path + name: resource_id + required: true + schema: + type: string + types_action_id: + description: id parameter for /types/{id}/action API + in: path + name: id + required: true + schema: + type: string + types_edit_id: + description: id parameter for /types/{id}/edit API + in: path + name: id + required: true + schema: + type: string + types_extra_specs_edit_id: + description: id parameter for /types/{type_id}/extra_specs/{id}/edit API + in: path + name: id + required: true + schema: + type: string + types_extra_specs_edit_type_id: + description: type_id parameter for /types/{type_id}/extra_specs/{id}/edit + API + in: path + name: type_id + required: true + schema: + type: string + types_extra_specs_id: + description: id parameter for /types/{type_id}/extra_specs/{id} API + in: path + name: id + required: true + schema: + type: string + types_extra_specs_new_type_id: + description: type_id parameter for /types/{type_id}/extra_specs/new API + in: path + name: type_id + required: true + schema: + type: string + types_extra_specs_type_id: + description: type_id parameter for /types/{type_id}/extra_specs/{id} API + in: path + name: type_id + required: true + schema: + type: string + types_id: + description: id parameter for /types/{id} API + in: path + name: id + required: true + schema: + type: string + types_os_share_type_access_id: + description: id parameter for /types/{id}/os-share-type-access API + in: path + name: id + required: true + schema: + type: string + types_share_type_access_id: + description: id parameter for /types/{id}/share_type_access API + in: path + name: id + required: true + schema: + type: string + schemas: + Availability_ZonesListResponse: + additionalProperties: false + properties: + availability_zones: + items: + additionalProperties: false + properties: + created_at: + format: date-time + type: string + id: + format: uuid + type: string + name: + maxLength: 255 + minLength: 1 + type: string + updated_at: + format: date-time + type: + - 'null' + - string + required: [] + type: object + type: array + required: + - availability_zones + type: object + ExtensionShowResponse: + description: Response of the extensions/id:get operation + type: object + ExtensionsCreateRequest: + description: Request of the extensions:post operation + type: object + x-openstack: + action-name: create + ExtensionsCreateResponse: + description: Response of the extensions:post operation + type: object + ExtensionsListResponse: + description: Response of the extensions:get operation + type: object + LimitsListResponse: + description: Response of the limits:get operation + type: object + MessageShowResponse: + additionalProperties: false + properties: + message: + additionalProperties: false + properties: + action_id: + type: string + created_at: + format: date-time + type: string + detail_id: + type: string + expires_at: + format: date-time + type: string + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + message_level: + enum: + - ERROR + type: string + project_id: + type: string + request_id: + type: string + resource_id: + format: uuid + type: string + resource_type: + type: string + user_message: + type: string + required: + - action_id + - created_at + - detail_id + - expires_at + - id + - links + - message_level + - project_id + - request_id + - resource_id + - resource_type + - user_message + type: object + required: + - message + type: object + MessagesListResponse: + additionalProperties: false + properties: + messages: + items: + additionalProperties: false + properties: + action_id: + type: string + created_at: + format: date-time + type: string + detail_id: + type: string + expires_at: + format: date-time + type: string + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + message_level: + enum: + - ERROR + type: string + project_id: + type: string + request_id: + type: string + resource_id: + format: uuid + type: string + resource_type: + type: string + user_message: + type: string + required: + - action_id + - created_at + - detail_id + - expires_at + - id + - links + - message_level + - project_id + - request_id + - resource_id + - resource_type + - user_message + type: object + type: array + messages_links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + required: + - messages + type: object + Os_Availability_ZoneListResponse: + additionalProperties: false + properties: + availability_zones: + items: + additionalProperties: false + properties: + created_at: + format: date-time + type: string + id: + format: uuid + type: string + name: + maxLength: 255 + minLength: 1 + type: string + updated_at: + format: date-time + type: + - 'null' + - string + required: [] + type: object + type: array + required: + - availability_zones + type: object + Os_Quota_Class_SetShowResponse: + description: Response of the os-quota-class-sets/id:get operation + type: object + Os_Quota_Class_SetUpdateRequest: + description: Request of the os-quota-class-sets/id:put operation + type: object + x-openstack: + action-name: update + Os_Quota_Class_SetUpdateResponse: + description: Response of the os-quota-class-sets/id:put operation + type: object + Os_Quota_SetShowResponse: + description: Response of the os-quota-sets/id:get operation + type: object + Os_Quota_SetUpdateRequest: + description: Request of the os-quota-sets/id:put operation + type: object + x-openstack: + action-name: update + Os_Quota_SetUpdateResponse: + description: Response of the os-quota-sets/id:put operation + type: object + Os_Quota_SetsDefaultsResponse: + description: Response of the os-quota-sets/id/defaults:get operation + type: object + Os_ServiceUpdateRequest: + description: Request of the os-services/id:put operation + type: object + x-openstack: + action-name: update + Os_ServiceUpdateResponse: + description: Response of the os-services/id:put operation + type: object + Os_ServicesListResponse: + description: Response of the os-services:get operation + type: object + Os_Share_ManageCreateRequest: + description: Request of the os-share-manage:post operation + type: object + x-openstack: + action-name: create + Os_Share_ManageCreateResponse: + description: Response of the os-share-manage:post operation + type: object + Os_Share_UnmanageUnmanageResponse: + description: Response of the os-share-unmanage/id/unmanage:post operation + type: object + Os_Share_UnmanageUnmanageUnmanageRequest: + description: Request of the os-share-unmanage/id/unmanage:post operation + type: object + x-openstack: + action-name: unmanage + Quota_Class_SetShowResponse: + description: Response of the quota-class-sets/id:get operation + type: object + Quota_Class_SetUpdateRequest: + description: Request of the quota-class-sets/id:put operation + type: object + x-openstack: + action-name: update + Quota_Class_SetUpdateResponse: + description: Response of the quota-class-sets/id:put operation + type: object + Quota_SetShowResponse: + description: Response of the quota-sets/id:get operation + type: object + Quota_SetUpdateRequest: + description: Request of the quota-sets/id:put operation + type: object + x-openstack: + action-name: update + Quota_SetUpdateResponse: + description: Response of the quota-sets/id:put operation + type: object + Quota_SetsDefaultsResponse: + description: Response of the quota-sets/id/defaults:get operation + type: object + Quota_SetsDetailResponse: + description: Response of the quota-sets/id/detail:get operation + type: object + Resource_LockShowResponse: + additionalProperties: false + properties: + resource_lock: + additionalProperties: false + description: "A resource lock object when making resource lock requests. + All other\nparameters are included in this object.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + type: string + id: + description: "The UUID identifying the specific resource lock.\n" + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + lock_context: + description: "The lock creator's context. Resource locks can be created + by users with\ndifferent roles. If a user with ``admin`` role creates + the lock, the value\nof this field is ``admin``. If a user with ``service`` + role creates the\nlock, the value of this field is ``service``. For + all other contexts, the\nvalue of this field is ``user``. This field + also determines the user's\nrole that is required to unlock or manipulate + a lock by virtue of the\nservice's default RBAC.\n" + type: string + lock_reason: + description: "A blob of text representing the reason for the specific + resource lock.\n" + type: + - 'null' + - string + project_id: + description: "The ID of the project that the resource lock was created + for.\n" + format: uuid + type: string + resource_action: + description: "The action pertaining to a resource that the resource + lock prevents. For\nexample, if a resource lock prevents deletion + of a share, the value of\n``resource_action`` is ``delete``. Resource + locks are not supported for\nall API actions.\n" + enum: + - delete + - show + type: string + resource_id: + description: "The UUID of the resource that the lock pertains to. For + example, this\ncan be the ID of the share that is locked from deletion.\n" + format: uuid + type: string + resource_type: + description: "The type of resource that the ID in ``resource_id`` denotes. + For\nexample, ``share`` is the resource type that is specified when + the\nresource lock pertains to a share being locked from deletion. + Resource\nlocks are not supported for all resources. Currently support + only\nexists for ``share``.\n" + enum: + - access_rule + - share + type: string + updated_at: + description: "The date and time stamp when the resource was last updated + within the\nservice's database. If a resource was never updated after + it was\ncreated, the value of this parameter is set to ``null``.\n\ + \nThe date and time stamp format is `ISO 8601\n`_:\n\ + \n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n" + format: date-time + type: + - 'null' + - string + user_id: + description: "The ID of the user the resource lock was created for.\n" + format: uuid + type: string + required: + - created_at + - id + - links + - lock_context + - lock_reason + - project_id + - resource_action + - resource_id + - resource_type + - updated_at + - user_id + type: object + required: + - resource_lock + type: object + Resource_LockUpdateResponse: + additionalProperties: false + properties: + resource_lock: + additionalProperties: false + description: "A resource lock object when making resource lock requests. + All other\nparameters are included in this object.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + type: string + id: + description: "The UUID identifying the specific resource lock.\n" + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + lock_context: + description: "The lock creator's context. Resource locks can be created + by users with\ndifferent roles. If a user with ``admin`` role creates + the lock, the value\nof this field is ``admin``. If a user with ``service`` + role creates the\nlock, the value of this field is ``service``. For + all other contexts, the\nvalue of this field is ``user``. This field + also determines the user's\nrole that is required to unlock or manipulate + a lock by virtue of the\nservice's default RBAC.\n" + type: string + lock_reason: + description: "A blob of text representing the reason for the specific + resource lock.\n" + type: + - 'null' + - string + project_id: + description: "The ID of the project that the resource lock was created + for.\n" + format: uuid + type: string + resource_action: + description: "The action pertaining to a resource that the resource + lock prevents. For\nexample, if a resource lock prevents deletion + of a share, the value of\n``resource_action`` is ``delete``. Resource + locks are not supported for\nall API actions.\n" + enum: + - delete + - show + type: string + resource_id: + description: "The UUID of the resource that the lock pertains to. For + example, this\ncan be the ID of the share that is locked from deletion.\n" + format: uuid + type: string + resource_type: + description: "The type of resource that the ID in ``resource_id`` denotes. + For\nexample, ``share`` is the resource type that is specified when + the\nresource lock pertains to a share being locked from deletion. + Resource\nlocks are not supported for all resources. Currently support + only\nexists for ``share``.\n" + enum: + - access_rule + - share + type: string + updated_at: + description: "The date and time stamp when the resource was last updated + within the\nservice's database. If a resource was never updated after + it was\ncreated, the value of this parameter is set to ``null``.\n\ + \nThe date and time stamp format is `ISO 8601\n`_:\n\ + \n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n" + format: date-time + type: + - 'null' + - string + user_id: + description: "The ID of the user the resource lock was created for.\n" + format: uuid + type: string + required: + - created_at + - id + - links + - lock_context + - lock_reason + - project_id + - resource_action + - resource_id + - resource_type + - updated_at + - user_id + type: object + required: + - resource_lock + type: object + Resource_LockUpdate_281: + additionalProperties: true + properties: + resource_lock: + additionalProperties: false + description: "A resource lock object when making resource lock requests. + All other\nparameters are included in this object.\n" + properties: + lock_reason: + description: "A blob of text representing the reason for the specific + resource lock.\n" + maxLength: 1023 + type: + - 'null' + - string + resource_action: + description: "The action pertaining to a resource that the resource + lock prevents. For\nexample, if a resource lock prevents deletion + of a share, the value of\n``resource_action`` is ``delete``. Resource + locks are not supported for\nall API actions.\n" + enum: + - + - delete + - show + type: + - 'null' + - string + type: object + required: + - resource_lock + type: object + x-openstack: + min-ver: '2.81' + Resource_LocksCreateResponse: + additionalProperties: false + properties: + resource_lock: + additionalProperties: false + description: "A resource lock object when making resource lock requests. + All other\nparameters are included in this object.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + type: string + id: + description: "The UUID identifying the specific resource lock.\n" + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + lock_context: + description: "The lock creator's context. Resource locks can be created + by users with\ndifferent roles. If a user with ``admin`` role creates + the lock, the value\nof this field is ``admin``. If a user with ``service`` + role creates the\nlock, the value of this field is ``service``. For + all other contexts, the\nvalue of this field is ``user``. This field + also determines the user's\nrole that is required to unlock or manipulate + a lock by virtue of the\nservice's default RBAC.\n" + type: string + lock_reason: + description: "A blob of text representing the reason for the specific + resource lock.\n" + type: + - 'null' + - string + project_id: + description: "The ID of the project that the resource lock was created + for.\n" + format: uuid + type: string + resource_action: + description: "The action pertaining to a resource that the resource + lock prevents. For\nexample, if a resource lock prevents deletion + of a share, the value of\n``resource_action`` is ``delete``. Resource + locks are not supported for\nall API actions.\n" + enum: + - delete + - show + type: string + resource_id: + description: "The UUID of the resource that the lock pertains to. For + example, this\ncan be the ID of the share that is locked from deletion.\n" + format: uuid + type: string + resource_type: + description: "The type of resource that the ID in ``resource_id`` denotes. + For\nexample, ``share`` is the resource type that is specified when + the\nresource lock pertains to a share being locked from deletion. + Resource\nlocks are not supported for all resources. Currently support + only\nexists for ``share``.\n" + enum: + - access_rule + - share + type: string + updated_at: + description: "The date and time stamp when the resource was last updated + within the\nservice's database. If a resource was never updated after + it was\ncreated, the value of this parameter is set to ``null``.\n\ + \nThe date and time stamp format is `ISO 8601\n`_:\n\ + \n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n" + format: date-time + type: + - 'null' + - string + user_id: + description: "The ID of the user the resource lock was created for.\n" + format: uuid + type: string + required: + - created_at + - id + - links + - lock_context + - lock_reason + - project_id + - resource_action + - resource_id + - resource_type + - updated_at + - user_id + type: object + required: + - resource_lock + type: object + Resource_LocksCreate_281: + additionalProperties: true + properties: + resource_lock: + additionalProperties: false + description: "A resource lock object when making resource lock requests. + All other\nparameters are included in this object.\n" + properties: + lock_reason: + description: "A blob of text representing the reason for the specific + resource lock.\n" + maxLength: 1023 + type: + - 'null' + - string + resource_action: + default: delete + description: "The action pertaining to a resource that the resource + lock prevents. For\nexample, if a resource lock prevents deletion + of a share, the value of\n``resource_action`` is ``delete``. Resource + locks are not supported for\nall API actions. Currently support only + exists for ``delete``, and for\nspecific resources. If not provided, + the value of this parameter\ndefaults to ``delete``.\n" + enum: + - + - delete + - show + type: + - 'null' + - string + resource_id: + description: "The UUID of the resource that the lock pertains to. For + example, this\ncan be the ID of the share that is locked from deletion.\n" + format: uuid + type: string + resource_type: + default: share + description: "The type of resource that the ID in ``resource_id`` denotes. + For\nexample, ``share`` is the resource type that is specified when + the\nresource lock pertains to a share being locked from deletion. + Resource\nlocks are not supported for all resources. Currently support + only\nexists for ``share``.\n" + enum: + - + - access_rule + - share + type: + - 'null' + - string + required: + - resource_id + type: object + required: + - resource_lock + type: object + x-openstack: + min-ver: '2.81' + Resource_LocksListResponse: + additionalProperties: false + properties: + count: + description: "The total count of requested resource before pagination is + applied. This\nparameter is only present in the API response if \"with_count=True\"\ + \ is\nsupplied in the query.\n" + type: integer + resource_locks: + items: + additionalProperties: false + description: "A resource lock object when making resource lock requests. + All other\nparameters are included in this object.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\ + \n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + type: string + id: + description: "The UUID identifying the specific resource lock.\n" + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + lock_context: + description: "The lock creator's context. Resource locks can be created + by users with\ndifferent roles. If a user with ``admin`` role creates + the lock, the value\nof this field is ``admin``. If a user with + ``service`` role creates the\nlock, the value of this field is ``service``. + For all other contexts, the\nvalue of this field is ``user``. This + field also determines the user's\nrole that is required to unlock + or manipulate a lock by virtue of the\nservice's default RBAC.\n" + type: string + lock_reason: + description: "A blob of text representing the reason for the specific + resource lock.\n" + type: + - 'null' + - string + project_id: + description: "The ID of the project that the resource lock was created + for.\n" + format: uuid + type: string + resource_action: + description: "The action pertaining to a resource that the resource + lock prevents. For\nexample, if a resource lock prevents deletion + of a share, the value of\n``resource_action`` is ``delete``. Resource + locks are not supported for\nall API actions.\n" + enum: + - delete + - show + type: string + resource_id: + description: "The UUID of the resource that the lock pertains to. + For example, this\ncan be the ID of the share that is locked from + deletion.\n" + format: uuid + type: string + resource_type: + description: "The type of resource that the ID in ``resource_id`` + denotes. For\nexample, ``share`` is the resource type that is specified + when the\nresource lock pertains to a share being locked from deletion. + Resource\nlocks are not supported for all resources. Currently support + only\nexists for ``share``.\n" + enum: + - access_rule + - share + type: string + updated_at: + description: "The date and time stamp when the resource was last updated + within the\nservice's database. If a resource was never updated + after it was\ncreated, the value of this parameter is set to ``null``.\n\ + \nThe date and time stamp format is `ISO 8601\n`_:\n\ + \n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if + included, returns the time zone as an\noffset from UTC.\n\nFor example, + ``2016-12-31T13:14:15-05:00``.\n" + format: date-time + type: + - 'null' + - string + user_id: + description: "The ID of the user the resource lock was created for.\n" + format: uuid + type: string + required: + - created_at + - id + - links + - lock_context + - lock_reason + - project_id + - resource_action + - resource_id + - resource_type + - updated_at + - user_id + type: object + type: array + resource_locks_links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + required: + - resource_locks + type: object + RootListResponse: + description: Response of the :get operation + type: object + Scheduler_StatsPoolsDetailPools_DetailResponse: + description: Response of the scheduler-stats/pools/detail:get operation + type: object + Scheduler_StatsPoolsPools_ListResponse: + description: Response of the scheduler-stats/pools:get operation + type: object + Security_ServiceShowResponse: + description: Response of the security-services/id:get operation + type: object + Security_ServiceUpdateRequest: + description: Request of the security-services/id:put operation + type: object + x-openstack: + action-name: update + Security_ServiceUpdateResponse: + description: Response of the security-services/id:put operation + type: object + Security_ServicesCreateRequest: + description: Request of the security-services:post operation + type: object + x-openstack: + action-name: create + Security_ServicesCreateResponse: + description: Response of the security-services:post operation + type: object + Security_ServicesDetailResponse: + description: Response of the security-services/detail:get operation + type: object + Security_ServicesListResponse: + description: Response of the security-services:get operation + type: object + ServiceUpdateRequest: + description: Request of the services/id:put operation + type: object + x-openstack: + action-name: update + ServiceUpdateResponse: + description: Response of the services/id:put operation + type: object + ServicesEnsure_SharesEnsure_SharesRequest: + description: Request of the services/ensure-shares:post operation + type: object + x-openstack: + action-name: ensure_shares + ServicesEnsure_SharesResponse: + description: Response of the services/ensure-shares:post operation + type: object + ServicesListResponse: + description: Response of the services:get operation + type: object + ShareShowResponse: + description: Response of the shares/id:get operation + type: object + ShareUpdateRequest: + description: Request of the shares/id:put operation + type: object + x-openstack: + action-name: update + ShareUpdateResponse: + description: Response of the shares/id:put operation + type: object + Share_Access_RuleShowResponse: + description: Response of the share-access-rules/id:get operation + type: object + Share_Access_RuleUpdateRequest: + description: Request of the share-access-rules/id:put operation + type: object + x-openstack: + action-name: update + Share_Access_RuleUpdateResponse: + description: Response of the share-access-rules/id:put operation + type: object + Share_Access_RulesListResponse: + description: Response of the share-access-rules:get operation + type: object + Share_Access_RulesMetadataUpdateRequest: + description: Request of the share-access-rules/access_id/metadata:put + operation + type: object + x-openstack: + action-name: update + Share_Access_RulesMetadataUpdateResponse: + description: Response of the share-access-rules/access_id/metadata:put + operation + type: object + Share_BackupShowResponse: + description: Response of the share-backups/id:get operation + type: object + Share_BackupUpdateRequest: + description: Request of the share-backups/id:put operation + type: object + x-openstack: + action-name: update + Share_BackupUpdateResponse: + description: Response of the share-backups/id:put operation + type: object + Share_BackupsActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + Share_BackupsActionReset_StatusResponse: + description: Response of the share-backups/id/action:post:reset_status + action + type: object + x-openstack: + action-name: reset_status + Share_BackupsActionRestoreRequest: + description: Empty body for restore action + properties: + restore: + type: 'null' + type: object + x-openstack: + action-name: restore + Share_BackupsActionRestoreResponse: + description: Response of the share-backups/id/action:post:restore action + type: object + x-openstack: + action-name: restore + Share_BackupsCreateRequest: + description: Request of the share-backups:post operation + type: object + x-openstack: + action-name: create + Share_BackupsCreateResponse: + description: Response of the share-backups:post operation + type: object + Share_BackupsDetailResponse: + description: Response of the share-backups/detail:get operation + type: object + Share_BackupsListResponse: + description: Response of the share-backups:get operation + type: object + Share_GroupShowResponse: + description: Response of the share-groups/id:get operation + type: object + Share_GroupUpdateRequest: + description: Request of the share-groups/id:put operation + type: object + x-openstack: + action-name: update + Share_GroupUpdateResponse: + description: Response of the share-groups/id:put operation + type: object + Share_Group_SnapshotShowResponse: + description: Response of the share-group-snapshots/id:get operation + type: object + Share_Group_SnapshotUpdateRequest: + description: Request of the share-group-snapshots/id:put operation + type: object + x-openstack: + action-name: update + Share_Group_SnapshotUpdateResponse: + description: Response of the share-group-snapshots/id:put operation + type: object + Share_Group_SnapshotsActionForce_DeleteRequest: + description: Empty body for force_delete action + properties: + force_delete: + type: 'null' + type: object + x-openstack: + action-name: force_delete + Share_Group_SnapshotsActionForce_DeleteResponse: + description: Response of the + share-group-snapshots/id/action:post:force_delete action + type: object + x-openstack: + action-name: force_delete + Share_Group_SnapshotsActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + Share_Group_SnapshotsActionReset_StatusResponse: + description: Response of the + share-group-snapshots/id/action:post:reset_status action + type: object + x-openstack: + action-name: reset_status + Share_Group_SnapshotsCreateRequest: + description: Request of the share-group-snapshots:post operation + type: object + x-openstack: + action-name: create + Share_Group_SnapshotsCreateResponse: + description: Response of the share-group-snapshots:post operation + type: object + Share_Group_SnapshotsDetailResponse: + description: Response of the share-group-snapshots/detail:get operation + type: object + Share_Group_SnapshotsListResponse: + description: Response of the share-group-snapshots:get operation + type: object + Share_Group_SnapshotsMembersResponse: + description: Response of the share-group-snapshots/id/members:get + operation + type: object + Share_Group_TypeShowResponse: + description: Response of the share-group-types/id:get operation + type: object + Share_Group_TypesAccessShare_Group_Type_AccessResponse: + description: Response of the share-group-types/id/access:get operation + type: object + Share_Group_TypesActionAddprojectaccessRequest: + description: Empty body for addProjectAccess action + properties: + addProjectAccess: + type: 'null' + type: object + x-openstack: + action-name: addProjectAccess + Share_Group_TypesActionAddprojectaccessResponse: + description: Response of the + share-group-types/id/action:post:addProjectAccess action + type: object + x-openstack: + action-name: addProjectAccess + Share_Group_TypesActionCreateRequest: + description: Empty body for create action + properties: + create: + type: 'null' + type: object + x-openstack: + action-name: create + Share_Group_TypesActionCreateResponse: + description: Response of the share-group-types/id/action:post:create + action + type: object + x-openstack: + action-name: create + Share_Group_TypesActionDeleteRequest: + description: Empty body for delete action + properties: + delete: + type: 'null' + type: object + x-openstack: + action-name: delete + Share_Group_TypesActionDeleteResponse: + description: Response of the share-group-types/id/action:post:delete + action + type: object + x-openstack: + action-name: delete + Share_Group_TypesActionRemoveprojectaccessRequest: + description: Empty body for removeProjectAccess action + properties: + removeProjectAccess: + type: 'null' + type: object + x-openstack: + action-name: removeProjectAccess + Share_Group_TypesActionRemoveprojectaccessResponse: + description: Response of the + share-group-types/id/action:post:removeProjectAccess action + type: object + x-openstack: + action-name: removeProjectAccess + Share_Group_TypesCreateRequest: + description: Request of the share-group-types:post operation + type: object + x-openstack: + action-name: create + Share_Group_TypesCreateResponse: + description: Response of the share-group-types:post:create action + type: object + x-openstack: + action-name: create + Share_Group_TypesDefaultResponse: + description: Response of the share-group-types/default:get operation + type: object + Share_Group_TypesGroup_SpecShowResponse: + description: Response of the share-group-types/id/group-specs/key:get + operation + type: object + Share_Group_TypesGroup_SpecUpdateRequest: + description: Request of the share-group-types/id/group-specs/key:put + operation + type: object + x-openstack: + action-name: update + Share_Group_TypesGroup_SpecUpdateResponse: + description: Response of the share-group-types/id/group-specs/key:put + operation + type: object + Share_Group_TypesGroup_SpecsCreateRequest: + description: Request of the share-group-types/id/group-specs:post + operation + type: object + x-openstack: + action-name: create + Share_Group_TypesGroup_SpecsCreateResponse: + description: Response of the share-group-types/id/group-specs:post + operation + type: object + Share_Group_TypesGroup_SpecsListResponse: + description: Response of the share-group-types/id/group-specs:get + operation + type: object + Share_Group_TypesListResponse: + description: Response of the share-group-types:get operation + type: object + Share_GroupsActionForce_DeleteRequest: + description: Empty body for force_delete action + properties: + force_delete: + type: 'null' + type: object + x-openstack: + action-name: force_delete + Share_GroupsActionForce_DeleteResponse: + description: Response of the share-groups/id/action:post:force_delete + action + type: object + x-openstack: + action-name: force_delete + Share_GroupsActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + Share_GroupsActionReset_StatusResponse: + description: Response of the share-groups/id/action:post:reset_status + action + type: object + x-openstack: + action-name: reset_status + Share_GroupsCreateRequest: + description: Request of the share-groups:post operation + type: object + x-openstack: + action-name: create + Share_GroupsCreateResponse: + description: Response of the share-groups:post operation + type: object + Share_GroupsDetailResponse: + description: Response of the share-groups/detail:get operation + type: object + Share_GroupsListResponse: + description: Response of the share-groups:get operation + type: object + Share_InstanceShowResponse: + description: Response of the share_instances/id:get operation + type: object + Share_InstancesActionForce_DeleteRequest: + description: Empty body for force_delete action + properties: + force_delete: + type: 'null' + type: object + x-openstack: + action-name: force_delete + Share_InstancesActionForce_DeleteResponse: + description: Response of the share_instances/id/action:post:force_delete + action + type: object + x-openstack: + action-name: force_delete + Share_InstancesActionOs-Force_DeleteRequest: + description: Empty body for os-force_delete action + properties: + os-force_delete: + type: 'null' + type: object + x-openstack: + action-name: os-force_delete + Share_InstancesActionOs-Force_DeleteResponse: + description: Response of the + share_instances/id/action:post:os-force_delete action + type: object + x-openstack: + action-name: os-force_delete + Share_InstancesActionOs-Reset_StatusRequest: + description: Empty body for os-reset_status action + properties: + os-reset_status: + type: 'null' + type: object + x-openstack: + action-name: os-reset_status + Share_InstancesActionOs-Reset_StatusResponse: + description: Response of the + share_instances/id/action:post:os-reset_status action + type: object + x-openstack: + action-name: os-reset_status + Share_InstancesActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + Share_InstancesActionReset_StatusResponse: + description: Response of the share_instances/id/action:post:reset_status + action + type: object + x-openstack: + action-name: reset_status + Share_InstancesExport_LocationShowResponse: + description: Response of the + share_instances/share_instance_id/export_locations/export_location_uuid:get + operation + type: object + Share_InstancesExport_LocationsListResponse: + description: Response of the + share_instances/share_instance_id/export_locations:get operation + type: object + Share_InstancesListResponse: + description: Response of the share_instances:get operation + type: object + Share_NetworkShowResponse: + description: Response of the share-networks/id:get operation + type: object + Share_NetworkUpdateRequest: + description: Request of the share-networks/id:put operation + type: object + x-openstack: + action-name: update + Share_NetworkUpdateResponse: + description: Response of the share-networks/id:put operation + type: object + Share_NetworksActionAdd_Security_ServiceRequest: + description: Empty body for add_security_service action + properties: + add_security_service: + type: 'null' + type: object + x-openstack: + action-name: add_security_service + Share_NetworksActionAdd_Security_ServiceResponse: + description: Response of the + share-networks/id/action:post:add_security_service action + type: object + x-openstack: + action-name: add_security_service + Share_NetworksActionAdd_Security_Service_CheckRequest: + description: Empty body for add_security_service_check action + properties: + add_security_service_check: + type: 'null' + type: object + x-openstack: + action-name: add_security_service_check + Share_NetworksActionAdd_Security_Service_CheckResponse: + description: Response of the + share-networks/id/action:post:add_security_service_check action + type: object + x-openstack: + action-name: add_security_service_check + Share_NetworksActionRemove_Security_ServiceRequest: + description: Empty body for remove_security_service action + properties: + remove_security_service: + type: 'null' + type: object + x-openstack: + action-name: remove_security_service + Share_NetworksActionRemove_Security_ServiceResponse: + description: Response of the + share-networks/id/action:post:remove_security_service action + type: object + x-openstack: + action-name: remove_security_service + Share_NetworksActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + Share_NetworksActionReset_StatusResponse: + description: Response of the share-networks/id/action:post:reset_status + action + type: object + x-openstack: + action-name: reset_status + Share_NetworksActionShare_Network_Subnet_Create_CheckRequest: + description: Empty body for share_network_subnet_create_check action + properties: + share_network_subnet_create_check: + type: 'null' + type: object + x-openstack: + action-name: share_network_subnet_create_check + Share_NetworksActionShare_Network_Subnet_Create_CheckResponse: + description: Response of the + share-networks/id/action:post:share_network_subnet_create_check action + type: object + x-openstack: + action-name: share_network_subnet_create_check + Share_NetworksActionUpdate_Security_ServiceRequest: + description: Empty body for update_security_service action + properties: + update_security_service: + type: 'null' + type: object + x-openstack: + action-name: update_security_service + Share_NetworksActionUpdate_Security_ServiceResponse: + description: Response of the + share-networks/id/action:post:update_security_service action + type: object + x-openstack: + action-name: update_security_service + Share_NetworksActionUpdate_Security_Service_CheckRequest: + description: Empty body for update_security_service_check action + properties: + update_security_service_check: + type: 'null' + type: object + x-openstack: + action-name: update_security_service_check + Share_NetworksActionUpdate_Security_Service_CheckResponse: + description: Response of the + share-networks/id/action:post:update_security_service_check action + type: object + x-openstack: + action-name: update_security_service_check + Share_NetworksCreateRequest: + description: Request of the share-networks:post operation + type: object + x-openstack: + action-name: create + Share_NetworksCreateResponse: + description: Response of the share-networks:post operation + type: object + Share_NetworksDetailResponse: + description: Response of the share-networks/detail:get operation + type: object + Share_NetworksListResponse: + description: Response of the share-networks:get operation + type: object + Share_NetworksSubnetShowResponse: + description: Response of the + share-networks/share_network_id/subnets/share_network_subnet_id:get + operation + type: object + Share_NetworksSubnetsCreateRequest: + description: Request of the share-networks/share_network_id/subnets:post + operation + type: object + x-openstack: + action-name: create + Share_NetworksSubnetsCreateResponse: + description: Response of the share-networks/share_network_id/subnets:post + operation + type: object + Share_NetworksSubnetsListResponse: + description: Response of the share-networks/share_network_id/subnets:get + operation + type: object + Share_NetworksSubnetsMetadataCreate_MetadataRequest: + description: Request of the + share-networks/share_network_id/subnets/resource_id/metadata:post + operation + type: object + x-openstack: + action-name: create_metadata + Share_NetworksSubnetsMetadataCreate_MetadataResponse: + description: Response of the + share-networks/share_network_id/subnets/resource_id/metadata:post + operation + type: object + Share_NetworksSubnetsMetadataList_MetadataResponse: + description: Response of the + share-networks/share_network_id/subnets/resource_id/metadata:get + operation + type: object + Share_NetworksSubnetsMetadataShow_MetadataResponse: + description: Response of the + share-networks/share_network_id/subnets/resource_id/metadata/key:get + operation + type: object + Share_NetworksSubnetsMetadataUpdate_All_MetadataRequest: + description: Request of the + share-networks/share_network_id/subnets/resource_id/metadata:put + operation + type: object + x-openstack: + action-name: update_all_metadata + Share_NetworksSubnetsMetadataUpdate_All_MetadataResponse: + description: Response of the + share-networks/share_network_id/subnets/resource_id/metadata:put + operation + type: object + Share_NetworksSubnetsMetadataUpdate_Metadata_ItemRequest: + description: Request of the + share-networks/share_network_id/subnets/resource_id/metadata/key:post + operation + type: object + x-openstack: + action-name: update_metadata_item + Share_NetworksSubnetsMetadataUpdate_Metadata_ItemResponse: + description: Response of the + share-networks/share_network_id/subnets/resource_id/metadata/key:post + operation + type: object + Share_ReplicaShowResponse: + description: Response of the share-replicas/id:get operation + type: object + Share_ReplicasActionForce_DeleteRequest: + description: Empty body for force_delete action + properties: + force_delete: + type: 'null' + type: object + x-openstack: + action-name: force_delete + Share_ReplicasActionForce_DeleteResponse: + description: Response of the share-replicas/id/action:post:force_delete + action + type: object + x-openstack: + action-name: force_delete + Share_ReplicasActionPromoteRequest: + description: Empty body for promote action + properties: + promote: + type: 'null' + type: object + x-openstack: + action-name: promote + Share_ReplicasActionPromoteResponse: + description: Response of the share-replicas/id/action:post:promote action + type: object + x-openstack: + action-name: promote + Share_ReplicasActionReset_Replica_StateRequest: + description: Empty body for reset_replica_state action + properties: + reset_replica_state: + type: 'null' + type: object + x-openstack: + action-name: reset_replica_state + Share_ReplicasActionReset_Replica_StateResponse: + description: Response of the + share-replicas/id/action:post:reset_replica_state action + type: object + x-openstack: + action-name: reset_replica_state + Share_ReplicasActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + Share_ReplicasActionReset_StatusResponse: + description: Response of the share-replicas/id/action:post:reset_status + action + type: object + x-openstack: + action-name: reset_status + Share_ReplicasActionResyncRequest: + description: Empty body for resync action + properties: + resync: + type: 'null' + type: object + x-openstack: + action-name: resync + Share_ReplicasActionResyncResponse: + description: Response of the share-replicas/id/action:post:resync action + type: object + x-openstack: + action-name: resync + Share_ReplicasCreateRequest: + description: Request of the share-replicas:post operation + type: object + x-openstack: + action-name: create + Share_ReplicasCreateResponse: + description: Response of the share-replicas:post operation + type: object + Share_ReplicasDetailResponse: + description: Response of the share-replicas/detail:get operation + type: object + Share_ReplicasExport_LocationShowResponse: + description: Response of the + share-replicas/share_replica_id/export-locations/export_location_uuid:get + operation + type: object + Share_ReplicasExport_LocationsListResponse: + description: Response of the + share-replicas/share_replica_id/export-locations:get operation + type: object + Share_ReplicasListResponse: + description: Response of the share-replicas:get operation + type: object + Share_ServerShowResponse: + description: Response of the share-servers/id:get operation + type: object + Share_ServersActionMigration_CancelRequest: + description: Empty body for migration_cancel action + properties: + migration_cancel: + type: 'null' + type: object + x-openstack: + action-name: migration_cancel + Share_ServersActionMigration_CancelResponse: + description: Response of the share-servers/id/action:post:migration_cancel + action + type: object + x-openstack: + action-name: migration_cancel + Share_ServersActionMigration_CheckRequest: + description: Empty body for migration_check action + properties: + migration_check: + type: 'null' + type: object + x-openstack: + action-name: migration_check + Share_ServersActionMigration_CheckResponse: + description: Response of the share-servers/id/action:post:migration_check + action + type: object + x-openstack: + action-name: migration_check + Share_ServersActionMigration_CompleteRequest: + description: Empty body for migration_complete action + properties: + migration_complete: + type: 'null' + type: object + x-openstack: + action-name: migration_complete + Share_ServersActionMigration_CompleteResponse: + description: Response of the + share-servers/id/action:post:migration_complete action + type: object + x-openstack: + action-name: migration_complete + Share_ServersActionMigration_Get_ProgressRequest: + description: Empty body for migration_get_progress action + properties: + migration_get_progress: + type: 'null' + type: object + x-openstack: + action-name: migration_get_progress + Share_ServersActionMigration_Get_ProgressResponse: + description: Response of the + share-servers/id/action:post:migration_get_progress action + type: object + x-openstack: + action-name: migration_get_progress + Share_ServersActionMigration_StartRequest: + description: Empty body for migration_start action + properties: + migration_start: + type: 'null' + type: object + x-openstack: + action-name: migration_start + Share_ServersActionMigration_StartResponse: + description: Response of the share-servers/id/action:post:migration_start + action + type: object + x-openstack: + action-name: migration_start + Share_ServersActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + Share_ServersActionReset_StatusResponse: + description: Response of the share-servers/id/action:post:reset_status + action + type: object + x-openstack: + action-name: reset_status + Share_ServersActionReset_Task_StateRequest: + description: Empty body for reset_task_state action + properties: + reset_task_state: + type: 'null' + type: object + x-openstack: + action-name: reset_task_state + Share_ServersActionReset_Task_StateResponse: + description: Response of the share-servers/id/action:post:reset_task_state + action + type: object + x-openstack: + action-name: reset_task_state + Share_ServersActionUnmanageRequest: + description: Empty body for unmanage action + properties: + unmanage: + type: 'null' + type: object + x-openstack: + action-name: unmanage + Share_ServersActionUnmanageResponse: + description: Response of the share-servers/id/action:post:unmanage action + type: object + x-openstack: + action-name: unmanage + Share_ServersDetailsResponse: + description: Response of the share-servers/id/details:get operation + type: object + Share_ServersListResponse: + description: Response of the share-servers:get operation + type: object + Share_ServersManageManageRequest: + description: Request of the share-servers/manage:post operation + type: object + x-openstack: + action-name: manage + Share_ServersManageResponse: + description: Response of the share-servers/manage:post operation + type: object + Share_TransferShowResponse: + description: Response of the share-transfers/id:get operation + type: object + Share_TransfersAcceptAcceptRequest: + description: Request of the share-transfers/id/accept:post operation + type: object + x-openstack: + action-name: accept + Share_TransfersAcceptResponse: + description: Response of the share-transfers/id/accept:post operation + type: object + Share_TransfersCreateRequest: + description: Request of the share-transfers:post operation + type: object + x-openstack: + action-name: create + Share_TransfersCreateResponse: + description: Response of the share-transfers:post operation + type: object + Share_TransfersDetailResponse: + description: Response of the share-transfers/detail:get operation + type: object + Share_TransfersListResponse: + description: Response of the share-transfers:get operation + type: object + SharesActionAccess_ListRequest: + description: Empty body for access_list action + properties: + access_list: + type: 'null' + type: object + x-openstack: + action-name: access_list + SharesActionAccess_ListResponse: + description: Response of the shares/id/action:post:access_list action + type: object + x-openstack: + action-name: access_list + SharesActionAllow_AccessRequest: + description: Empty body for allow_access action + properties: + allow_access: + type: 'null' + type: object + x-openstack: + action-name: allow_access + SharesActionAllow_AccessResponse: + description: Response of the shares/id/action:post:allow_access action + type: object + x-openstack: + action-name: allow_access + SharesActionDeny_AccessRequest: + description: Empty body for deny_access action + properties: + deny_access: + type: 'null' + type: object + x-openstack: + action-name: deny_access + SharesActionDeny_AccessResponse: + description: Response of the shares/id/action:post:deny_access action + type: object + x-openstack: + action-name: deny_access + SharesActionExtendRequest: + description: Empty body for extend action + properties: + extend: + type: 'null' + type: object + x-openstack: + action-name: extend + SharesActionExtendResponse: + description: Response of the shares/id/action:post:extend action + type: object + x-openstack: + action-name: extend + SharesActionForce_DeleteRequest: + description: Empty body for force_delete action + properties: + force_delete: + type: 'null' + type: object + x-openstack: + action-name: force_delete + SharesActionForce_DeleteResponse: + description: Response of the shares/id/action:post:force_delete action + type: object + x-openstack: + action-name: force_delete + SharesActionMigration_CancelRequest: + description: Empty body for migration_cancel action + properties: + migration_cancel: + type: 'null' + type: object + x-openstack: + action-name: migration_cancel + SharesActionMigration_CancelResponse: + description: Response of the shares/id/action:post:migration_cancel action + type: object + x-openstack: + action-name: migration_cancel + SharesActionMigration_CompleteRequest: + description: Empty body for migration_complete action + properties: + migration_complete: + type: 'null' + type: object + x-openstack: + action-name: migration_complete + SharesActionMigration_CompleteResponse: + description: Response of the shares/id/action:post:migration_complete + action + type: object + x-openstack: + action-name: migration_complete + SharesActionMigration_Get_ProgressRequest: + description: Empty body for migration_get_progress action + properties: + migration_get_progress: + type: 'null' + type: object + x-openstack: + action-name: migration_get_progress + SharesActionMigration_Get_ProgressResponse: + description: Response of the shares/id/action:post:migration_get_progress + action + type: object + x-openstack: + action-name: migration_get_progress + SharesActionMigration_StartRequest: + description: Empty body for migration_start action + properties: + migration_start: + type: 'null' + type: object + x-openstack: + action-name: migration_start + SharesActionMigration_StartResponse: + description: Response of the shares/id/action:post:migration_start action + type: object + x-openstack: + action-name: migration_start + SharesActionOs-Access_ListRequest: + description: Empty body for os-access_list action + properties: + os-access_list: + type: 'null' + type: object + x-openstack: + action-name: os-access_list + SharesActionOs-Access_ListResponse: + description: Response of the shares/id/action:post:os-access_list action + type: object + x-openstack: + action-name: os-access_list + SharesActionOs-Allow_AccessRequest: + description: Empty body for os-allow_access action + properties: + os-allow_access: + type: 'null' + type: object + x-openstack: + action-name: os-allow_access + SharesActionOs-Allow_AccessResponse: + description: Response of the shares/id/action:post:os-allow_access action + type: object + x-openstack: + action-name: os-allow_access + SharesActionOs-Deny_AccessRequest: + description: Empty body for os-deny_access action + properties: + os-deny_access: + type: 'null' + type: object + x-openstack: + action-name: os-deny_access + SharesActionOs-Deny_AccessResponse: + description: Response of the shares/id/action:post:os-deny_access action + type: object + x-openstack: + action-name: os-deny_access + SharesActionOs-ExtendRequest: + description: Empty body for os-extend action + properties: + os-extend: + type: 'null' + type: object + x-openstack: + action-name: os-extend + SharesActionOs-ExtendResponse: + description: Response of the shares/id/action:post:os-extend action + type: object + x-openstack: + action-name: os-extend + SharesActionOs-Force_DeleteRequest: + description: Empty body for os-force_delete action + properties: + os-force_delete: + type: 'null' + type: object + x-openstack: + action-name: os-force_delete + SharesActionOs-Force_DeleteResponse: + description: Response of the shares/id/action:post:os-force_delete action + type: object + x-openstack: + action-name: os-force_delete + SharesActionOs-Reset_StatusRequest: + description: Empty body for os-reset_status action + properties: + os-reset_status: + type: 'null' + type: object + x-openstack: + action-name: os-reset_status + SharesActionOs-Reset_StatusResponse: + description: Response of the shares/id/action:post:os-reset_status action + type: object + x-openstack: + action-name: os-reset_status + SharesActionOs-ShrinkRequest: + description: Empty body for os-shrink action + properties: + os-shrink: + type: 'null' + type: object + x-openstack: + action-name: os-shrink + SharesActionOs-ShrinkResponse: + description: Response of the shares/id/action:post:os-shrink action + type: object + x-openstack: + action-name: os-shrink + SharesActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + SharesActionReset_StatusResponse: + description: Response of the shares/id/action:post:reset_status action + type: object + x-openstack: + action-name: reset_status + SharesActionReset_Task_StateRequest: + description: Empty body for reset_task_state action + properties: + reset_task_state: + type: 'null' + type: object + x-openstack: + action-name: reset_task_state + SharesActionReset_Task_StateResponse: + description: Response of the shares/id/action:post:reset_task_state action + type: object + x-openstack: + action-name: reset_task_state + SharesActionRestoreRequest: + description: Empty body for restore action + properties: + restore: + type: 'null' + type: object + x-openstack: + action-name: restore + SharesActionRestoreResponse: + description: Response of the shares/id/action:post:restore action + type: object + x-openstack: + action-name: restore + SharesActionRevertRequest: + description: Empty body for revert action + properties: + revert: + type: 'null' + type: object + x-openstack: + action-name: revert + SharesActionRevertResponse: + description: Response of the shares/id/action:post:revert action + type: object + x-openstack: + action-name: revert + SharesActionShrinkRequest: + description: Empty body for shrink action + properties: + shrink: + type: 'null' + type: object + x-openstack: + action-name: shrink + SharesActionShrinkResponse: + description: Response of the shares/id/action:post:shrink action + type: object + x-openstack: + action-name: shrink + SharesActionSoft_DeleteRequest: + description: Empty body for soft_delete action + properties: + soft_delete: + type: 'null' + type: object + x-openstack: + action-name: soft_delete + SharesActionSoft_DeleteResponse: + description: Response of the shares/id/action:post:soft_delete action + type: object + x-openstack: + action-name: soft_delete + SharesActionUnmanageRequest: + description: Empty body for unmanage action + properties: + unmanage: + type: 'null' + type: object + x-openstack: + action-name: unmanage + SharesActionUnmanageResponse: + description: Response of the shares/id/action:post:unmanage action + type: object + x-openstack: + action-name: unmanage + SharesCreateRequest: + description: Request of the shares:post operation + type: object + x-openstack: + action-name: create + SharesCreateResponse: + description: Response of the shares:post operation + type: object + SharesDetailResponse: + description: Response of the shares/detail:get operation + type: object + SharesExport_LocationShowResponse: + description: Response of the + shares/share_id/export_locations/export_location_uuid:get operation + type: object + SharesExport_LocationsListResponse: + description: Response of the shares/share_id/export_locations:get + operation + type: object + SharesExport_LocationsMetadataCreate_MetadataRequest: + description: Request of the + shares/share_id/export_locations/resource_id/metadata:post operation + type: object + x-openstack: + action-name: create_metadata + SharesExport_LocationsMetadataCreate_MetadataResponse: + description: Response of the + shares/share_id/export_locations/resource_id/metadata:post operation + type: object + SharesExport_LocationsMetadataList_MetadataResponse: + description: Response of the + shares/share_id/export_locations/resource_id/metadata:get operation + type: object + SharesExport_LocationsMetadataShow_MetadataResponse: + description: Response of the + shares/share_id/export_locations/resource_id/metadata/key:get operation + type: object + SharesExport_LocationsMetadataUpdate_All_MetadataRequest: + description: Request of the + shares/share_id/export_locations/resource_id/metadata:put operation + type: object + x-openstack: + action-name: update_all_metadata + SharesExport_LocationsMetadataUpdate_All_MetadataResponse: + description: Response of the + shares/share_id/export_locations/resource_id/metadata:put operation + type: object + SharesExport_LocationsMetadataUpdate_Metadata_ItemRequest: + description: Request of the + shares/share_id/export_locations/resource_id/metadata/key:post operation + type: object + x-openstack: + action-name: update_metadata_item + SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse: + description: Response of the + shares/share_id/export_locations/resource_id/metadata/key:post operation + type: object + SharesInstancesGet_Share_InstancesResponse: + description: Response of the shares/share_id/instances:get operation + type: object + SharesListResponse: + description: Response of the shares:get operation + type: object + SharesManageManageRequest: + description: Request of the shares/manage:post operation + type: object + x-openstack: + action-name: manage + SharesManageResponse: + description: Response of the shares/manage:post operation + type: object + SharesMetadataCreate_MetadataRequest: + description: Request of the shares/resource_id/metadata:post operation + type: object + x-openstack: + action-name: create_metadata + SharesMetadataCreate_MetadataResponse: + description: Response of the shares/resource_id/metadata:post operation + type: object + SharesMetadataList_MetadataResponse: + description: Response of the shares/resource_id/metadata:get operation + type: object + SharesMetadataShow_MetadataResponse: + description: Response of the shares/resource_id/metadata/key:get operation + type: object + SharesMetadataUpdate_All_MetadataRequest: + description: Request of the shares/resource_id/metadata:put operation + type: object + x-openstack: + action-name: update_all_metadata + SharesMetadataUpdate_All_MetadataResponse: + description: Response of the shares/resource_id/metadata:put operation + type: object + SharesMetadataUpdate_Metadata_ItemRequest: + description: Request of the shares/resource_id/metadata/key:post operation + type: object + x-openstack: + action-name: update_metadata_item + SharesMetadataUpdate_Metadata_ItemResponse: + description: Response of the shares/resource_id/metadata/key:post + operation + type: object + SnapshotShowResponse: + description: Response of the snapshots/id:get operation + type: object + SnapshotUpdateRequest: + description: Request of the snapshots/id:put operation + type: object + x-openstack: + action-name: update + SnapshotUpdateResponse: + description: Response of the snapshots/id:put operation + type: object + Snapshot_InstanceShowResponse: + description: Response of the snapshot-instances/id:get operation + type: object + Snapshot_InstancesActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + Snapshot_InstancesActionReset_StatusResponse: + description: Response of the + snapshot-instances/id/action:post:reset_status action + type: object + x-openstack: + action-name: reset_status + Snapshot_InstancesDetailResponse: + description: Response of the snapshot-instances/detail:get operation + type: object + Snapshot_InstancesExport_LocationShowResponse: + description: Response of the + snapshot-instances/snapshot_instance_id/export-locations/export_location_id:get + operation + type: object + Snapshot_InstancesExport_LocationsListResponse: + description: Response of the + snapshot-instances/snapshot_instance_id/export-locations:get operation + type: object + Snapshot_InstancesListResponse: + description: Response of the snapshot-instances:get operation + type: object + SnapshotsAccess_ListResponse: + description: Response of the snapshots/snapshot_id/access-list:get + operation + type: object + SnapshotsActionAllow_AccessRequest: + description: Empty body for allow_access action + properties: + allow_access: + type: 'null' + type: object + x-openstack: + action-name: allow_access + SnapshotsActionAllow_AccessResponse: + description: Response of the snapshots/id/action:post:allow_access action + type: object + x-openstack: + action-name: allow_access + SnapshotsActionDeny_AccessRequest: + description: Empty body for deny_access action + properties: + deny_access: + type: 'null' + type: object + x-openstack: + action-name: deny_access + SnapshotsActionDeny_AccessResponse: + description: Response of the snapshots/id/action:post:deny_access action + type: object + x-openstack: + action-name: deny_access + SnapshotsActionForce_DeleteRequest: + description: Empty body for force_delete action + properties: + force_delete: + type: 'null' + type: object + x-openstack: + action-name: force_delete + SnapshotsActionForce_DeleteResponse: + description: Response of the snapshots/id/action:post:force_delete action + type: object + x-openstack: + action-name: force_delete + SnapshotsActionOs-Force_DeleteRequest: + description: Empty body for os-force_delete action + properties: + os-force_delete: + type: 'null' + type: object + x-openstack: + action-name: os-force_delete + SnapshotsActionOs-Force_DeleteResponse: + description: Response of the snapshots/id/action:post:os-force_delete + action + type: object + x-openstack: + action-name: os-force_delete + SnapshotsActionOs-Reset_StatusRequest: + description: Empty body for os-reset_status action + properties: + os-reset_status: + type: 'null' + type: object + x-openstack: + action-name: os-reset_status + SnapshotsActionOs-Reset_StatusResponse: + description: Response of the snapshots/id/action:post:os-reset_status + action + type: object + x-openstack: + action-name: os-reset_status + SnapshotsActionReset_StatusRequest: + description: Empty body for reset_status action + properties: + reset_status: + type: 'null' + type: object + x-openstack: + action-name: reset_status + SnapshotsActionReset_StatusResponse: + description: Response of the snapshots/id/action:post:reset_status action + type: object + x-openstack: + action-name: reset_status + SnapshotsActionUnmanageRequest: + description: Empty body for unmanage action + properties: + unmanage: + type: 'null' + type: object + x-openstack: + action-name: unmanage + SnapshotsActionUnmanageResponse: + description: Response of the snapshots/id/action:post:unmanage action + type: object + x-openstack: + action-name: unmanage + SnapshotsCreateRequest: + description: Request of the snapshots:post operation + type: object + x-openstack: + action-name: create + SnapshotsCreateResponse: + description: Response of the snapshots:post operation + type: object + SnapshotsDetailResponse: + description: Response of the snapshots/detail:get operation + type: object + SnapshotsExport_LocationShowResponse: + description: Response of the + snapshots/snapshot_id/export-locations/export_location_id:get operation + type: object + SnapshotsExport_LocationsListResponse: + description: Response of the snapshots/snapshot_id/export-locations:get + operation + type: object + SnapshotsListResponse: + description: Response of the snapshots:get operation + type: object + SnapshotsManageManageRequest: + description: Request of the snapshots/manage:post operation + type: object + x-openstack: + action-name: manage + SnapshotsManageResponse: + description: Response of the snapshots/manage:post operation + type: object + SnapshotsMetadataCreate_MetadataRequest: + description: Request of the snapshots/resource_id/metadata:post operation + type: object + x-openstack: + action-name: create_metadata + SnapshotsMetadataCreate_MetadataResponse: + description: Response of the snapshots/resource_id/metadata:post operation + type: object + SnapshotsMetadataList_MetadataResponse: + description: Response of the snapshots/resource_id/metadata:get operation + type: object + SnapshotsMetadataShow_MetadataResponse: + description: Response of the snapshots/resource_id/metadata/key:get + operation + type: object + SnapshotsMetadataUpdate_All_MetadataRequest: + description: Request of the snapshots/resource_id/metadata:put operation + type: object + x-openstack: + action-name: update_all_metadata + SnapshotsMetadataUpdate_All_MetadataResponse: + description: Response of the snapshots/resource_id/metadata:put operation + type: object + SnapshotsMetadataUpdate_Metadata_ItemRequest: + description: Request of the snapshots/resource_id/metadata/key:post + operation + type: object + x-openstack: + action-name: update_metadata_item + SnapshotsMetadataUpdate_Metadata_ItemResponse: + description: Response of the snapshots/resource_id/metadata/key:post + operation + type: object + TypeShowResponse: + description: Response of the types/id:get operation + type: object + TypeUpdateRequest: + description: Request of the types/id:put operation + type: object + x-openstack: + action-name: update + TypeUpdateResponse: + description: Response of the types/id:put:update action + type: object + x-openstack: + action-name: update + TypesActionAddprojectaccessRequest: + description: Empty body for addProjectAccess action + properties: + addProjectAccess: + type: 'null' + type: object + x-openstack: + action-name: addProjectAccess + TypesActionAddprojectaccessResponse: + description: Response of the types/id/action:post:addProjectAccess action + type: object + x-openstack: + action-name: addProjectAccess + TypesActionCreateRequest: + description: Empty body for create action + properties: + create: + type: 'null' + type: object + x-openstack: + action-name: create + TypesActionCreateResponse: + description: Response of the types/id/action:post:create action + type: object + x-openstack: + action-name: create + TypesActionDeleteRequest: + description: Empty body for delete action + properties: + delete: + type: 'null' + type: object + x-openstack: + action-name: delete + TypesActionDeleteResponse: + description: Response of the types/id/action:post:delete action + type: object + x-openstack: + action-name: delete + TypesActionRemoveprojectaccessRequest: + description: Empty body for removeProjectAccess action + properties: + removeProjectAccess: + type: 'null' + type: object + x-openstack: + action-name: removeProjectAccess + TypesActionRemoveprojectaccessResponse: + description: Response of the types/id/action:post:removeProjectAccess + action + type: object + x-openstack: + action-name: removeProjectAccess + TypesActionUpdateRequest: + description: Empty body for update action + properties: + update: + type: 'null' + type: object + x-openstack: + action-name: update + TypesActionUpdateResponse: + description: Response of the types/id/action:post:update action + type: object + x-openstack: + action-name: update + TypesCreateRequest: + description: Request of the types:post operation + type: object + x-openstack: + action-name: create + TypesCreateResponse: + description: Response of the types:post:create action + type: object + x-openstack: + action-name: create + TypesDefaultResponse: + description: Response of the types/default:get operation + type: object + TypesExtra_SpecShowResponse: + description: Response of the types/type_id/extra_specs/id:get operation + type: object + TypesExtra_SpecUpdateRequest: + description: Request of the types/type_id/extra_specs/id:put operation + type: object + x-openstack: + action-name: update + TypesExtra_SpecUpdateResponse: + description: Response of the types/type_id/extra_specs/id:put operation + type: object + TypesExtra_SpecsCreateRequest: + description: Request of the types/type_id/extra_specs:post operation + type: object + x-openstack: + action-name: create + TypesExtra_SpecsCreateResponse: + description: Response of the types/type_id/extra_specs:post operation + type: object + TypesExtra_SpecsListResponse: + description: Response of the types/type_id/extra_specs:get operation + type: object + TypesListResponse: + description: Response of the types:get operation + type: object + TypesOs_Share_Type_AccessOs-Share-Type-AccessResponse: + description: Response of the types/id/os-share-type-access:get operation + type: object + TypesShare_Type_AccessResponse: + description: Response of the types/id/share_type_access:get operation + type: object + securitySchemes: + ApiKeyAuth: + in: header + name: X-Auth-Token + type: apiKey +security: + - ApiKeyAuth: [] +tags: + - name: availability-zones + - name: extensions + - name: limits + - name: messages + - name: os-availability-zone + - name: os-quota-class-sets + - name: os-quota-sets + - name: os-services + - name: os-share-manage + - name: os-share-unmanage + - name: quota-class-sets + - name: quota-sets + - name: resource-locks + - name: scheduler-stats + - name: security-services + - name: services + - name: share-access-rules + - name: share-backups + - name: share-group-snapshots + - name: share-group-types + - name: share-groups + - name: share-networks + - name: share-replicas + - name: share-servers + - name: share-transfers + - name: share_instances + - name: shares + - name: snapshot-instances + - name: snapshots + - name: types + - name: version diff --git a/openstack_types/data/shared-file-system/v2.yaml b/openstack_types/data/shared-file-system/v2.yaml index 94e8416f1..9f6e86ea0 100644 --- a/openstack_types/data/shared-file-system/v2.yaml +++ b/openstack_types/data/shared-file-system/v2.yaml @@ -6,7 +6,7 @@ info: through which it offers on-demand, scalable, self-service access to shared file system storage resources. title: OpenStack Shared-File-System API - version: '2.89' + version: '2.91' paths: /: get: @@ -2313,7 +2313,7 @@ paths: tags: - shares x-openstack: - max-ver: '2.64' + max-ver: '2.89' min-ver: '2.0' /shares/detail: get: diff --git a/openstack_types/src/container_infrastructure_management/v1/version/response/get.rs b/openstack_types/src/container_infrastructure_management/v1/version/response/get.rs index f19102578..b9959f05f 100644 --- a/openstack_types/src/container_infrastructure_management/v1/version/response/get.rs +++ b/openstack_types/src/container_infrastructure_management/v1/version/response/get.rs @@ -38,6 +38,10 @@ pub struct VersionResponse { #[structable(optional)] pub created_at: Option, + #[serde(default)] + #[structable(optional, serialize)] + pub credentials: Option>, + #[serde(default)] #[structable(optional, serialize)] pub federations: Option>, @@ -123,6 +127,22 @@ pub struct Clustertemplates { pub updated_at: Option, } +/// A link representation. +/// `Credentials` type +#[derive(Clone, Debug, Deserialize, Serialize)] +pub struct Credentials { + #[serde(default)] + pub created_at: Option, + #[serde(default)] + pub href: Option, + #[serde(default)] + pub rel: Option, + #[serde(default, rename = "type")] + pub _type: Option, + #[serde(default)] + pub updated_at: Option, +} + /// A link representation. /// `Federations` type #[derive(Clone, Debug, Deserialize, Serialize)]