OneTrust · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/onetrust-receipts-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/v1/receipt-list'].get

$.paths['/api/consentmanager/v1/receipts'].get

$.paths['/api/consentmanager/v1/receipts/{id}'].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-receipts-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/v1/receipt-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a data subject's receipts (deprecated)
      effect: read
      questions:
      - Is the old receipt list endpoint still supported?
      - Can I list consent receipts for one data subject?
      instructions:
      - text: List consent receipts for data subject {identifier}.
        slots:
          identifier: header.identifier
      - text: Show the receipt IDs recorded for {identifier} via the deprecated endpoint.
        slots:
          identifier: header.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/receipts'].get
  update:
    x-apievangelist-phrasing:
      intent: List receipt details for a data subject
      effect: read
      questions:
      - Can I get the full details of every consent receipt for one person?
      - Is it possible to include not-given consent in receipt details?
      instructions:
      - text: Get receipt details for data subject {identifier}.
        slots:
          identifier: header.identifier
      - text: List detailed receipts for {identifier}, including not-given {includeNotgiven}.
        slots:
          identifier: header.identifier
          includeNotgiven: query.includeNotgiven
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/receipts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consent receipt
      effect: read
      questions:
      - Can I pull up a single consent receipt by its ID?
      - Does one receipt include its consent strings?
      instructions:
      - text: Get receipt {id}.
        slots:
          id: path.id
      - text: Show consent receipt {id} with consent strings {includeConsentStrings}.
        slots:
          id: path.id
          includeConsentStrings: query.includeConsentStrings
      method: generated
      generated: '2026-09-26'