# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Web Application Scanning v2 Configurations API
  version: 1.0.0
extends: openapi/tenable-configurations-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: 9
- target: $.paths['/was/v2/configs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a web app scan configuration
      effect: write
      questions:
      - How do I set up a new web application scan configuration?
      - Can I schedule a web app scan and choose its scanner when creating the config?
      - Is creating a WAS scan configuration asynchronous?
      instructions:
      - text: Create web app scan config {name} targeting {targets} from template {template_id}, owned by {owner_id}, with settings {settings}.
        slots:
          name: requestBody.name
          targets: requestBody.targets
          template_id: requestBody.template_id
          owner_id: requestBody.owner_id
          settings: requestBody.settings
      - text: Create WAS config {name} for {targets} using template {template_id}, owner {owner_id}, settings {settings} and schedule {schedule}.
        slots:
          name: requestBody.name
          targets: requestBody.targets
          template_id: requestBody.template_id
          owner_id: requestBody.owner_id
          settings: requestBody.settings
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/export/configs/remediation/{vuln_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a remediation scan config for a web vuln
      effect: read
      questions:
      - How do I get a ready-made scan configuration to retest a web app vulnerability?
      - Does fetching the remediation config actually create the scan configuration?
      instructions:
      - text: Get the remediation scan configuration for web vulnerability {vuln_id}.
        slots:
          vuln_id: path.vuln_id
      - text: Build the retest config body for vuln {vuln_id}.
        slots:
          vuln_id: path.vuln_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/configs/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search web app scan configurations
      effect: read
      questions:
      - Which web application scan configurations exist in my account?
      - Can I see the last scan run for each WAS configuration?
      instructions:
      - text: Search my web app scan configurations.
      - text: List {limit} WAS scan configs sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/configs/{config_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a web app scan configuration
      effect: read
      questions:
      - What targets and settings are defined in a particular WAS scan config?
      - Where can I view the full definition of one web app scan configuration?
      instructions:
      - text: Get web app scan configuration {config_id}.
        slots:
          config_id: path.config_id
      - text: Show the settings of WAS config {config_id}.
        slots:
          config_id: path.config_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/configs/{config_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a web app scan configuration
      effect: write
      questions:
      - Can I update a web app scan configuration, or create it if the ID doesn't exist yet?
      - How do I change the targets on an existing WAS scan configuration?
      instructions:
      - text: Upsert WAS config {config_id} named {name} targeting {targets} with template {template_id}, owner {owner_id} and settings {settings}.
        slots:
          config_id: path.config_id
          name: requestBody.name
          targets: requestBody.targets
          template_id: requestBody.template_id
          owner_id: requestBody.owner_id
          settings: requestBody.settings
      - text: Replace web app config {config_id} as {name} on {targets}, template {template_id}, owner {owner_id}, settings {settings}, scanner {scanner_id}.
        slots:
          config_id: path.config_id
          name: requestBody.name
          targets: requestBody.targets
          template_id: requestBody.template_id
          owner_id: requestBody.owner_id
          settings: requestBody.settings
          scanner_id: requestBody.scanner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/configs/{config_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a web app scan configuration
      effect: destructive
      questions:
      - How do I delete a WAS scan configuration along with its scan history?
      - Can I delete a web app scan configuration while a scan from it is running?
      instructions:
      - text: Delete web app scan configuration {config_id}.
        slots:
          config_id: path.config_id
      - text: Remove WAS config {config_id} and all its history and findings.
        slots:
          config_id: path.config_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/configs/{config_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move a web app scan configuration to a folder
      effect: write
      questions:
      - Can I move a web app scan configuration into a different folder?
      - How do I organise WAS scan configs by folder name?
      instructions:
      - text: Move WAS config {config_id} to folder {folder_name}.
        slots:
          config_id: path.config_id
          folder_name: requestBody.folder_name
      - text: File web app scan configuration {config_id} under {folder_name}.
        slots:
          config_id: path.config_id
          folder_name: requestBody.folder_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/configs/{config_id}/status/{tracking_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a web app scan config's processing status
      effect: read
      questions:
      - Has my WAS scan configuration finished being created or updated?
      - What do I poll to track an asynchronous scan configuration change?
      instructions:
      - text: Check processing status {tracking_id} for WAS config {config_id}.
        slots:
          tracking_id: path.tracking_id
          config_id: path.config_id
      - text: Tell me whether the change {tracking_id} to web app config {config_id} has been applied.
        slots:
          tracking_id: path.tracking_id
          config_id: path.config_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/export/configs/{config_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a web app scan config for CI/CD
      effect: read
      questions:
      - How do I run a web app scan inside my CI/CD pipeline with the WAS Docker image?
      - Can I download a scan configuration in HOCON format?
      instructions:
      - text: Export WAS config {config_id} as HOCON for CI/CD.
        slots:
          config_id: path.config_id
      - text: Download the pipeline config file for web app scan configuration {config_id}.
        slots:
          config_id: path.config_id
      method: generated
      generated: '2026-10-01'