attachable volume rename to external volume

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

components/schemas/infrastructure/attachable-volumes/AttachableVolume.yml → 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"

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

components/schemas/infrastructure/attachable-volumes/AttachableVolumeAttachment.yml → 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.

components/schemas/infrastructure/attachable-volumes/AttachableVolumeEvents.yml → 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:

components/schemas/infrastructure/attachable-volumes/AttachableVolumeMeta.yml → 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:

components/schemas/infrastructure/attachable-volumes/AttachableVolumeOptions.yml → 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:

components/schemas/infrastructure/attachable-volumes/AttachableVolumeState.yml → components/schemas/infrastructure/external-volumes/ExternalVolumeState.yml

@@ -1,4 +1,4 @@
-title: AttachableVolumeState
+title: ExternalVolumeState
 allOf:
   - required:
       - current

components/schemas/infrastructure/attachable-volumes/sources/AttachableVolumeSource.yml → components/schemas/infrastructure/external-volumes/sources/ExternalVolumeSource.yml

@@ -1,4 +1,4 @@
-title: AttachableVolumeSource
+title: ExternalVolumeSource
 description: |
   The source information for this volume.
 oneOf:

components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeAttachAction.yml → 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

components/schemas/infrastructure/attachable-volumes/tasks/AttachableVolumeDetachAction.yml → 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

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

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":

platform/paths/infrastructure/attachable-volumes/access.yml → 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

platform/paths/infrastructure/attachable-volumes/attachable-volume.yml → 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,38 +38,38 @@ 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:
           type: object
           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: