OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & Preferences - Policy & Notice Management Privacy…

4 actions 4 updates phrasing extends openapi/onetrust-privacy-notice-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['/v2/privacynotices'].get

$.paths['/v2/privacynotices/{id}'].get

$.paths['/v2/privacynotices/{privacyNoticeId}/versions'].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 - Policy & Notice Management Privacy…
  version: 1.0.0
extends: openapi/onetrust-privacy-notice-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['/v2/privacynotices'].get
  update:
    x-apievangelist-phrasing:
      intent: List privacy notices
      effect: read
      questions:
      - Which privacy notices do we have and when were they last published?
      - Can I page through all privacy notices?
      instructions:
      - text: List all privacy notices.
      - text: Show page {page} of privacy notices.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/privacynotices/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a privacy notice as published on a date
      effect: read
      questions:
      - Which version of our privacy notice was live on a specific date?
      - Can I retrieve the notice text in effect at a past time?
      instructions:
      - text: Get privacy notice {id} as published on {date}.
        slots:
          id: path.id
          date: query.date
      - text: Show the version of notice {id} live at {date}.
        slots:
          id: path.id
          date: query.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/privacynotices/{privacyNoticeId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a privacy notice's versions
      effect: read
      questions:
      - How many versions has a privacy notice gone through?
      - Can I see the version history of one notice?
      instructions:
      - text: List versions of privacy notice {privacyNoticeId}.
        slots:
          privacyNoticeId: path.privacyNoticeId
      - text: Show page {page} of version history for notice {privacyNoticeId}.
        slots:
          page: query.page
          privacyNoticeId: path.privacyNoticeId
      method: generated
      generated: '2026-09-26'