# 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 Actions API
  version: 1.0.0
extends: openapi/onetrust-risk-actions-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: 7
- target: $.paths['/api/risk/v2/risks/{riskId}/actions/{action}'].put
  update:
    x-apievangelist-phrasing:
      intent: Perform a risk action (deprecated)
      effect: write
      questions:
      - Is the generic perform-risk-action endpoint still supported?
      - Can I run a named action on a risk through the deprecated call?
      instructions:
      - text: Perform action {action} on risk {riskId} using the deprecated endpoint.
        slots:
          action: path.action
          riskId: path.riskId
      - text: Run legacy risk action {action} for {riskId}.
        slots:
          action: path.action
          riskId: path.riskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/risk/v2/risks/{riskId}/approve'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve a risk
      effect: write
      questions:
      - Can I approve a risk and set its residual risk level and score?
      - What must be provided to approve a risk?
      instructions:
      - text: Approve risk {riskId} with result {result}, residual level {residualRiskLevelId}, score {residualRiskScore}.
        slots:
          riskId: path.riskId
          result: requestBody.result
          residualRiskLevelId: requestBody.residualRiskLevelId
          residualRiskScore: requestBody.residualRiskScore
      - text: Approve risk {riskId} with comment {comment}.
        slots:
          riskId: path.riskId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/risk/v2/risks/{riskId}/grant-exception'].put
  update:
    x-apievangelist-phrasing:
      intent: Grant an exception for a risk
      effect: write
      questions:
      - Can I grant an exception on a risk instead of remediating it?
      - Does granting a risk exception let me record a residual score?
      instructions:
      - text: Grant an exception on risk {riskId} with result {result}.
        slots:
          riskId: path.riskId
          result: requestBody.result
      - text: Grant risk {riskId} an exception, result {result}, noting {comment}.
        slots:
          riskId: path.riskId
          result: requestBody.result
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/risk/v2/risks/{riskId}/reopen'].put
  update:
    x-apievangelist-phrasing:
      intent: Reopen a risk
      effect: write
      questions:
      - Can a closed risk be reopened?
      - Is it possible to send a reopened risk to a specific workflow stage?
      instructions:
      - text: Reopen risk {riskId}.
        slots:
          riskId: path.riskId
      - text: Reopen risk {riskId} at stage {stage} with comment {comment}.
        slots:
          riskId: path.riskId
          stage: requestBody.stage
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/risk/v2/risks/{riskId}/request-exception'].put
  update:
    x-apievangelist-phrasing:
      intent: Request an exception for a risk
      effect: write
      questions:
      - Can I ask for an exception on a risk rather than grant one?
      - Where do I submit a request for a risk exception?
      instructions:
      - text: Request an exception for risk {riskId}.
        slots:
          riskId: path.riskId
      - text: Ask for an exception on {riskId} because {comment}.
        slots:
          riskId: path.riskId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/risk/v2/risks/{riskId}/send-back'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a risk back for more information
      effect: write
      questions:
      - Can I return a risk to its owner to gather more detail?
      - What happens when a risk is sent back?
      instructions:
      - text: Send risk {riskId} back for more information.
        slots:
          riskId: path.riskId
      - text: Return risk {riskId} to its owner with note {comment}.
        slots:
          riskId: path.riskId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/risk/v2/risks/{riskId}/submit'].put
  update:
    x-apievangelist-phrasing:
      intent: Submit a risk for approval
      effect: write
      questions:
      - Can I submit a risk so it goes to the approver?
      - Is a comment allowed when submitting a risk?
      instructions:
      - text: Submit risk {riskId} for approval.
        slots:
          riskId: path.riskId
      - text: Submit {riskId} to its approver with comment {comment}.
        slots:
          riskId: path.riskId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'