# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Synthetic Monitoring Scouts API
  version: 1.0.0
extends: openapi/controlup-scouts-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: 6
- target: $.paths['/scouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Scouts
      effect: read
      questions:
      - Which synthetic monitoring Scouts do I have running?
      - Can I list only disabled Scouts or those in a specific hive?
      instructions:
      - text: List all Scouts.
      - text: List Scouts in hive {hiveId}.
        slots:
          hiveId: query.hiveId
      - text: Find Scouts named {scoutName}.
        slots:
          scoutName: query.scoutName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scouts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Scout
      effect: write
      questions:
      - Can I set up a Scout to test an EUC or network resource?
      - Does creating a Scout use credits?
      instructions:
      - text: Create a new Scout.
      - text: Create a Scout tagged {tags}.
        slots:
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scouts/{scoutId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Scout and its test summary
      effect: read
      questions:
      - How has one Scout's testing performed over the last 24 hours?
      - Can I see a Scout's result summary for a custom time range?
      instructions:
      - text: Show Scout {scoutId}.
        slots:
          scoutId: path.scoutId
      - text: Summarize Scout {scoutId} results from {start} to {end}.
        slots:
          scoutId: path.scoutId
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scouts/{scoutId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a Scout
      effect: write
      questions:
      - Can I change a Scout's settings without resending everything?
      - Can I retag an existing Scout?
      instructions:
      - text: Edit Scout {scoutId}.
        slots:
          scoutId: path.scoutId
      - text: Update the tags on Scout {scoutId} to {tags}.
        slots:
          scoutId: path.scoutId
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scouts/{scoutId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Scout
      effect: destructive
      questions:
      - Can I permanently delete a Scout and get its credits back?
      - Is Scout history kept after deletion?
      instructions:
      - text: Delete Scout {scoutId}.
        slots:
          scoutId: path.scoutId
      - text: Permanently remove Scout {scoutId}.
        slots:
          scoutId: path.scoutId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scouts/{scoutId}/disabled'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a Scout
      effect: write
      questions:
      - Can I pause a Scout's tests without deleting it?
      - Does re-enabling a Scout consume credits again?
      instructions:
      - text: Set Scout {scoutId} disabled to {disabled}.
        slots:
          scoutId: path.scoutId
          disabled: requestBody.disabled
      - text: Disable Scout {scoutId}.
        slots:
          scoutId: path.scoutId
      method: generated
      generated: '2026-09-26'