# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Parallel Monitor API
  version: 1.0.0
extends: openapi/parallel-monitor-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['/v1/monitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List my web monitors
      effect: read
      questions:
      - Which web monitors do I currently have running?
      - Can I include cancelled monitors when listing them?
      - How do I page through a long list of monitors?
      instructions:
      - text: List my active monitors.
      - text: List my monitors with status {status}.
        slots:
          status: query.status
      - text: Show the {limit} newest {type} monitors.
        slots:
          limit: query.limit
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/monitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitor to track web changes
      effect: write
      questions:
      - How do I set up a monitor that alerts me when something material changes on the web?
      - What's the difference between an event_stream monitor and a snapshot monitor?
      - How often can a monitor run, hourly, daily or weekly?
      - Can a new monitor send its change notifications to my webhook?
      instructions:
      - text: Create a {type} monitor that runs every {frequency} with settings {settings}.
        slots:
          type: requestBody.type
          frequency: requestBody.frequency
          settings: requestBody.settings
      - text: Set up a {type} monitor every {frequency} using {settings} and notify {webhook}.
        slots:
          type: requestBody.type
          frequency: requestBody.frequency
          settings: requestBody.settings
          webhook: requestBody.webhook
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/monitors/{monitor_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitor's configuration
      effect: read
      questions:
      - What frequency, query and webhook is a particular monitor configured with?
      - Can I check whether a monitor is still active or was cancelled?
      instructions:
      - text: Show the configuration of monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      - text: Get the status and schedule of monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/monitors/{monitor_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Permanently stop a monitor
      effect: destructive
      questions:
      - How do I permanently stop a monitor from running?
      - Can a cancelled monitor be resumed later?
      instructions:
      - text: Cancel monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      - text: Permanently shut off monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/monitors/{monitor_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List the changes a monitor detected
      effect: read
      questions:
      - What material changes has my monitor picked up recently?
      - Can I also see monitor executions that found no changes?
      - How do I narrow monitor events down to a single execution?
      instructions:
      - text: List recent events for monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      - text: Show the events from execution {event_group_id} of monitor {monitor_id}.
        slots:
          event_group_id: query.event_group_id
          monitor_id: path.monitor_id
      - text: List monitor {monitor_id} events including no-change completions.
        slots:
          monitor_id: path.monitor_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/monitors/{monitor_id}/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a monitor immediately
      effect: write
      questions:
      - Can I make a monitor check for changes right now instead of waiting for its schedule?
      - Does running a monitor on demand change its regular schedule?
      instructions:
      - text: Trigger monitor {monitor_id} to run now.
        slots:
          monitor_id: path.monitor_id
      - text: Kick off an off-schedule check for monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/monitors/{monitor_id}/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a monitor's settings
      effect: write
      questions:
      - Can I change how often an existing monitor runs?
      - How do I remove the webhook from a monitor I already created?
      - Is it possible to change the search query on an existing event_stream monitor?
      instructions:
      - text: Change monitor {monitor_id} to run every {frequency}.
        slots:
          monitor_id: path.monitor_id
          frequency: requestBody.frequency
      - text: Point monitor {monitor_id} notifications at webhook {webhook}.
        slots:
          monitor_id: path.monitor_id
          webhook: requestBody.webhook
      - text: Update the {type} settings of monitor {monitor_id} to {settings}.
        slots:
          type: requestBody.type
          monitor_id: path.monitor_id
          settings: requestBody.settings
      method: generated
      generated: '2026-10-01'