# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postman Monitors API
  version: 1.0.0
extends: openapi/postman-monitors-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: 8
- target: $.paths['/monitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitors
      effect: read
      questions:
      - Which scheduled monitors are set up in my workspace?
      - Can I list only the active monitors that run a particular collection?
      instructions:
      - text: List the monitors in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: Show monitors that run collection {collectionUid}.
        slots:
          collectionUid: query.collectionUid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/monitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitor for a collection
      effect: write
      questions:
      - How do I schedule a collection to run on a recurring monitor?
      - Why can't I create a monitor for a collection that belongs to an API definition?
      instructions:
      - text: Create a monitor in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: 'Set up a new monitor in workspace {workspace} with this configuration: {monitor}.'
        slots:
          workspace: query.workspace
          monitor: requestBody.monitor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/monitors/{monitorId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitor
      effect: read
      questions:
      - What schedule and last run result does one of my monitors have?
      - Can I look up a monitor's configuration by ID?
      instructions:
      - text: Get monitor {monitorId}.
        slots:
          monitorId: path.monitorId
      - text: Show the schedule and recent status of monitor {monitorId}.
        slots:
          monitorId: path.monitorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/monitors/{monitorId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a monitor's configuration
      effect: write
      questions:
      - How do I change how often a monitor runs?
      - Can I edit an existing monitor's settings instead of recreating it?
      instructions:
      - text: Update monitor {monitorId} with configuration {monitor}.
        slots:
          monitorId: path.monitorId
          monitor: requestBody.monitor
      - text: Reconfigure the schedule of monitor {monitorId}.
        slots:
          monitorId: path.monitorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/monitors/{monitorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a monitor
      effect: destructive
      questions:
      - How do I stop and remove a monitor I no longer need?
      - Is deleting a monitor permanent?
      instructions:
      - text: Delete monitor {monitorId}.
        slots:
          monitorId: path.monitorId
      - text: Remove the scheduled monitor {monitorId}.
        slots:
          monitorId: path.monitorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/monitors/{monitorId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a monitor now
      effect: write
      questions:
      - Can I trigger a monitor run on demand instead of waiting for its schedule?
      - What results come back when I run a monitor asynchronously?
      instructions:
      - text: Run monitor {monitorId} now.
        slots:
          monitorId: path.monitorId
      - text: Trigger monitor {monitorId} with async set to {async}.
        slots:
          monitorId: path.monitorId
          async: query.async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/runners/{runnerId}/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List instances of a private monitor runner
      effect: read
      questions:
      - Which instances of my self-hosted runner are polling for monitor runs?
      - How do I see every execution sharing one runner ID?
      instructions:
      - text: List the instances of runner {runnerId}.
        slots:
          runnerId: path.runnerId
      - text: Show the first {limit} instances of runner {runnerId}.
        slots:
          limit: query.limit
          runnerId: path.runnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/runners/{runnerId}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a runner's queue and polling metrics
      effect: read
      questions:
      - When did my monitor runner last poll, and how deep is its run queue?
      - What server-side metrics are available for a runner?
      instructions:
      - text: Get the metrics for runner {runnerId}.
        slots:
          runnerId: path.runnerId
      - text: Show runner {runnerId}'s monitor queue and last polling date.
        slots:
          runnerId: path.runnerId
      method: generated
      generated: '2026-09-26'