# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Status Pages V3 API
  version: 1.0.0
extends: openapi/checkly-status-pages-v3-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['/v3/status-pages'].get
  update:
    x-apievangelist-phrasing:
      intent: List v3 status pages
      effect: read
      questions:
      - Which components-based status pages do I have in Checkly?
      - How do I page through my v3 status pages?
      instructions:
      - text: List my v3 status pages.
      - text: Show v3 status pages after {nextId}.
        slots:
          nextId: query.nextId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a v3 status page
      effect: write
      questions:
      - How do I set up a new public status page for my service?
      - Can a new status page use my own domain like status.example.com?
      instructions:
      - text: Create a v3 status page {name} at {url}.
        slots:
          name: requestBody.name
          url: requestBody.url
      - text: Create status page {name} at {url} served on custom domain {customDomain}.
        slots:
          name: requestBody.name
          url: requestBody.url
          customDomain: requestBody.customDomain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a v3 status page
      effect: read
      questions:
      - What branding and domain settings does a given v3 status page have?
      - Can I fetch one v3 status page by its id?
      instructions:
      - text: Show v3 status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      - text: Get the settings of status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a v3 status page's settings
      effect: write
      questions:
      - Will updating a v3 status page reset fields I leave out?
      - How do I change the name or URL of my v3 status page?
      instructions:
      - text: Update v3 status page {statusPageId} with name {name} and URL {url}.
        slots:
          statusPageId: path.statusPageId
          name: requestBody.name
          url: requestBody.url
      - text: Set status page {statusPageId} to name {name}, URL {url}, footer {footerText}.
        slots:
          statusPageId: path.statusPageId
          name: requestBody.name
          url: requestBody.url
          footerText: requestBody.footerText
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a v3 status page
      effect: destructive
      questions:
      - Does deleting a v3 status page also remove its components and automation rules?
      - How do I take down a status page permanently?
      instructions:
      - text: Delete v3 status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      - text: Remove status page {statusPageId} along with its components.
        slots:
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/custom-domain-verifications'].get
  update:
    x-apievangelist-phrasing:
      intent: Get DNS records to verify a status page domain
      effect: read
      questions:
      - Which DNS records do I need to add to verify my status page's custom domain?
      - Is my status page custom domain verified yet?
      instructions:
      - text: Show the custom domain verification records for status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      - text: Get the DNS entries I need for status page {statusPageId}'s domain.
        slots:
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status-pages/{statusPageId}/custom-domain-verifications/recheck'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-check a status page's custom domain
      effect: write
      questions:
      - I just added the DNS records, how do I make it re-verify my status page domain?
      - Can I force a fresh verification check for a status page custom domain?
      instructions:
      - text: Re-check the custom domain verification for status page {statusPageId}.
        slots:
          statusPageId: path.statusPageId
      - text: Retry domain verification on status page {statusPageId} now.
        slots:
          statusPageId: path.statusPageId
      method: generated
      generated: '2026-09-26'