OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & - Cross-Device Consent Preferences API

2 actions 2 updates phrasing extends openapi/onetrust-preferences-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['/v1/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 & - Cross-Device Consent Preferences API
  version: 1.0.0
extends: openapi/onetrust-preferences-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['/v1/preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data subject's cross-device preferences
      effect: read
      questions:
      - What cross-device consent preferences has a user saved?
      - Can I filter a data subject's preferences by sync group?
      instructions:
      - text: Get preferences for {identifier} in tenant {tenantId} with authorization {Authorization}.
        slots:
          identifier: header.identifier
          tenantId: header.tenantId
          Authorization: header.Authorization
      - text: Fetch {identifier}'s preferences for sync group {syncGroup}, tenant {tenantId}, auth {Authorization}.
        slots:
          identifier: header.identifier
          syncGroup: query.syncGroup
          tenantId: header.tenantId
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'