API Evangelist conversational phrasing for Reference Monitorings API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Monitorings API
  version: 1.0.0
extends: openapi/canopy-monitorings-api-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: 8
- target: $.paths['/teams/{teamId}/monitorings'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitorings on insurance accounts
      effect: read
      questions:
      - Which insurance accounts am I currently monitoring for refreshes?
      - Can I list only the monitorings tied to one pull or with a particular status?
      - How do I page through all my monitorings?
      instructions:
      - text: List the monitorings on team {team}.
        slots:
          team: path.teamId
      - text: Show monitorings for pull {pull} on team {team}.
        slots:
          pull: query.pull_id
          team: path.teamId
      - text: List monitorings with status {status} on team {team}.
        slots:
          status: query.status
          team: path.teamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/monitorings'].post
  update:
    x-apievangelist-phrasing:
      intent: Start monitoring an insurance account
      effect: write
      questions:
      - How do I set up recurring refreshes of a connected insurance account?
      - What's the shortest refresh interval I can schedule for a monitored account?
      - Can I choose a stop date when I start monitoring a pull?
      instructions:
      - text: Start monitoring pull {pull} on team {team}, refreshing every {interval}.
        slots:
          pull: requestBody.pull_id
          team: path.teamId
          interval: requestBody.interval
      - text: Monitor pull {pull} every {interval} and stop after {stop}.
        slots:
          pull: requestBody.pull_id
          interval: requestBody.interval
          stop: requestBody.stop_after_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/monitorings/{monitoringId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitoring and its pulls
      effect: read
      questions:
      - How do I see the details of one monitored insurance account?
      - Can I include the history of pulls when fetching a single monitoring?
      instructions:
      - text: Get monitoring {monitoring} on team {team}.
        slots:
          monitoring: path.monitoringId
          team: path.teamId
      - text: Show monitoring {monitoring} with its pulls included.
        slots:
          monitoring: path.monitoringId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/monitorings/{monitoringId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop a monitoring
      effect: destructive
      questions:
      - How do I stop refreshing a monitored insurance account?
      - Can I pause monitoring on an account without deleting the pull?
      instructions:
      - text: Stop monitoring {monitoring} on team {team}.
        slots:
          monitoring: path.monitoringId
          team: path.teamId
      - text: Pause the refresh schedule for monitoring {monitoring}.
        slots:
          monitoring: path.monitoringId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/monitorings/{monitoringId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a monitoring's schedule or status
      effect: write
      questions:
      - How do I change how often an existing monitoring refreshes?
      - Can I move the next refresh date or set an end date on a monitoring I already have?
      instructions:
      - text: Change monitoring {monitoring} on team {team} to refresh every {interval}.
        slots:
          monitoring: path.monitoringId
          team: path.teamId
          interval: requestBody.interval
      - text: Set the next refresh of monitoring {monitoring} to {date}.
        slots:
          monitoring: path.monitoringId
          date: requestBody.next_pull_date
      - text: Set the status of monitoring {monitoring} to {status}.
        slots:
          monitoring: path.monitoringId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/monitorings/{monitoringId}/reconnectToken'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a reconnect token for a monitoring
      effect: read
      questions:
      - How do I get a token to send a consumer back to reconnect a monitored account?
      - What do I use when a monitored account needs the user to log in again?
      instructions:
      - text: Generate a reconnect token for monitoring {monitoring} on team {team}.
        slots:
          monitoring: path.monitoringId
          team: path.teamId
      - text: Get a reconnect token so the user can fix monitoring {monitoring}.
        slots:
          monitoring: path.monitoringId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/monitorings/{monitoringId}/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a monitored account now
      effect: write
      questions:
      - Can I refresh a monitored insurance account right away instead of waiting for the schedule?
      - How do I trigger an on-demand refresh of a connected policy?
      instructions:
      - text: Refresh monitoring {monitoring} on team {team} now.
        slots:
          monitoring: path.monitoringId
          team: path.teamId
      - text: Trigger an immediate data refresh for monitoring {monitoring}.
        slots:
          monitoring: path.monitoringId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/teams/{teamId}/monitorings/{monitoringId}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Get changes between a monitoring's last two pulls
      effect: read
      questions:
      - What changed on a monitored policy between its two most recent refreshes?
      - Does seeing monitoring change events require a special plan?
      instructions:
      - text: Show the events for monitoring {monitoring} on team {team}.
        slots:
          monitoring: path.monitoringId
          team: path.teamId
      - text: List what changed between the last two pulls of monitoring {monitoring}.
        slots:
          monitoring: path.monitoringId
      method: generated
      generated: '2026-10-01'