OneTrust · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/api/consentmanager/v2/purposes'].get
$.paths['/api/consentmanager/v2/purposes/{purposeId}'].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-purposes-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: 2
- target: $.paths['/api/consentmanager/v2/purposes'].get
  update:
    x-apievangelist-phrasing:
      intent: List purpose versions
      effect: read
      questions:
      - What consent purposes do we have, and which versions are published?
      - Can I include retired purposes or only get the latest version of each?
      - Which purposes were modified within a date range?
      instructions:
      - text: List the latest version of every purpose.
      - text: List purposes modified between {fromLastModifiedDate} and {toLastModifiedDate}.
        slots:
          fromLastModifiedDate: query.fromLastModifiedDate
          toLastModifiedDate: query.toLastModifiedDate
      - text: List purpose versions for organization {organization}, including retired ones.
        slots:
          organization: query.organization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v2/purposes/{purposeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a purpose
      effect: read
      questions:
      - What preferences and attributes does a specific consent purpose have?
      - How do I fetch a particular version of a purpose?
      instructions:
      - text: Show purpose {purposeId}.
        slots:
          purposeId: path.purposeId
      - text: Get version {version} of purpose {purposeId}.
        slots:
          version: query.version
          purposeId: path.purposeId
      method: generated
      generated: '2026-09-26'