OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & Preferences - Universal Consent & Preference…

3 actions 3 updates phrasing extends openapi/onetrust-transactions-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 3

$.info

$.paths['/api/consentmanager/v1/transactions/withdraw/fordatasubject'].put

$.paths['/api/consentmanager/v1/transactions/withdraw/purpose/{purposeId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Consent & Preferences - Universal Consent & Preference…
  version: 1.0.0
extends: openapi/onetrust-transactions-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: 2
- target: $.paths['/api/consentmanager/v1/transactions/withdraw/fordatasubject'].put
  update:
    x-apievangelist-phrasing:
      intent: Withdraw consent on a data subject's behalf
      effect: destructive
      questions:
      - Can an admin withdraw consent for a customer who asked by phone?
      - Is recording who withdrew consent required?
      instructions:
      - text: Withdraw consent for {identifier} to purpose {PurposeId}, withdrawn by {withdrawnBy}.
        slots:
          identifier: header.identifier
          PurposeId: requestBody.PurposeId
          withdrawnBy: query.withdrawnBy
      - text: On behalf of {identifier}, revoke purpose {PurposeId}; withdrawn by {withdrawnBy}, notes {Notes}.
        slots:
          identifier: query.identifier
          PurposeId: requestBody.PurposeId
          withdrawnBy: query.withdrawnBy
          Notes: requestBody.Notes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/transactions/withdraw/purpose/{purposeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Withdraw a data subject's consent via link
      effect: destructive
      questions:
      - Can a data subject withdraw their own consent for one purpose through a simple GET link?
      - Where should the identifier go when withdrawing self-service consent?
      instructions:
      - text: Withdraw {identifier}'s own consent to purpose {purposeId}.
        slots:
          identifier: header.identifier
          purposeId: path.purposeId
      - text: Record that {identifier} withdrew from purpose {purposeId} themselves.
        slots:
          identifier: query.identifier
          purposeId: path.purposeId
      method: generated
      generated: '2026-09-26'