OneTrust · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/onetrust-risk-relationships-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for OneTrust's API. It is a proposal applied on top of the contract, not a document OneTrust publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/risk/v2/risks/{riskId}/control-implementations'].post
$.paths['/api/risk/v2/risks/{riskId}/threats'].post
$.paths['/api/risk/v2/risks/{riskId}/vulnerabilities'].post

OpenAPI Overlay

Raw ↑
# 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 Risk…
  version: 1.0.0
extends: openapi/onetrust-risk-relationships-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: 3
- target: $.paths['/api/risk/v2/risks/{riskId}/control-implementations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add control implementations to a risk
      effect: write
      questions:
      - How do I attach mitigating controls to a risk?
      - Can I set the status of controls as I add them to a risk?
      instructions:
      - text: Add controls {controlIds} to risk {riskId}.
        slots:
          controlIds: requestBody.controlIds
          riskId: path.riskId
      - text: Attach controls {controlIds} to risk {riskId} with status {status}.
        slots:
          controlIds: requestBody.controlIds
          riskId: path.riskId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/risk/v2/risks/{riskId}/threats'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the threat on a risk
      effect: write
      questions:
      - How do I record which threat a risk comes from?
      - Does adding a threat replace the one already on the risk?
      instructions:
      - text: Set threat {threatId} on risk {riskId}.
        slots:
          threatId: requestBody.threatId
          riskId: path.riskId
      - text: Replace the threat on risk {riskId} with {threatId}.
        slots:
          riskId: path.riskId
          threatId: requestBody.threatId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/risk/v2/risks/{riskId}/vulnerabilities'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the vulnerabilities on a risk
      effect: write
      questions:
      - How do I tie library vulnerabilities to a risk?
      - Will assigning vulnerabilities overwrite those already on the risk?
      instructions:
      - text: Assign vulnerabilities {vulnerabilityIdList} to risk {riskId}.
        slots:
          vulnerabilityIdList: requestBody.vulnerabilityIdList
          riskId: path.riskId
      - text: Replace risk {riskId}'s vulnerabilities with {vulnerabilityIdList}.
        slots:
          riskId: path.riskId
          vulnerabilityIdList: requestBody.vulnerabilityIdList
      method: generated
      generated: '2026-09-26'