diff --git a/components/schemas/common/Capability.yml b/components/schemas/common/Capability.yml index 3a230fd3..a2ba9ceb 100644 --- a/components/schemas/common/Capability.yml +++ b/components/schemas/common/Capability.yml @@ -1,9 +1,9 @@ type: string description: A capability that a user or API key that represents what an API key or a user can do. enum: - # Attachable Volumes - - attachable-volumes-view - - attachable-volumes-manage + # External Volumes + - external-volumes-view + - external-volumes-manage # API Keys - api-keys-manage diff --git a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeAbout.yml b/components/schemas/infrastructure/attachable-volumes/AttachableVolumeAbout.yml deleted file mode 100644 index dde8548d..00000000 --- a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeAbout.yml +++ /dev/null @@ -1,9 +0,0 @@ -title: AttachableVolumeAbout -type: object -description: Additional details about the attachable volume. -required: - - description -properties: - description: - description: Custom details about this attachable volume. - type: string diff --git a/components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeTasks.yml b/components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeTasks.yml deleted file mode 100644 index 870e5dde..00000000 --- a/components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeTasks.yml +++ /dev/null @@ -1,9 +0,0 @@ -title: AttachableVolumeTask -discriminator: - propertyName: action - mapping: - attach: AttachableVolumeAttachAction.yml - detach: AttachableVolumeDetachAction.yml -oneOf: - - $ref: AttachableVolumeAttachAction.yml - - $ref: AttachableVolumeDetachAction.yml diff --git a/components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml b/components/schemas/infrastructure/external-volumes/ExternalVolume.yml similarity index 58% rename from components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml rename to components/schemas/infrastructure/external-volumes/ExternalVolume.yml index 9be48ce6..b86b91d6 100644 --- a/components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml +++ b/components/schemas/infrastructure/external-volumes/ExternalVolume.yml @@ -1,4 +1,4 @@ -title: AttachableVolume +title: ExternalVolume type: object description: > A persistent storage volume within a cluster. Volumes may be @@ -22,9 +22,9 @@ properties: $ref: "../../HubID.yml" name: type: string - description: The name of the attachable volume. + description: The name of the external volume. about: - $ref: "./AttachableVolumeAbout.yml" + $ref: "./ExternalVolumeAbout.yml" cluster: $ref: "../../Identifier.yml" identifier: @@ -34,24 +34,24 @@ properties: location_id: $ref: "../../ID.yml" source: - $ref: "./sources/AttachableVolumeSource.yml" + $ref: "./sources/ExternalVolumeSource.yml" attachment: - description: Information about the resource the attachable volume is currently attached to. + description: Information about the resource the external volume is currently attached to. anyOf: - - $ref: "./AttachableVolumeAttachment.yml" + - $ref: "./ExternalVolumeAttachment.yml" - type: "null" size: description: > - Size of the attachable volume; may be null or omitted if the size has not yet + Size of the external volume; may be null or omitted if the size has not yet been determined. anyOf: - $ref: "../../DataSize.yml" - type: "null" options: - $ref: "./AttachableVolumeOptions.yml" + $ref: "./ExternalVolumeOptions.yml" state: - $ref: "./AttachableVolumeState.yml" + $ref: "./ExternalVolumeState.yml" events: - $ref: "./AttachableVolumeEvents.yml" + $ref: "./ExternalVolumeEvents.yml" meta: - $ref: "./AttachableVolumeMeta.yml" + $ref: "./ExternalVolumeMeta.yml" diff --git a/components/schemas/infrastructure/external-volumes/ExternalVolumeAbout.yml b/components/schemas/infrastructure/external-volumes/ExternalVolumeAbout.yml new file mode 100644 index 00000000..37ebc746 --- /dev/null +++ b/components/schemas/infrastructure/external-volumes/ExternalVolumeAbout.yml @@ -0,0 +1,9 @@ +title: ExternalVolumeAbout +type: object +description: Additional details about the external volume. +required: + - description +properties: + description: + description: Custom details about this external volume. + type: string diff --git a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeAttachment.yml b/components/schemas/infrastructure/external-volumes/ExternalVolumeAttachment.yml similarity index 93% rename from components/schemas/infrastructure/attachable-volumes/AttachableVolumeAttachment.yml rename to components/schemas/infrastructure/external-volumes/ExternalVolumeAttachment.yml index f6139550..5a1a7cb0 100644 --- a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeAttachment.yml +++ b/components/schemas/infrastructure/external-volumes/ExternalVolumeAttachment.yml @@ -1,4 +1,4 @@ -title: AttachableVolumeAttachment +title: ExternalVolumeAttachment type: object description: > Represents where the volume is currently attached. diff --git a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeEvents.yml b/components/schemas/infrastructure/external-volumes/ExternalVolumeEvents.yml similarity index 95% rename from components/schemas/infrastructure/attachable-volumes/AttachableVolumeEvents.yml rename to components/schemas/infrastructure/external-volumes/ExternalVolumeEvents.yml index b3dd69f1..4195b42c 100644 --- a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeEvents.yml +++ b/components/schemas/infrastructure/external-volumes/ExternalVolumeEvents.yml @@ -1,4 +1,4 @@ -title: AttachableVolumeEvents +title: ExternalVolumeEvents type: object description: Timestamps for events that happen over the lifetime of the attached volume. required: diff --git a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeMeta.yml b/components/schemas/infrastructure/external-volumes/ExternalVolumeMeta.yml similarity index 84% rename from components/schemas/infrastructure/attachable-volumes/AttachableVolumeMeta.yml rename to components/schemas/infrastructure/external-volumes/ExternalVolumeMeta.yml index 48f85c38..237f7954 100644 --- a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeMeta.yml +++ b/components/schemas/infrastructure/external-volumes/ExternalVolumeMeta.yml @@ -1,4 +1,4 @@ -title: AttachableVolumeMeta +title: ExternalVolumeMeta type: object description: A list of meta fields that can be applied to an attached volume. properties: diff --git a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeOptions.yml b/components/schemas/infrastructure/external-volumes/ExternalVolumeOptions.yml similarity index 90% rename from components/schemas/infrastructure/attachable-volumes/AttachableVolumeOptions.yml rename to components/schemas/infrastructure/external-volumes/ExternalVolumeOptions.yml index 40605e43..28266f2d 100644 --- a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeOptions.yml +++ b/components/schemas/infrastructure/external-volumes/ExternalVolumeOptions.yml @@ -1,4 +1,4 @@ -title: AttachableVolumeOptions +title: ExternalVolumeOptions type: object description: Configuration options controlling the behavior of the volume. required: diff --git a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeState.yml b/components/schemas/infrastructure/external-volumes/ExternalVolumeState.yml similarity index 91% rename from components/schemas/infrastructure/attachable-volumes/AttachableVolumeState.yml rename to components/schemas/infrastructure/external-volumes/ExternalVolumeState.yml index d6541416..5c18607d 100644 --- a/components/schemas/infrastructure/attachable-volumes/AttachableVolumeState.yml +++ b/components/schemas/infrastructure/external-volumes/ExternalVolumeState.yml @@ -1,4 +1,4 @@ -title: AttachableVolumeState +title: ExternalVolumeState allOf: - required: - current diff --git a/components/schemas/infrastructure/attachable-volumes/sources/AttachableVolumeSource.yml b/components/schemas/infrastructure/external-volumes/sources/ExternalVolumeSource.yml similarity index 92% rename from components/schemas/infrastructure/attachable-volumes/sources/AttachableVolumeSource.yml rename to components/schemas/infrastructure/external-volumes/sources/ExternalVolumeSource.yml index 85d014fb..caa1f714 100644 --- a/components/schemas/infrastructure/attachable-volumes/sources/AttachableVolumeSource.yml +++ b/components/schemas/infrastructure/external-volumes/sources/ExternalVolumeSource.yml @@ -1,4 +1,4 @@ -title: AttachableVolumeSource +title: ExternalVolumeSource description: | The source information for this volume. oneOf: diff --git a/components/schemas/infrastructure/attachable-volumes/sources/aws-ebs/SourceAwsEbs.yml b/components/schemas/infrastructure/external-volumes/sources/aws-ebs/SourceAwsEbs.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/aws-ebs/SourceAwsEbs.yml rename to components/schemas/infrastructure/external-volumes/sources/aws-ebs/SourceAwsEbs.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/aws-ebs/SourceAwsEbsAuth.yml b/components/schemas/infrastructure/external-volumes/sources/aws-ebs/SourceAwsEbsAuth.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/aws-ebs/SourceAwsEbsAuth.yml rename to components/schemas/infrastructure/external-volumes/sources/aws-ebs/SourceAwsEbsAuth.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/aws-ebs/SourceAwsEbsRef.yml b/components/schemas/infrastructure/external-volumes/sources/aws-ebs/SourceAwsEbsRef.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/aws-ebs/SourceAwsEbsRef.yml rename to components/schemas/infrastructure/external-volumes/sources/aws-ebs/SourceAwsEbsRef.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/ceph-rbd/SourceCephRbd.yml b/components/schemas/infrastructure/external-volumes/sources/ceph-rbd/SourceCephRbd.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/ceph-rbd/SourceCephRbd.yml rename to components/schemas/infrastructure/external-volumes/sources/ceph-rbd/SourceCephRbd.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/ceph-rbd/SourceCephRbdClientIdentity.yml b/components/schemas/infrastructure/external-volumes/sources/ceph-rbd/SourceCephRbdClientIdentity.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/ceph-rbd/SourceCephRbdClientIdentity.yml rename to components/schemas/infrastructure/external-volumes/sources/ceph-rbd/SourceCephRbdClientIdentity.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/ceph-rbd/SourceCephRbdImageRef.yml b/components/schemas/infrastructure/external-volumes/sources/ceph-rbd/SourceCephRbdImageRef.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/ceph-rbd/SourceCephRbdImageRef.yml rename to components/schemas/infrastructure/external-volumes/sources/ceph-rbd/SourceCephRbdImageRef.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/ceph-rbd/SourceCephRbdMonitor.yml b/components/schemas/infrastructure/external-volumes/sources/ceph-rbd/SourceCephRbdMonitor.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/ceph-rbd/SourceCephRbdMonitor.yml rename to components/schemas/infrastructure/external-volumes/sources/ceph-rbd/SourceCephRbdMonitor.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/san-iscsi/SourceSanChapCredentials.yml b/components/schemas/infrastructure/external-volumes/sources/san-iscsi/SourceSanChapCredentials.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/san-iscsi/SourceSanChapCredentials.yml rename to components/schemas/infrastructure/external-volumes/sources/san-iscsi/SourceSanChapCredentials.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/san-iscsi/SourceSanIscsi.yml b/components/schemas/infrastructure/external-volumes/sources/san-iscsi/SourceSanIscsi.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/san-iscsi/SourceSanIscsi.yml rename to components/schemas/infrastructure/external-volumes/sources/san-iscsi/SourceSanIscsi.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/san-iscsi/SourceSanIscsiTarget.yml b/components/schemas/infrastructure/external-volumes/sources/san-iscsi/SourceSanIscsiTarget.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/san-iscsi/SourceSanIscsiTarget.yml rename to components/schemas/infrastructure/external-volumes/sources/san-iscsi/SourceSanIscsiTarget.yml diff --git a/components/schemas/infrastructure/attachable-volumes/sources/san-iscsi/SourceSanPortal.yml b/components/schemas/infrastructure/external-volumes/sources/san-iscsi/SourceSanPortal.yml similarity index 100% rename from components/schemas/infrastructure/attachable-volumes/sources/san-iscsi/SourceSanPortal.yml rename to components/schemas/infrastructure/external-volumes/sources/san-iscsi/SourceSanPortal.yml diff --git a/components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeAttachAction.yml b/components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeAttachAction.yml similarity index 77% rename from components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeAttachAction.yml rename to components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeAttachAction.yml index 570da2f1..77836e2f 100644 --- a/components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeAttachAction.yml +++ b/components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeAttachAction.yml @@ -1,5 +1,5 @@ -title: AttachableVolumeAttachAction -description: A task to attach an attachable volume. +title: ExternalVolumeAttachAction +description: A task to attach an external volume. type: object required: - action diff --git a/components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeDetachAction.yml b/components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeDetachAction.yml similarity index 60% rename from components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeDetachAction.yml rename to components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeDetachAction.yml index f0ec490f..1c202b0c 100644 --- a/components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeDetachAction.yml +++ b/components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeDetachAction.yml @@ -1,5 +1,5 @@ -title: AttachableVolumeDetachAction -description: A task to detach an attachable volume from an instance. +title: ExternalVolumeDetachAction +description: A task to detach an external volume from an instance. type: object required: - action diff --git a/components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeTasks.yml b/components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeTasks.yml new file mode 100644 index 00000000..bbec48e3 --- /dev/null +++ b/components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeTasks.yml @@ -0,0 +1,9 @@ +title: ExternalVolumeTask +discriminator: + propertyName: action + mapping: + attach: ExternalVolumeAttachAction.yml + detach: ExternalVolumeDetachAction.yml +oneOf: + - $ref: ExternalVolumeAttachAction.yml + - $ref: ExternalVolumeDetachAction.yml diff --git a/platform/api.yml b/platform/api.yml index 22d800e0..6114ea4c 100644 --- a/platform/api.yml +++ b/platform/api.yml @@ -118,7 +118,7 @@ x-tagGroups: - name: Infrastructure tags: - Infrastructure - - Attachable Volumes + - External Volumes - Auto-Scale Groups - Clusters - Providers @@ -583,15 +583,15 @@ paths: "/v1/infrastructure/monitoring-tiers": $ref: "./paths/infrastructure/tiers.yml" - ## Attachable Volumes - "/v1/infrastructure/attachable-volumes": - $ref: "./paths/infrastructure/attachable-volumes/attachable-volumes.yml" - "/v1/infrastructure/attachable-volumes/{attachableVolumeId}": - $ref: "./paths/infrastructure/attachable-volumes/attachable-volume.yml" - "/v1/infrastructure/attachable-volumes/{attachableVolumeId}/access": - $ref: "./paths/infrastructure/attachable-volumes/access.yml" - "/v1/infrastructure/attachable-volumes/{attachableVolumeId}/tasks": - $ref: "./paths/infrastructure/attachable-volumes/tasks.yml" + ## External Volumes + "/v1/infrastructure/external-volumes": + $ref: "./paths/infrastructure/external-volumes/external-volumes.yml" + "/v1/infrastructure/external-volumes/{externalVolumeId}": + $ref: "./paths/infrastructure/external-volumes/external-volume.yml" + "/v1/infrastructure/external-volumes/{externalVolumeId}/access": + $ref: "./paths/infrastructure/external-volumes/access.yml" + "/v1/infrastructure/external-volumes/{externalVolumeId}/tasks": + $ref: "./paths/infrastructure/external-volumes/tasks.yml" ## Auto-Scale Groups "/v1/infrastructure/auto-scale/groups": diff --git a/platform/paths/infrastructure/attachable-volumes/access.yml b/platform/paths/infrastructure/external-volumes/access.yml similarity index 59% rename from platform/paths/infrastructure/attachable-volumes/access.yml rename to platform/paths/infrastructure/external-volumes/access.yml index 412b2fa4..0f254069 100644 --- a/platform/paths/infrastructure/attachable-volumes/access.yml +++ b/platform/paths/infrastructure/external-volumes/access.yml @@ -1,21 +1,21 @@ patch: - operationId: "updateAttachableVolumeAccess" - summary: Update Attachable Volume Access + operationId: "updateExternalVolumeAccess" + summary: Update External Volume Access description: | - Updates the ACL of the specified attachable volume. + Updates the ACL of the specified external volume. - Requires the `attachable-volumes-manage` capability. + Requires the `external-volumes-manage` capability. tags: - - Attachable Volumes + - External Volumes parameters: - - name: attachableVolumeId - description: The ID of the attachable volume. + - name: externalVolumeId + description: The ID of the external volume. in: path required: true schema: type: string requestBody: - description: Parameters for updating the attachable volume ACL. + description: Parameters for updating the external volume ACL. content: application/json: schema: @@ -27,7 +27,7 @@ patch: - type: "null" responses: 200: - description: Returns the updated attachable volume. + description: Returns the updated external volume. content: application/json: schema: @@ -36,6 +36,6 @@ patch: - data properties: data: - $ref: ../../../../components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml + $ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml default: $ref: ../../../../components/responses/errors/DefaultError.yml diff --git a/platform/paths/infrastructure/attachable-volumes/attachable-volume.yml b/platform/paths/infrastructure/external-volumes/external-volume.yml similarity index 67% rename from platform/paths/infrastructure/attachable-volumes/attachable-volume.yml rename to platform/paths/infrastructure/external-volumes/external-volume.yml index 12ed10ce..ff193d64 100644 --- a/platform/paths/infrastructure/attachable-volumes/attachable-volume.yml +++ b/platform/paths/infrastructure/external-volumes/external-volume.yml @@ -1,15 +1,15 @@ get: - operationId: "getAttachableVolume" - summary: Get Attachable Volume + operationId: "getExternalVolume" + summary: Get External Volume description: | - Retrieves a single attachable volume by ID. + Retrieves a single external volume by ID. - Requires the `attachable-volumes-view` capability. + Requires the `external-volumes-view` capability. tags: - - Attachable Volumes + - External Volumes parameters: - - name: attachableVolumeId - description: The ID of the attachable volume. + - name: externalVolumeId + description: The ID of the external volume. in: path required: true schema: @@ -38,28 +38,28 @@ get: - data properties: data: - $ref: ../../../../components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml + $ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml default: $ref: ../../../../components/responses/errors/DefaultError.yml patch: - operationId: "updateAttachableVolume" - summary: Update Attachable Volume + operationId: "updateExternalVolume" + summary: Update External Volume description: | - Updates the specified attachable volume. + Updates the specified external volume. - Requires the `attachable-volumes-manage` capability. + Requires the `external-volumes-manage` capability. tags: - - Attachable Volumes + - External Volumes parameters: - - name: attachableVolumeId - description: The ID of the attachable volume. + - name: externalVolumeId + description: The ID of the external volume. in: path required: true schema: type: string requestBody: - description: Parameters for updating the attachable volume. + description: Parameters for updating the external volume. content: application/json: schema: @@ -67,9 +67,9 @@ patch: properties: name: type: string - description: The new name of the attachable volume. + description: The new name of the external volume. identifier: - description: The new identifier of the attachable volume. + description: The new identifier of the external volume. $ref: "../../../../components/schemas/Identifier.yml" about: type: object @@ -79,7 +79,7 @@ patch: description: Updated description for the attached volume. responses: 200: - description: Returns the updated attachable volume. + description: Returns the updated external volume. content: application/json: schema: @@ -88,19 +88,19 @@ patch: - data properties: data: - $ref: ../../../../components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml + $ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml default: $ref: ../../../../components/responses/errors/DefaultError.yml delete: - operationId: "deleteAttachableVolume" - summary: Delete Attachable Volume - description: Requires the `attachable-volumes-manage` capability. + operationId: "deleteExternalVolume" + summary: Delete External Volume + description: Requires the `external-volumes-manage` capability. tags: - - Attachable Volumes + - External Volumes parameters: - - name: attachableVolumeId - description: The ID of the attachable volume to delete. + - name: externalVolumeId + description: The ID of the external volume to delete. in: path required: true schema: diff --git a/platform/paths/infrastructure/attachable-volumes/attachable-volumes.yml b/platform/paths/infrastructure/external-volumes/external-volumes.yml similarity index 82% rename from platform/paths/infrastructure/attachable-volumes/attachable-volumes.yml rename to platform/paths/infrastructure/external-volumes/external-volumes.yml index cb77d1c9..4bd40dfe 100644 --- a/platform/paths/infrastructure/attachable-volumes/attachable-volumes.yml +++ b/platform/paths/infrastructure/external-volumes/external-volumes.yml @@ -1,9 +1,9 @@ get: - operationId: "getAttachableVolumes" - summary: List Attachable Volumes - description: Requires the `attachable-volumes-view` capability. + operationId: "getExternalVolumes" + summary: List External Volumes + description: Requires the `external-volumes-view` capability. tags: - - Attachable Volumes + - External Volumes parameters: - name: meta in: query @@ -51,7 +51,7 @@ get: - $ref: ../../../../components/parameters/PageParam.yml responses: 200: - description: Returns a list of attachable volumes. + description: Returns a list of external volumes. content: application/json: schema: @@ -62,7 +62,7 @@ get: data: type: array items: - $ref: ../../../../components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml + $ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml includes: type: object properties: @@ -72,11 +72,11 @@ get: $ref: ../../../../components/responses/errors/DefaultError.yml post: - operationId: "createAttachableVolume" - summary: Create Attachable Volume - description: Requires the `attachable-volumes-manage` capability. + operationId: "createExternalVolume" + summary: Create External Volume + description: Requires the `external-volumes-manage` capability. tags: - - Attachable Volumes + - External Volumes parameters: [] requestBody: content: @@ -92,7 +92,7 @@ post: properties: name: type: string - description: A custom name for the attachable volume. + description: A custom name for the external volume. identifier: oneOf: - $ref: ../../../../components/schemas/Identifier.yml @@ -103,27 +103,27 @@ post: - type: "null" cluster: type: string - description: The cluster this attachable volume is associated with. + description: The cluster this external volume is associated with. location_id: $ref: ../../../../components/schemas/ID.yml source: - $ref: ../../../../components/schemas/infrastructure/attachable-volumes/sources/AttachableVolumeSource.yml + $ref: ../../../../components/schemas/infrastructure/external-volumes/sources/ExternalVolumeSource.yml options: - $ref: ../../../../components/schemas/infrastructure/attachable-volumes/AttachableVolumeOptions.yml + $ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolumeOptions.yml about: oneOf: - type: object - description: Additional details about the attachable volume. + description: Additional details about the external volume. required: - description properties: description: type: string - description: A custom description for this attachable volume. + description: A custom description for this external volume. - type: "null" responses: 201: - description: Returns an attachable volume. + description: Returns an external volume. content: application/json: schema: @@ -132,6 +132,6 @@ post: - data properties: data: - $ref: ../../../../components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml + $ref: ../../../../components/schemas/infrastructure/external-volumes/ExternalVolume.yml default: $ref: ../../../../components/responses/errors/DefaultError.yml diff --git a/platform/paths/infrastructure/attachable-volumes/tasks.yml b/platform/paths/infrastructure/external-volumes/tasks.yml similarity index 67% rename from platform/paths/infrastructure/attachable-volumes/tasks.yml rename to platform/paths/infrastructure/external-volumes/tasks.yml index b552de4d..6f1fa0c4 100644 --- a/platform/paths/infrastructure/attachable-volumes/tasks.yml +++ b/platform/paths/infrastructure/external-volumes/tasks.yml @@ -1,14 +1,14 @@ post: - operationId: "createAttachableVolumeJob" - summary: Create Attachable Volume Job + operationId: "createExternalVolumeJob" + summary: Create External Volume Job description: | - Create a job for an attachable volume. + Create a job for an external volume. - Requires the `attachable-volumes-manage` capability. + Requires the `external-volumes-manage` capability. tags: - - Attachable Volumes + - External Volumes parameters: - - name: attachableVolumeId + - name: externalVolumeId description: The ID of the attached volume. in: path required: true @@ -19,7 +19,7 @@ post: content: application/json: schema: - $ref: ../../../../components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeTasks.yml + $ref: ../../../../components/schemas/infrastructure/external-volumes/tasks/ExternalVolumeTasks.yml responses: 202: description: Returns a job descriptor.