Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Operations API

4 actions 4 updates phrasing extends openapi/amazon-lightsail-operations-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 4

$.info
$.paths['/ls/api/2016-11-28/GetOperation'].post
$.paths['/ls/api/2016-11-28/GetOperations'].post
$.paths['/ls/api/2016-11-28/GetOperationsForResource'].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 Operations API
  version: 1.0.0
extends: openapi/amazon-lightsail-operations-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['/ls/api/2016-11-28/GetOperation'].post
  update:
    x-apievangelist-phrasing:
      intent: Check the status of one operation
      effect: read
      questions:
      - Did the request I just made finish successfully?
      - How can I look up a single operation by its ID?
      instructions:
      - text: Get the status of operation {operationId}.
        slots:
          operationId: requestBody.operationId
      - text: Check whether operation {operationId} succeeded or failed.
        slots:
          operationId: requestBody.operationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetOperations'].post
  update:
    x-apievangelist-phrasing:
      intent: List all recent operations in the account
      effect: read
      questions:
      - What changes have been made in my Lightsail account recently?
      - Can I page through every operation across all resources?
      instructions:
      - text: List all operations in my account.
      - text: Get the next page of account operations using {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetOperationsForResource'].post
  update:
    x-apievangelist-phrasing:
      intent: List operations for one resource
      effect: read
      questions:
      - What has happened to a specific instance or static IP?
      - Can I see the operation history of just one resource?
      instructions:
      - text: List operations for {resourceName}.
        slots:
          resourceName: requestBody.resourceName
      - text: Show the activity history of {resourceName} from {pageToken}.
        slots:
          resourceName: requestBody.resourceName
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'