OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Privacy Automation - Data Subject Request (DSR) Automation…

5 actions 5 updates phrasing extends openapi/onetrust-verification-methods-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 5

$.info
$.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/verificationmethods'].get
$.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/verificationmethods'].put
$.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/verificationmethods'].post
$.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/{methodId}'].get

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 Privacy Automation - Data Subject Request (DSR) Automation…
  version: 1.0.0
extends: openapi/onetrust-verification-methods-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: 4
- target: $.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/verificationmethods'].get
  update:
    x-apievangelist-phrasing:
      intent: List a request's verification methods
      effect: read
      questions:
      - Which identity verification methods are on a data subject request?
      - Can I include comments when listing verification methods?
      instructions:
      - text: List verification methods for request {requestQueueRefId}, comments {includeComments}.
        slots:
          requestQueueRefId: path.requestQueueRefId
          includeComments: query.includeComments
      - text: Show every verification step on {requestQueueRefId} with comments {includeComments}.
        slots:
          requestQueueRefId: path.requestQueueRefId
          includeComments: query.includeComments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/verificationmethods'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a verification method's status
      effect: write
      questions:
      - Can I mark a request's identity verification as passed or failed?
      - Is it possible to add comments to an existing verification method?
      instructions:
      - text: Update verification method {id} on request {requestQueueRefId} to status {verificationStatus}.
        slots:
          id: requestBody.id
          requestQueueRefId: path.requestQueueRefId
          verificationStatus: requestBody.verificationStatus
      - text: Add comment {verificationComments} to the verification on {requestQueueRefId}.
        slots:
          verificationComments: requestBody.verificationComments
          requestQueueRefId: path.requestQueueRefId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/verificationmethods'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a verification method to a request
      effect: write
      questions:
      - Can I add a new identity verification method to a request?
      - What types of verification can be attached to a data subject request?
      instructions:
      - text: Add verification method {verificationMethodName} to request {requestQueueRefId}.
        slots:
          verificationMethodName: requestBody.verificationMethodName
          requestQueueRefId: path.requestQueueRefId
      - text: Create a {verificationType} verification on {requestQueueRefId}.
        slots:
          verificationType: requestBody.verificationType
          requestQueueRefId: path.requestQueueRefId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/{methodId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one verification method
      effect: read
      questions:
      - Can I look up a single verification method on a request by its ID?
      - What is the status of one identity check on a request?
      instructions:
      - text: Get verification method {methodId} on request {requestQueueRefId}, comments {includeComments}.
        slots:
          methodId: path.methodId
          requestQueueRefId: path.requestQueueRefId
          includeComments: query.includeComments
      - text: Show the status of check {methodId} for {requestQueueRefId}, comments {includeComments}.
        slots:
          methodId: path.methodId
          requestQueueRefId: path.requestQueueRefId
          includeComments: query.includeComments
      method: generated
      generated: '2026-09-26'