# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Better Stack Uptime Status Pages API
  version: 1.0.0
extends: openapi/betterstack-status-pages-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: 6
- target: $.paths['/status-pages'].get
  update:
    x-apievangelist-phrasing:
      intent: List status pages
      effect: read
      questions:
      - Which public status pages do I have in Better Stack?
      - Can I page through my status pages if I have a lot of them?
      instructions:
      - text: List all of my status pages.
      - text: Show page {page} of my status pages, {per_page} at a time.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/status-pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a public status page
      effect: write
      questions:
      - How do I publish a status page for my customers?
      - Can a new status page be password-protected or hidden from search engines?
      - Can I put a status page on my own custom domain?
      instructions:
      - text: Create a status page for {company_name} at {company_url} on subdomain {subdomain}.
        slots:
          company_name: requestBody.company_name
          company_url: requestBody.company_url
          subdomain: requestBody.subdomain
      - text: Set up a new status page for {company_name} ({company_url}) on subdomain {subdomain} served at {custom_domain}.
        slots:
          company_name: requestBody.company_name
          company_url: requestBody.company_url
          subdomain: requestBody.subdomain
          custom_domain: requestBody.custom_domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/status-pages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a status page's settings
      effect: read
      questions:
      - What subdomain and custom domain is a specific status page using?
      - Does one particular status page allow visitors to subscribe to updates?
      instructions:
      - text: Show me status page {id}.
        slots:
          id: path.id
      - text: Get the configuration of status page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/status-pages/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a status page
      effect: destructive
      questions:
      - Can I take down a status page I no longer need?
      - Is removing a status page permanent?
      instructions:
      - text: Delete status page {id}.
        slots:
          id: path.id
      - text: Take status page {id} down permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/status-pages/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing status page
      effect: write
      questions:
      - Can I post an announcement on a status page I already have?
      - How do I change the logo or timezone of an existing status page?
      instructions:
      - text: Update status page {id} for {company_name} ({company_url}, subdomain {subdomain}) with announcement {announcement}.
        slots:
          id: path.id
          company_name: requestBody.company_name
          company_url: requestBody.company_url
          subdomain: requestBody.subdomain
          announcement: requestBody.announcement
      - text: Change status page {id} for {company_name} at {company_url} on {subdomain} to use timezone {timezone}.
        slots:
          id: path.id
          company_name: requestBody.company_name
          company_url: requestBody.company_url
          subdomain: requestBody.subdomain
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/status-pages/group/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the status pages in a group
      effect: read
      questions:
      - Which status pages belong to a particular status page group?
      - Can I see all the pages grouped together under one group?
      instructions:
      - text: List the status pages in group {id}.
        slots:
          id: path.id
      - text: Show every status page that belongs to group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'