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-banner-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/banner'].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 - Consent Management Platform (CMP)…
  version: 1.0.0
extends: openapi/onetrust-banner-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/banner'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cookie banner data for an app
      effect: read
      questions:
      - What does my app need to render the consent banner?
      - Can the banner data be localized by language and country?
      - Which headers identify the app and SDK when fetching banner data?
      instructions:
      - text: Get banner data for app {appId} on {deviceType} with SDK {sdkVersion} from CDN {cdnLocation}.
        slots:
          appId: header.OT-App-Id
          deviceType: header.OT-Device-Type
          sdkVersion: header.OT-SDK-Version
          cdnLocation: header.OT-CDN-Location
      - text: Fetch the banner for app {appId} in language {language}, SDK {sdkVersion}, device {deviceType}, CDN {cdnLocation}.
        slots:
          appId: header.OT-App-Id
          language: header.OT-Language
          sdkVersion: header.OT-SDK-Version
          deviceType: header.OT-Device-Type
          cdnLocation: header.OT-CDN-Location
      method: generated
      generated: '2026-09-26'