# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tenable Vulnerabilities API
  version: 1.0.0
extends: openapi/tenable-vulnerabilities-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['/import/vulnerabilities'].post
  update:
    x-apievangelist-phrasing:
      intent: Import vulnerabilities (v1)
      effect: write
      questions:
      - How do I push third-party vulnerability findings into Vulnerability Management?
      - What's the size and asset limit for a vulnerability import request?
      instructions:
      - text: Import vulnerabilities from source {source} of type {type} for assets {assets} using the v1 import.
        slots:
          source: requestBody.source
          type: requestBody.type
          assets: requestBody.assets
      - text: Load v1 vulnerability data for {assets} from {source} with type {type} and checks run {checks_ran}.
        slots:
          assets: requestBody.assets
          source: requestBody.source
          type: requestBody.type
          checks_ran: requestBody.checks_ran
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/vulnerabilities'].post
  update:
    x-apievangelist-phrasing:
      intent: Import vulnerabilities (v2)
      effect: write
      questions:
      - Can I import vulnerability data while naming the vendor and product that found it?
      - Which import version lets me declare scan coverage for my assets?
      instructions:
      - text: Import v2 vulnerabilities from vendor {vendor} product {product}, data type {data_type}, source {source}, for assets {assets}.
        slots:
          vendor: requestBody.vendor
          product: requestBody.product
          data_type: requestBody.data_type
          source: requestBody.source
          assets: requestBody.assets
      - text: Use the v2 import to add {assets} from {vendor} {product} as {data_type} via {source} with coverage {coverage}.
        slots:
          assets: requestBody.assets
          vendor: requestBody.vendor
          product: requestBody.product
          data_type: requestBody.data_type
          source: requestBody.source
          coverage: requestBody.coverage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/vulnerabilities/{vuln_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a web app vulnerability instance
      effect: read
      questions:
      - What are the details of one specific web application vulnerability?
      - Where can I read the evidence for a web app finding?
      instructions:
      - text: Get web app vulnerability {vuln_id}.
        slots:
          vuln_id: path.vuln_id
      - text: Show details for WAS finding {vuln_id}.
        slots:
          vuln_id: path.vuln_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/was/v2/vulnerabilities/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search web app vulnerabilities
      effect: read
      questions:
      - Which vulnerabilities have my web app scans found across all applications?
      - Can I page through every web application finding?
      instructions:
      - text: Search all web app vulnerabilities.
      - text: List {limit} WAS vulnerabilities sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'