# 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 Monitors API
  version: 1.0.0
extends: openapi/betterstack-monitors-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: 7
- target: $.paths['/monitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List uptime monitors
      effect: read
      questions:
      - Which URLs am I monitoring in Better Stack?
      - Can I find the monitor watching a particular URL?
      - Is there a way to look up a monitor by its display name?
      instructions:
      - text: List all of my uptime monitors.
      - text: Find the monitor that checks {url}.
        slots:
          url: query.url
      - text: Find monitors named {pronounceable_name}.
        slots:
          pronounceable_name: query.pronounceable_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an uptime monitor for a URL
      effect: write
      questions:
      - How do I start monitoring a website for downtime?
      - Can a new monitor also warn me before my SSL certificate or domain expires?
      - Which regions can a new monitor check from, and how often?
      instructions:
      - text: Create a {monitor_type} monitor for {url}.
        slots:
          monitor_type: requestBody.monitor_type
          url: requestBody.url
      - text: Start monitoring {url} as a {monitor_type} check every {check_frequency} seconds.
        slots:
          url: requestBody.url
          monitor_type: requestBody.monitor_type
          check_frequency: requestBody.check_frequency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitors/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitor's configuration
      effect: read
      questions:
      - What URL and check frequency is a specific monitor using?
      - Is a given monitor currently up, down or paused?
      instructions:
      - text: Show me monitor {id}.
        slots:
          id: path.id
      - text: Get the settings for monitor {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitors/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a monitor
      effect: destructive
      questions:
      - Can I stop and remove monitoring for a site I've shut down?
      - Does deleting a monitor remove it permanently rather than pausing it?
      instructions:
      - text: Delete monitor {id}.
        slots:
          id: path.id
      - text: Remove monitor {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitors/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing monitor's settings
      effect: write
      questions:
      - Can I change the URL or check interval of a monitor I already have?
      - How do I pause an existing monitor during maintenance?
      instructions:
      - text: Update monitor {id} to check {url} as a {monitor_type} monitor.
        slots:
          id: path.id
          url: requestBody.url
          monitor_type: requestBody.monitor_type
      - text: Change monitor {id} on {url} ({monitor_type}) to check every {check_frequency} seconds.
        slots:
          id: path.id
          url: requestBody.url
          monitor_type: requestBody.monitor_type
          check_frequency: requestBody.check_frequency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitors/{id}/response-times'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitor's response times
      effect: read
      questions:
      - How fast has my website been responding to uptime checks?
      - Has latency on a monitored endpoint gotten slower lately?
      instructions:
      - text: Get response times for monitor {id}.
        slots:
          id: path.id
      - text: Show how quickly the site behind monitor {id} has been responding.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitors/{id}/availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitor's uptime availability
      effect: read
      questions:
      - What uptime percentage has my website had?
      - How much downtime has a monitored URL recorded?
      instructions:
      - text: Get the availability of monitor {id}.
        slots:
          id: path.id
      - text: Report the uptime percentage for monitor {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'