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-resolutions-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/resolutions'].get
$.paths['/api/datasubject/v2/resolutions'].post
$.paths['/api/datasubject/v2/resolutions/{resolutionId}'].put
$.paths['/api/datasubject/v2/resolutions/{resolutionId}'].delete

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-resolutions-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/resolutions'].get
  update:
    x-apievangelist-phrasing:
      intent: List privacy request resolutions
      effect: read
      questions:
      - What resolution options can a privacy request be closed with?
      - Can the resolutions list include ones used on subtasks?
      instructions:
      - text: List all request resolutions.
      - text: Show request resolutions translated into {language}, including subtask resolutions.
        slots:
          language: query.language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/resolutions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a request resolution
      effect: write
      questions:
      - How do I add a new way to resolve data subject requests?
      - Can a resolution be set to close, reject or complete a request?
      instructions:
      - text: Create a resolution that closes {close}, rejects {reject} and completes {complete} a request.
        slots:
          close: requestBody.close
          reject: requestBody.reject
          complete: requestBody.complete
      - text: Add a {type} resolution with titles {titleTranslations}, close {close}, reject {reject}, complete {complete}.
        slots:
          type: requestBody.type
          titleTranslations: requestBody.titleTranslations
          close: requestBody.close
          reject: requestBody.reject
          complete: requestBody.complete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/resolutions/{resolutionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a request resolution
      effect: write
      questions:
      - How do I change what an existing resolution does to a request?
      - Can I update the translated titles of a resolution?
      instructions:
      - text: Update resolution {resolutionId} to close {close}, reject {reject}, complete {complete}.
        slots:
          resolutionId: path.resolutionId
          close: requestBody.close
          reject: requestBody.reject
          complete: requestBody.complete
      - text: Change the title translations of resolution {resolutionId} to {titleTranslations}.
        slots:
          resolutionId: path.resolutionId
          titleTranslations: requestBody.titleTranslations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/resolutions/{resolutionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a request resolution
      effect: destructive
      questions:
      - How do I remove a resolution option we no longer use?
      - Can a request resolution be deleted by ID?
      instructions:
      - text: Delete resolution {resolutionId}.
        slots:
          resolutionId: path.resolutionId
      - text: Remove request resolution {resolutionId} permanently.
        slots:
          resolutionId: path.resolutionId
      method: generated
      generated: '2026-09-26'