# 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 Threats API
  version: 1.0.0
extends: openapi/onetrust-threats-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/threats'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a threat
      effect: write
      questions:
      - How do I add a single new threat to the Threat Library?
      - Can I set a framework and category when adding one threat?
      instructions:
      - text: Create threat {identifier} named {name} in org {orgGroupId}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          orgGroupId: requestBody.orgGroupId
      - text: Add threat {name} ({identifier}) for org {orgGroupId} in category {category}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          orgGroupId: requestBody.orgGroupId
          category: requestBody.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/threats/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Search threats
      effect: read
      questions:
      - What threats are in my Threat Library?
      - Can I search threats by keyword and see their status and framework?
      instructions:
      - text: List all threats in the library.
      - text: Search threats for {fullText}.
        slots:
          fullText: requestBody.fullText
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v1/threats/{threatId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a threat
      effect: destructive
      questions:
      - How do I remove a threat from the Threat Library?
      - Can I delete a threat by its ID?
      instructions:
      - text: Delete threat {threatId}.
        slots:
          threatId: path.threatId
      - text: Remove threat {threatId} from the library.
        slots:
          threatId: path.threatId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v2/threats'].put
  update:
    x-apievangelist-phrasing:
      intent: Update threats in bulk
      effect: write
      questions:
      - How do I update attributes on several existing threats at once?
      - Can I edit multiple threats in a single request?
      instructions:
      - text: Update the attributes of these existing threats.
      - text: Bulk edit threats already in the Threat Library.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/controls/v2/threats'].post
  update:
    x-apievangelist-phrasing:
      intent: Create multiple threats
      effect: write
      questions:
      - How do I import many new threats into the Threat Library at once?
      - Can I create a batch of threats in one call?
      instructions:
      - text: Create these new threats in bulk.
      - text: Import a batch of new threats into the library.
      method: generated
      generated: '2026-09-26'