# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Vulnerability Management Scan Control API
  version: 1.0.0
extends: openapi/tenable-scan-control-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: 5
- target: $.paths['/scans/{scan_id}/launch'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch a scan
      effect: write
      questions:
      - How do I start a vulnerability scan right now?
      - Can I launch a scan against different targets than it's configured for?
      - Is there a limit on how many scans can run at once?
      instructions:
      - text: Launch scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Launch scan {scan_id} against alternate targets {alt_targets}.
        slots:
          scan_id: path.scan_id
          alt_targets: requestBody.alt_targets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a running scan
      effect: write
      questions:
      - Can I pause a scan that's currently running?
      - Which scan statuses allow pausing?
      instructions:
      - text: Pause scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Temporarily halt running scan {scan_id}.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused scan
      effect: write
      questions:
      - How do I continue a scan I paused earlier?
      - Can a scan be resumed if it isn't in paused status?
      instructions:
      - text: Resume scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Continue the paused scan {scan_id}.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a scan
      effect: destructive
      questions:
      - Can I stop a scan that's pending or running?
      - What if a scan is stuck in stopping or publishing and a normal stop won't work?
      instructions:
      - text: Stop scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Gracefully stop the running scan {scan_id}.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{schedule_uuid}/force-stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Force stop a stuck scan
      effect: destructive
      questions:
      - Can I force a scan to abort and cancel its incomplete tasks?
      - Are completed scan tasks still kept after a force stop?
      instructions:
      - text: Force stop scan {schedule_uuid}.
        slots:
          schedule_uuid: path.schedule_uuid
      - text: Abort scan {schedule_uuid} and cancel all its unfinished tasks.
        slots:
          schedule_uuid: path.schedule_uuid
      method: generated
      generated: '2026-10-01'