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-targeted-data-discovery-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/datadiscovery/groups/{groupId}/requestqueues/{requestQueueRefId}'].get
$.paths['/api/datasubject/v2/datadiscovery/requestqueues/{requestQueueRefId}'].get
$.paths['/api/datasubject/v2/datadiscovery/requestqueues/{requestQueueRefId}'].post
$.paths['/api/datasubject/v3/datadiscovery/requestqueues/{requestQueueRefId}'].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 Privacy Automation - Data Subject Request (DSR) Automation…
  version: 1.0.0
extends: openapi/onetrust-targeted-data-discovery-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/datadiscovery/groups/{groupId}/requestqueues/{requestQueueRefId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results for a data discovery group
      effect: read
      questions:
      - What personal data did targeted discovery find in one group for a request?
      - Can I include attachments when viewing a discovery group's results?
      instructions:
      - text: Show discovery results for group {groupId} on request {requestQueueRefId}.
        slots:
          groupId: path.groupId
          requestQueueRefId: path.requestQueueRefId
      - text: Get group {groupId} results with attachments for request {requestQueueRefId}.
        slots:
          groupId: path.groupId
          requestQueueRefId: path.requestQueueRefId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/datadiscovery/requestqueues/{requestQueueRefId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List data discovery groups for a request
      effect: read
      questions:
      - Which targeted data discovery groups exist for a subject rights request?
      - In what order are a request's discovery groups arranged?
      instructions:
      - text: List discovery groups for request {requestQueueRefId}.
        slots:
          requestQueueRefId: path.requestQueueRefId
      - text: Show the targeted data discovery groups on request {requestQueueRefId}.
        slots:
          requestQueueRefId: path.requestQueueRefId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/datadiscovery/requestqueues/{requestQueueRefId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add discovery results to a request
      effect: write
      questions:
      - How do I report what personal data a system holds back to a data subject request?
      - Can I submit structured discovery results from one system to a request?
      instructions:
      - text: Add discovery results from system {system} to request {requestQueueRefId}.
        slots:
          system: requestBody.system
          requestQueueRefId: path.requestQueueRefId
      - text: Post results {results} found in {system} to request {requestQueueRefId}.
        slots:
          results: requestBody.results
          system: requestBody.system
          requestQueueRefId: path.requestQueueRefId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v3/datadiscovery/requestqueues/{requestQueueRefId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add unstructured discovery data points to a request
      effect: write
      questions:
      - How do I add unstructured data findings like documents to a subject request?
      - Is there a newer endpoint for discovery results that include unstructured data?
      instructions:
      - text: Add unstructured findings {unstructuredResults} from {system} to request {requestQueueRefId}.
        slots:
          unstructuredResults: requestBody.unstructuredResults
          system: requestBody.system
          requestQueueRefId: path.requestQueueRefId
      - text: Submit unstructured data points from system {system} to request {requestQueueRefId}.
        slots:
          system: requestBody.system
          requestQueueRefId: path.requestQueueRefId
      method: generated
      generated: '2026-09-26'