OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & Preferences - Consent Management Platform (CMP)…

2 actions 2 updates phrasing extends openapi/onetrust-data-subject-access-request-dsar-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['/cfw/cmp/v1/dsar'].post

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 Management Platform (CMP)…
  version: 1.0.0
extends: openapi/onetrust-data-subject-access-request-dsar-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['/cfw/cmp/v1/dsar'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a global opt-out request from an app
      effect: write
      questions:
      - How does my mobile app submit a global opt-out for a user?
      - Which SDK headers must accompany an opt-out request?
      instructions:
      - text: Submit a global opt-out of {globalOptOut} for app {appId} on {deviceType} with SDK {sdkVersion} via CDN {cdnLocation}.
        slots:
          globalOptOut: requestBody.globalOptOut
          appId: header.OT-App-Id
          deviceType: header.OT-Device-Type
          sdkVersion: header.OT-SDK-Version
          cdnLocation: header.OT-CDN-Location
      - text: File a global opt-out request for user {identifier} in app {appId}.
        slots:
          identifier: header.OT-Identifier
          appId: header.OT-App-Id
      method: generated
      generated: '2026-09-26'