OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & Preferences - Consent Interfaces Preferences V2…

2 actions 2 updates phrasing extends openapi/onetrust-preferences-v2-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 2

$.info

$.paths['/v2/preferences'].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 - Consent Interfaces Preferences V2…
  version: 1.0.0
extends: openapi/onetrust-preferences-v2-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: 1
- target: $.paths['/v2/preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data subject's real-time preferences
      effect: read
      questions:
      - What has a given person consented to right now?
      - Does the preferences lookup include the person's geolocation?
      instructions:
      - text: Get consent preferences for {identifier} in tenant {tenantId}.
        slots:
          identifier: header.identifier
          tenantId: header.tenantId
      - text: Show real-time purpose preferences of data subject {identifier}, tenant {tenantId}.
        slots:
          identifier: header.identifier
          tenantId: header.tenantId
      method: generated
      generated: '2026-09-26'