Amazon Lightsail · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon Lightsail Contact Methods API

5 actions 5 updates phrasing extends openapi/amazon-lightsail-contact-methods-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 5

$.info
$.paths['/ls/api/2016-11-28/CreateContactMethod'].post
$.paths['/ls/api/2016-11-28/DeleteContactMethod'].post
$.paths['/ls/api/2016-11-28/GetContactMethods'].get
$.paths['/ls/api/2016-11-28/SendContactMethodVerification'].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 Contact Methods API
  version: 1.0.0
extends: openapi/amazon-lightsail-contact-methods-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: 4
- target: $.paths['/ls/api/2016-11-28/CreateContactMethod'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email or SMS contact method
      effect: write
      questions:
      - How do I get Lightsail notifications sent to my phone by text?
      - Can I add an email address for alarm notifications?
      instructions:
      - text: Add a {protocol} contact method for {contactEndpoint}.
        slots:
          protocol: requestBody.protocol
          contactEndpoint: requestBody.contactEndpoint
      - text: Register {contactEndpoint} to receive notifications over {protocol}.
        slots:
          contactEndpoint: requestBody.contactEndpoint
          protocol: requestBody.protocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/DeleteContactMethod'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a notification contact method
      effect: destructive
      questions:
      - How do I stop getting Lightsail alerts by SMS?
      - Can I remove the email contact method from this region?
      instructions:
      - text: Delete my {protocol} contact method.
        slots:
          protocol: requestBody.protocol
      - text: Remove the {protocol} notification contact.
        slots:
          protocol: requestBody.protocol
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/GetContactMethods'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification contact methods
      effect: read
      questions:
      - Which email and phone contacts get my Lightsail notifications?
      - Is my email contact method verified yet?
      instructions:
      - text: List my contact methods.
      - text: Show my {protocols} contact method.
        slots:
          protocols: query.protocols
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ls/api/2016-11-28/SendContactMethodVerification'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a verification to an email contact
      effect: write
      questions:
      - How do I verify the email address I added for notifications?
      - Can I resend the verification email for my contact method?
      instructions:
      - text: Send a verification request to my {protocol} contact method.
        slots:
          protocol: requestBody.protocol
      - text: Resend the {protocol} contact verification message.
        slots:
          protocol: requestBody.protocol
      method: generated
      generated: '2026-09-26'