OneTrust · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/onetrust-consent-attachments-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 6

$.info

$.paths['/rest/api/preferences/v1/attachments'].post

$.paths['/rest/api/preferences/v1/attachments/{attachmentId}'].get

$.paths['/rest/api/preferences/v1/attachments-reference/{attachmentId}'].delete

$.paths['/rest/api/preferences/v1/datasubjects/{identifier}/attachment-references'].delete

$.paths['/rest/api/preferences/v1/datasubjects/{identifier}/attachments'].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-consent-attachments-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: 5
- target: $.paths['/rest/api/preferences/v1/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a written consent file
      effect: write
      questions:
      - How do I store a signed consent form as proof of consent?
      - What file types and size limit are allowed for consent attachments?
      instructions:
      - text: Upload consent file {file}.
        slots:
          file: requestBody.file
      - text: Store the signed consent document {file} as an attachment.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/preferences/v1/attachments/{attachmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one consent attachment
      effect: read
      questions:
      - How do I download a single consent file attached to a person?
      - Which ID do I use to fetch one specific consent attachment?
      instructions:
      - text: Download consent attachment {attachmentId} for data subject {identifier}.
        slots:
          attachmentId: path.attachmentId
          identifier: header.identifier
      - text: Get the zip of attachment {attachmentId} belonging to {identifier}.
        slots:
          attachmentId: path.attachmentId
          identifier: header.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/preferences/v1/attachments-reference/{attachmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one consent attachment
      effect: destructive
      questions:
      - How do I detach a single consent file from a data subject?
      - Can I remove one specific attachment reference without touching the others?
      instructions:
      - text: Remove consent attachment {attachmentId} from data subject {identifier}.
        slots:
          attachmentId: path.attachmentId
          identifier: header.identifier
      - text: Detach file reference {attachmentId} from {identifier}.
        slots:
          attachmentId: path.attachmentId
          identifier: header.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/preferences/v1/datasubjects/{identifier}/attachment-references'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all consent attachments for a person
      effect: destructive
      questions:
      - How do I clear every consent file attached to a data subject?
      - Can I remove all attachment references for one person at once?
      instructions:
      - text: Remove all consent attachments from data subject {identifier}.
        slots:
          identifier: path.identifier
      - text: Clear every file reference attached to {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/preferences/v1/datasubjects/{identifier}/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: Download all consent attachments for a person
      effect: read
      questions:
      - How do I get every consent file stored for one data subject?
      - Do all of a person's consent attachments come back as a single zip?
      instructions:
      - text: Download all consent attachments for data subject {identifier}.
        slots:
          identifier: path.identifier
      - text: Get a zip of every consent file stored for {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'