# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tenable Platform & Settings Scanner Tasks API
  version: 1.0.0
extends: openapi/tenable-scanner-tasks-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: 4
- target: $.paths['/scanners/{scanner_uuid}/directives'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an instruction to one scanner
      effect: write
      questions:
      - Can I tell a single scanner to restart or change a setting remotely?
      - What directive types can I send to one scanner?
      instructions:
      - text: Send directive {type} to scanner {scanner_uuid}.
        slots:
          type: requestBody.type
          scanner_uuid: path.scanner_uuid
      - text: Send instruction {type} with options {options} to scanner {scanner_uuid}.
        slots:
          type: requestBody.type
          options: requestBody.options
          scanner_uuid: path.scanner_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/bulk/directives'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an instruction to many scanners
      effect: write
      questions:
      - Can I send the same instruction to all my scanners at once?
      - Is there a way to restart a list of scanners in one request?
      instructions:
      - text: Send directive {directive} to scanners {scanners}.
        slots:
          directive: requestBody.directive
          scanners: requestBody.scanners
      - text: Send directive {directive} to every scanner, all scanners set to {all_scanners}.
        slots:
          directive: requestBody.directive
          all_scanners: requestBody.all_scanners
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/{scanner_id}/scans/{scan_uuid}/control'].post
  update:
    x-apievangelist-phrasing:
      intent: Control a scan running on a scanner
      effect: write
      questions:
      - Can I pause or stop a scan from the scanner it's running on?
      - What actions can I take on a scan currently running on a particular scanner?
      instructions:
      - text: Apply action {action} to scan {scan_uuid} on scanner {scanner_id}.
        slots:
          action: requestBody.action
          scan_uuid: path.scan_uuid
          scanner_id: path.scanner_id
      - text: On scanner {scanner_id}, {action} the running scan {scan_uuid}.
        slots:
          scanner_id: path.scanner_id
          action: requestBody.action
          scan_uuid: path.scan_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/{scanner_id}/link'].put
  update:
    x-apievangelist-phrasing:
      intent: Link or unlink a scanner
      effect: write
      questions:
      - Can I disable a scanner's link without deleting it?
      - How do I re-enable the link state for a scanner?
      instructions:
      - text: Set the link state of scanner {scanner_id} to {link}.
        slots:
          scanner_id: path.scanner_id
          link: requestBody.link
      - text: Disable the link for scanner {scanner_id}.
        slots:
          scanner_id: path.scanner_id
      method: generated
      generated: '2026-10-01'