Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Block Storage API

7 actions 7 updates phrasing extends openapi/amazon-lightsail-blockstorage-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon Lightsail's API. It is a proposal applied on top of the contract, not a document Amazon Lightsail publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/ls/api/2016-11-28/AttachDisk'].post
$.paths['/ls/api/2016-11-28/CreateDisk'].post
$.paths['/ls/api/2016-11-28/DeleteDisk'].post
$.paths['/ls/api/2016-11-28/DetachDisk'].post
$.paths['/ls/api/2016-11-28/GetDisk'].post
$.paths['/ls/api/2016-11-28/GetDisks'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon Lightsail Block Storage API
  version: 1.0.0
extends: openapi/amazon-lightsail-blockstorage-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/ls/api/2016-11-28/AttachDisk'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a block storage disk to an instance
      effect: write
      questions:
      - How do I add extra storage to my Lightsail instance?
      - Can a disk be mounted automatically when I attach it?
      instructions:
      - text: Attach disk {diskName} to {instanceName} at {diskPath}.
        slots:
          diskName: requestBody.diskName
          instanceName: requestBody.instanceName
          diskPath: requestBody.diskPath
      - text: Attach {diskName} to {instanceName} at {diskPath} with auto-mounting {autoMounting}.
        slots:
          diskName: requestBody.diskName
          instanceName: requestBody.instanceName
          diskPath: requestBody.diskPath
          autoMounting: requestBody.autoMounting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/CreateDisk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new empty block storage disk
      effect: write
      questions:
      - How do I create a new blank SSD disk for an instance?
      - Does a new disk have to be in the same Availability Zone as the instance?
      instructions:
      - text: Create a {sizeInGb} GB disk named {diskName} in {availabilityZone}.
        slots:
          sizeInGb: requestBody.sizeInGb
          diskName: requestBody.diskName
          availabilityZone: requestBody.availabilityZone
      - text: Create empty disk {diskName} of {sizeInGb} GB in {availabilityZone} tagged {tags}.
        slots:
          diskName: requestBody.diskName
          sizeInGb: requestBody.sizeInGb
          availabilityZone: requestBody.availabilityZone
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/DeleteDisk'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a block storage disk
      effect: destructive
      questions:
      - How do I permanently delete a disk I no longer use?
      - Can I delete a disk that still has automatic snapshots enabled?
      instructions:
      - text: Delete disk {diskName}.
        slots:
          diskName: requestBody.diskName
      - text: Delete disk {diskName} and force-delete its add-ons ({forceDeleteAddOns}).
        slots:
          diskName: requestBody.diskName
          forceDeleteAddOns: requestBody.forceDeleteAddOns
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/DetachDisk'].post
  update:
    x-apievangelist-phrasing:
      intent: Detach a disk from its instance
      effect: write
      questions:
      - How do I unplug a disk from an instance without deleting it?
      - Does the instance need to be stopped before I detach a disk?
      instructions:
      - text: Detach disk {diskName} from its instance.
        slots:
          diskName: requestBody.diskName
      - text: Unattach {diskName} so I can move it to another server.
        slots:
          diskName: requestBody.diskName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/GetDisk'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one block storage disk
      effect: read
      questions:
      - What size and state is a particular disk in?
      - Which instance is a given disk attached to?
      instructions:
      - text: Get details for disk {diskName}.
        slots:
          diskName: requestBody.diskName
      - text: Show the attachment and size of {diskName}.
        slots:
          diskName: requestBody.diskName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ls/api/2016-11-28/GetDisks'].post
  update:
    x-apievangelist-phrasing:
      intent: List all block storage disks
      effect: read
      questions:
      - Which block storage disks do I have in this region?
      - Is there a way to page through all my disks?
      instructions:
      - text: List all my block storage disks.
      - text: Get the next page of disks using {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-10-01'