Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Cloud Compute Volume Attachments API

4 actions 4 updates phrasing extends openapi/oracle-cloud-volume-attachments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Oracle Cloud Infrastructure's API. It is a proposal applied on top of the contract, not a document Oracle Cloud Infrastructure publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/volumeAttachments'].get

$.paths['/volumeAttachments'].post

$.paths['/volumeAttachments/{volumeAttachmentId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Oracle Cloud Compute Volume Attachments API
  version: 1.0.0
extends: openapi/oracle-cloud-volume-attachments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/volumeAttachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List block volume attachments in a compartment
      effect: read
      questions:
      - Which block volumes are attached to instances in my compartment?
      - Can I see just the volumes attached to one particular instance?
      instructions:
      - text: List the volume attachments in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Show volumes attached to instance {instanceId} in compartment {compartmentId}.
        slots:
          instanceId: query.instanceId
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/volumeAttachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a block volume to an instance
      effect: write
      questions:
      - How do I attach a block storage volume to a compute instance in Oracle Cloud?
      - Can a volume be attached as read-only?
      instructions:
      - text: Attach volume {volumeId} to instance {instanceId} using attachment type {type}.
        slots:
          volumeId: requestBody.volumeId
          instanceId: requestBody.instanceId
          type: requestBody.type
      - text: Attach {volumeId} to {instanceId} as a {type} attachment, read-only set to {isReadOnly}.
        slots:
          volumeId: requestBody.volumeId
          instanceId: requestBody.instanceId
          type: requestBody.type
          isReadOnly: requestBody.isReadOnly
      method: generated
      generated: '2026-09-26'
- target: $.paths['/volumeAttachments/{volumeAttachmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a block volume from an instance
      effect: destructive
      questions:
      - How do I disconnect a block volume from its instance?
      - What do I need to detach a storage volume?
      instructions:
      - text: Detach volume attachment {volumeAttachmentId}.
        slots:
          volumeAttachmentId: path.volumeAttachmentId
      - text: Disconnect the block volume behind attachment {volumeAttachmentId} from its instance.
        slots:
          volumeAttachmentId: path.volumeAttachmentId
      method: generated
      generated: '2026-09-26'