OneTrust · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/onetrust-preference-centers-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 4

$.info

$.paths['/api/consentmanager/v2/preferencecenterpage/{preferencecenterpageid}/schema'].get

$.paths['/api/consentmanager/v2/preferencecenters'].get

$.paths['/api/consentmanager/v2/preferencecenters/{preferencecenterid}/schema'].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-preference-centers-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: 3
- target: $.paths['/api/consentmanager/v2/preferencecenterpage/{preferencecenterpageid}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a preference center page schema
      effect: read
      questions:
      - What sections, purposes and data elements appear on one page of a multi-page preference center?
      - Can I view the draft or published version of a preference center page?
      instructions:
      - text: Show the schema of preference center page {preferencecenterpageid}.
        slots:
          preferencecenterpageid: path.preferencecenterpageid
      - text: Get the {state} schema of page {preferencecenterpageid}.
        slots:
          state: query.state
          preferencecenterpageid: path.preferencecenterpageid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v2/preferencecenters'].get
  update:
    x-apievangelist-phrasing:
      intent: List preference centers
      effect: read
      questions:
      - What preference centers have we built, and when were they published?
      - Which preference centers collect a given data element?
      instructions:
      - text: List all preference centers.
      - text: List preference centers that use data element {dataElementGuid}.
        slots:
          dataElementGuid: query.dataElementGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v2/preferencecenters/{preferencecenterid}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a preference center root schema
      effect: read
      questions:
      - What settings, languages and pages does a multi-page preference center have?
      - How do I get the top-level structure of a preference center?
      instructions:
      - text: Show the root schema of preference center {preferencecenterid}.
        slots:
          preferencecenterid: path.preferencecenterid
      - text: Get the {state} root schema of preference center {preferencecenterid}.
        slots:
          state: query.state
          preferencecenterid: path.preferencecenterid
      method: generated
      generated: '2026-09-26'