API Evangelist conversational phrasing for Tech Risk & Compliance - IT Risk Management Vulnerabilities…

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tech Risk & Compliance - IT Risk Management Vulnerabilities…
  version: 1.0.0
extends: openapi/onetrust-vulnerabilities-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/controls/v1/vulnerabilities'].post
  update:
    x-apievangelist-phrasing:
      intent: Add one vulnerability to the library
      effect: write
      questions:
      - How do I add a single vulnerability to the Vulnerability Library?
      - Can I assign a framework and category when adding a vulnerability?
      instructions:
      - text: Add vulnerability {name} with identifier {identifier} to org group {orgGroupId}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          orgGroupId: requestBody.orgGroupId
      - text: Create one vulnerability {identifier} ({name}) in org group {orgGroupId} under framework {framework}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          orgGroupId: requestBody.orgGroupId
          framework: requestBody.framework
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/vulnerabilities/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the Vulnerability Library
      effect: read
      questions:
      - Which vulnerabilities in the library relate to a given keyword?
      - Can I filter vulnerabilities by framework or category?
      instructions:
      - text: Search the Vulnerability Library for {fullText}.
        slots:
          fullText: requestBody.fullText
      - text: List vulnerabilities matching {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/vulnerabilities/{vulnerabilityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vulnerability from the library
      effect: destructive
      questions:
      - How do I remove an outdated vulnerability from the library?
      - Can a vulnerability be deleted by its ID?
      instructions:
      - text: Delete vulnerability {vulnerabilityId}.
        slots:
          vulnerabilityId: path.vulnerabilityId
      - text: Remove {vulnerabilityId} from the Vulnerability Library.
        slots:
          vulnerabilityId: path.vulnerabilityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v2/vulnerabilities'].put
  update:
    x-apievangelist-phrasing:
      intent: Update attributes of vulnerabilities in bulk
      effect: write
      questions:
      - How do I update attributes on several vulnerabilities at once?
      - Where do I get the vulnerability IDs needed for a bulk update?
      instructions:
      - text: Bulk update attributes on these library vulnerabilities.
      - text: Apply my attribute changes across multiple vulnerabilities.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v2/vulnerabilities'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many vulnerabilities at once
      effect: write
      questions:
      - Can I import a batch of vulnerabilities into the library in one call?
      - How do I load several new vulnerabilities together?
      instructions:
      - text: Create these vulnerabilities in the library in one batch.
      - text: Import multiple new vulnerabilities into the Vulnerability Library.
      method: generated
      generated: '2026-09-26'