# 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 Exclusions API
  version: 1.0.0
extends: openapi/tenable-exclusions-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: 6
- target: $.paths['/exclusions'].get
  update:
    x-apievangelist-phrasing:
      intent: List scan exclusions
      effect: read
      questions:
      - Which hosts are excluded from my vulnerability scans?
      - Can I page through scan exclusions?
      instructions:
      - text: List my scan exclusions.
      - text: List {limit} exclusions sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exclusions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scan exclusion
      effect: write
      questions:
      - How do I stop certain IP ranges from being scanned?
      - Can a scan exclusion apply only during a scheduled window?
      - Can I tie an exclusion to a specific network?
      instructions:
      - text: Create exclusion {name} for hosts {members}.
        slots:
          name: requestBody.name
          members: requestBody.members
      - text: Exclude {members} from scans on schedule {schedule} under the name {name}.
        slots:
          members: requestBody.members
          schedule: requestBody.schedule
          name: requestBody.name
      - text: Create exclusion {name} for {members} in network {network_id}.
        slots:
          name: requestBody.name
          members: requestBody.members
          network_id: requestBody.network_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exclusions/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import scan exclusions from a file
      effect: write
      questions:
      - Can I bulk import scan exclusions from a file?
      - Does importing exclusions support the network_id attribute?
      instructions:
      - text: Import exclusions from file {file}.
        slots:
          file: requestBody.file
      - text: Bulk load scan exclusions from {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exclusions/{exclusion_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan exclusion
      effect: read
      questions:
      - What hosts and schedule are in a particular exclusion?
      - Where can I view one exclusion's details?
      instructions:
      - text: Get exclusion {exclusion_id}.
        slots:
          exclusion_id: path.exclusion_id
      - text: Show the members and schedule of exclusion {exclusion_id}.
        slots:
          exclusion_id: path.exclusion_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exclusions/{exclusion_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scan exclusion
      effect: write
      questions:
      - Can I change the hosts covered by an existing exclusion?
      - How do I update an exclusion's schedule?
      instructions:
      - text: Update exclusion {exclusion_id} to name {name} and hosts {members}.
        slots:
          exclusion_id: path.exclusion_id
          name: requestBody.name
          members: requestBody.members
      - text: Change exclusion {exclusion_id} schedule to {schedule}, keeping name {name} and members {members}.
        slots:
          exclusion_id: path.exclusion_id
          schedule: requestBody.schedule
          name: requestBody.name
          members: requestBody.members
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exclusions/{exclusion_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan exclusion
      effect: destructive
      questions:
      - How do I delete an exclusion so those hosts get scanned again?
      - Can I remove a scan exclusion I created?
      instructions:
      - text: Delete exclusion {exclusion_id}.
        slots:
          exclusion_id: path.exclusion_id
      - text: Remove scan exclusion {exclusion_id}.
        slots:
          exclusion_id: path.exclusion_id
      method: generated
      generated: '2026-10-01'