# 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 Scanners API
  version: 1.0.0
extends: openapi/tenable-scanners-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: 7
- target: $.paths['/scanners'].get
  update:
    x-apievangelist-phrasing:
      intent: List scanners
      effect: read
      questions:
      - Which Nessus scanners are linked to my account?
      - Where can I see all my scanners and their status?
      instructions:
      - text: List my scanners.
      - text: Show every linked scanner and whether it is online.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/{scanner_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scanner's details
      effect: read
      questions:
      - What version and status is a particular scanner running?
      - How can I look up details for a single scanner?
      instructions:
      - text: Get details for scanner {scanner_id}.
        slots:
          scanner_id: path.scanner_id
      - text: Show the status of scanner {scanner_id}.
        slots:
          scanner_id: path.scanner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/{scanner_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scanner
      effect: write
      questions:
      - Can I force a scanner to update its plugins right away?
      - How do I rename a scanner?
      - Can I change how often an AWS scanner updates?
      instructions:
      - text: Force a plugin update on scanner {scanner_id} by setting {force_plugin_update}.
        slots:
          scanner_id: path.scanner_id
          force_plugin_update: requestBody.force_plugin_update
      - text: Rename scanner {scanner_id} to {name}.
        slots:
          scanner_id: path.scanner_id
          name: requestBody.name
      - text: Set the AWS update interval for scanner {scanner_id} to {aws_update_interval}.
        slots:
          scanner_id: path.scanner_id
          aws_update_interval: requestBody.aws_update_interval
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/{scanner_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete and unlink a scanner
      effect: destructive
      questions:
      - How do I unlink a scanner I've decommissioned?
      - Does deleting a scanner remove it from my account entirely?
      instructions:
      - text: Delete scanner {scanner_id}.
        slots:
          scanner_id: path.scanner_id
      - text: Unlink scanner {scanner_id} from my account.
        slots:
          scanner_id: path.scanner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/{scanner_id}/key'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scanner's key
      effect: read
      questions:
      - Where do I find the key for a specific scanner?
      - What privilege do I need to read a scanner's linking key?
      instructions:
      - text: Get the key for scanner {scanner_id}.
        slots:
          scanner_id: path.scanner_id
      - text: Retrieve scanner {scanner_id}'s key.
        slots:
          scanner_id: path.scanner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/{scanner_id}/aws-targets'].get
  update:
    x-apievangelist-phrasing:
      intent: List AWS targets of a scanner
      effect: read
      questions:
      - Which AWS instances can my AWS scanner target?
      - Can I see the scan targets for an Amazon Web Services scanner?
      instructions:
      - text: List AWS scan targets for scanner {scanner_id}.
        slots:
          scanner_id: path.scanner_id
      - text: Show the EC2 targets AWS scanner {scanner_id} can reach.
        slots:
          scanner_id: path.scanner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/{scanner_id}/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List scans running on a scanner
      effect: read
      questions:
      - What scans are running on a particular scanner right now?
      - Is a scanner busy with any active scans?
      instructions:
      - text: List scans running on scanner {scanner_id}.
        slots:
          scanner_id: path.scanner_id
      - text: Show the active jobs on scanner {scanner_id}.
        slots:
          scanner_id: path.scanner_id
      method: generated
      generated: '2026-10-01'