Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Domains API

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

$.info
$.paths['/ls/api/2016-11-28/CreateDomain'].post
$.paths['/ls/api/2016-11-28/CreateDomainEntry'].post
$.paths['/ls/api/2016-11-28/DeleteDomain'].post
$.paths['/ls/api/2016-11-28/DeleteDomainEntry'].post
$.paths['/ls/api/2016-11-28/GetDomain'].post
$.paths['/ls/api/2016-11-28/GetDomains'].post
$.paths['/ls/api/2016-11-28/UpdateDomainEntry'].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 Domains API
  version: 1.0.0
extends: openapi/amazon-lightsail-domains-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: 7
- target: $.paths['/ls/api/2016-11-28/CreateDomain'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS zone for a domain
      effect: write
      questions:
      - How do I manage my domain's DNS in Lightsail?
      - Can I create a DNS zone for example.com in Lightsail?
      instructions:
      - text: Create a DNS zone for {domainName}.
        slots:
          domainName: requestBody.domainName
      - text: Add domain {domainName} to Lightsail DNS with tags {tags}.
        slots:
          domainName: requestBody.domainName
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/CreateDomainEntry'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a DNS record to a domain
      effect: write
      questions:
      - How do I add an A record pointing my domain at an instance?
      - Can I create MX or TXT records in a Lightsail DNS zone?
      instructions:
      - text: Add DNS record {domainEntry} to {domainName}.
        slots:
          domainEntry: requestBody.domainEntry
          domainName: requestBody.domainName
      - text: Create a new record {domainEntry} in the {domainName} zone.
        slots:
          domainEntry: requestBody.domainEntry
          domainName: requestBody.domainName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteDomain'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a domain's DNS zone
      effect: destructive
      questions:
      - How do I delete a domain and all of its DNS records?
      - What happens to the records when I remove a DNS zone?
      instructions:
      - text: Delete the DNS zone {domainName}.
        slots:
          domainName: requestBody.domainName
      - text: Remove domain {domainName} and all its records from Lightsail.
        slots:
          domainName: requestBody.domainName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteDomainEntry'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete one DNS record
      effect: destructive
      questions:
      - How do I remove a single DNS record from my domain?
      - Can I delete an old CNAME without touching the rest of the zone?
      instructions:
      - text: Delete record {domainEntry} from {domainName}.
        slots:
          domainEntry: requestBody.domainEntry
          domainName: requestBody.domainName
      - text: Remove DNS entry {domainEntry} in zone {domainName}.
        slots:
          domainEntry: requestBody.domainEntry
          domainName: requestBody.domainName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetDomain'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a domain and its DNS records
      effect: read
      questions:
      - What DNS records are set on one of my domains?
      - Can I see the full record set of a specific domain?
      instructions:
      - text: Get domain {domainName} and its records.
        slots:
          domainName: requestBody.domainName
      - text: Show the DNS entries in {domainName}.
        slots:
          domainName: requestBody.domainName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetDomains'].post
  update:
    x-apievangelist-phrasing:
      intent: List all DNS zones in the account
      effect: read
      questions:
      - Which domains are managed in my Lightsail account?
      - Is there a way to page through all my DNS zones?
      instructions:
      - text: List all my domains.
      - text: Get the next page of domains using {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/UpdateDomainEntry'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an existing DNS record
      effect: write
      questions:
      - How do I point an existing A record at a new IP address?
      - Can I edit a DNS record's target after creating it?
      instructions:
      - text: Update record {domainEntry} in {domainName}.
        slots:
          domainEntry: requestBody.domainEntry
          domainName: requestBody.domainName
      - text: Change the existing entry in {domainName} to {domainEntry}.
        slots:
          domainName: requestBody.domainName
          domainEntry: requestBody.domainEntry
      method: generated
      generated: '2026-09-26'