API Evangelist conversational phrasing for Better Stack Uptime Heartbeats API

# 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 Heartbeats API
  version: 1.0.0
extends: openapi/betterstack-heartbeats-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['/heartbeats'].get
  update:
    x-apievangelist-phrasing:
      intent: List heartbeat monitors
      effect: read
      questions:
      - Which heartbeats are set up in my Better Stack account?
      - Can I page through all of my cron job heartbeats a few at a time?
      instructions:
      - text: List all of my heartbeats.
      - text: Show page {page} of my heartbeats, {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/heartbeats'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a heartbeat for a scheduled job
      effect: write
      questions:
      - How do I get alerted when a cron job stops checking in?
      - Can a new heartbeat allow a grace period before it alerts anyone?
      instructions:
      - text: Create a heartbeat called {name} that expects a ping every {period} seconds.
        slots:
          name: requestBody.name
          period: requestBody.period
      - text: Set up a new heartbeat {name} expecting a ping every {period} seconds with a {grace} second grace period.
        slots:
          name: requestBody.name
          period: requestBody.period
          grace: requestBody.grace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/heartbeats/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a heartbeat's details
      effect: read
      questions:
      - What period and grace settings does one specific heartbeat have?
      - Is a particular heartbeat currently paused or reporting as down?
      instructions:
      - text: Show me the details of heartbeat {id}.
        slots:
          id: path.id
      - text: Look up the configuration of heartbeat {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/heartbeats/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a heartbeat
      effect: destructive
      questions:
      - Can I remove a heartbeat for a job I've retired?
      - What happens to a heartbeat once I delete it permanently?
      instructions:
      - text: Delete heartbeat {id}.
        slots:
          id: path.id
      - text: Remove heartbeat {id} from my account for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/heartbeats/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing heartbeat's settings
      effect: write
      questions:
      - Can I change how often an existing heartbeat expects a ping?
      - How do I pause alerts on a heartbeat I already set up?
      instructions:
      - text: Update heartbeat {id} so {name} expects a ping every {period} seconds.
        slots:
          id: path.id
          name: requestBody.name
          period: requestBody.period
      - text: Pause existing heartbeat {id} named {name} with period {period} seconds.
        slots:
          id: path.id
          name: requestBody.name
          period: requestBody.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/heartbeats/{id}/availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a heartbeat's availability
      effect: read
      questions:
      - What uptime percentage has my cron job heartbeat achieved?
      - How reliable has a scheduled job been at checking in on time?
      instructions:
      - text: Get the availability figures for heartbeat {id}.
        slots:
          id: path.id
      - text: Report how available heartbeat {id} has been.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'