OneTrust · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/onetrust-data-subjects-v3-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['/rest/api/preferences/v3/datasubject-profiles'].get
$.paths['/rest/api/preferences/v3/datasubjects/profile'].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 Consent & Preferences - Universal Consent & Preference…
  version: 1.0.0
extends: openapi/onetrust-data-subjects-v3-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['/rest/api/preferences/v3/datasubject-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List data subject profiles (v3 preferences)
      effect: read
      questions:
      - Should new integrations avoid the v3 preferences data subject list?
      - Can I filter v3 data subject profiles by purpose or collection point?
      instructions:
      - text: List v3 data subject profiles updated since {updatedSince}.
        slots:
          updatedSince: query.updatedSince
      - text: List v3 profiles for purpose {purposeGuid} at collection point {collectionPointGuid}.
        slots:
          purposeGuid: query.purposeGuid
          collectionPointGuid: query.collectionPointGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/preferences/v3/datasubjects/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data subject profile (v3 preferences)
      effect: read
      questions:
      - Can I fetch one person's profile from the v3 preferences API?
      - Does the v3 profile lookup return an instant link token?
      instructions:
      - text: Get the v3 profile for data subject {identifier}.
        slots:
          identifier: header.identifier
      - text: Fetch v3 profile {identifier} with instant link token {includeInstantLinkToken}.
        slots:
          identifier: header.identifier
          includeInstantLinkToken: query.includeInstantLinkToken
      method: generated
      generated: '2026-09-26'