# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon API Gateway REST API Keys Domain Names API
  version: 1.0.0
extends: openapi/aws-api-gateway-domain-names-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: 5
- target: $.paths['/domainnames'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom domain names
      effect: read
      questions:
      - Which custom domains are set up in my API Gateway account?
      - How do I page through a long list of custom domain names?
      instructions:
      - text: List all my custom domain names.
      - text: Show the first {limit} custom domain names.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domainnames'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up a custom domain name
      effect: write
      questions:
      - How do I serve my API from my own domain like api.example.com?
      - Can I attach an ACM certificate ARN when creating a custom domain?
      - Does a new custom domain support mutual TLS?
      instructions:
      - text: Create custom domain {domainName} using certificate {certificateArn}.
        slots:
          domainName: requestBody.domainName
          certificateArn: requestBody.certificateArn
      - text: Create a regional custom domain {domainName} with regional certificate {regionalCertificateArn}.
        slots:
          domainName: requestBody.domainName
          regionalCertificateArn: requestBody.regionalCertificateArn
      - text: Set up custom domain {domainName} with security policy {securityPolicy}.
        slots:
          domainName: requestBody.domainName
          securityPolicy: requestBody.securityPolicy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domainnames/{domain_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom domain name
      effect: read
      questions:
      - How do I check the configuration of a specific custom domain?
      - Which certificate and endpoint type is one of my custom domains using?
      instructions:
      - text: Show the details of custom domain {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: Get the certificate and endpoint settings for {domain_name}.
        slots:
          domain_name: path.domain_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domainnames/{domain_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom domain name
      effect: destructive
      questions:
      - How do I remove a custom domain I no longer use for my API?
      - Will deleting a custom domain stop traffic on that hostname?
      instructions:
      - text: Delete custom domain {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: Tear down the custom domain {domain_name} from API Gateway.
        slots:
          domain_name: path.domain_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domainnames/{domain_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a custom domain's settings
      effect: write
      questions:
      - Can I swap the certificate on an existing custom domain?
      - How do I change the security policy of a custom domain I already created?
      instructions:
      - text: Update custom domain {domain_name} with patch operations {patchOperations}.
        slots:
          domain_name: path.domain_name
          patchOperations: requestBody.patchOperations
      - text: Rotate the certificate on existing custom domain {domain_name}.
        slots:
          domain_name: path.domain_name
      method: generated
      generated: '2026-10-01'