OneTrust · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/onetrust-deduplicate-data-subjects-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 7

$.info

$.paths['/api/consentmanager/v1/datasubjects/merge/{mergeRequestId}'].post

$.paths['/api/consentmanager/v1/export-duplicate-datasubject/{mergeRequestId}'].get

$.paths['/api/consentmanager/v1/scheduled-jobs/merge-request'].get

$.paths['/api/consentmanager/v1/scheduled-jobs/merge-request'].post

$.paths['/api/consentmanager/v1/scheduled-jobs/merge-request/{mergeRequestGuid}'].get

$.paths['/api/consentmanager/v1/scheduled-jobs/merge-request/{mergeRequestGuid}'].delete

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-deduplicate-data-subjects-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: 6
- target: $.paths['/api/consentmanager/v1/datasubjects/merge/{mergeRequestId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge duplicate data subjects
      effect: write
      questions:
      - Can I merge duplicate data subjects into one consent profile?
      - What must exist before duplicate data subjects can be merged?
      instructions:
      - text: Merge the duplicate data subjects in merge request {mergeRequestId}.
        slots:
          mergeRequestId: path.mergeRequestId
      - text: Deduplicate data subjects using {mergeRequestId}.
        slots:
          mergeRequestId: path.mergeRequestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/export-duplicate-datasubject/{mergeRequestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a duplicate data subjects export
      effect: read
      questions:
      - Can I get a spreadsheet of duplicate data subjects emailed to a user?
      - What format is the duplicate data subjects export?
      instructions:
      - text: Generate the duplicate data subjects export for {mergeRequestId} and send it to user {userGuid}.
        slots:
          mergeRequestId: path.mergeRequestId
          userGuid: header.userGuid
      - text: Export duplicates found by merge request {mergeRequestId} for {userGuid}.
        slots:
          mergeRequestId: path.mergeRequestId
          userGuid: header.userGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/scheduled-jobs/merge-request'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled duplicate exports
      effect: read
      questions:
      - Which scheduled exports of duplicate data subjects do I have?
      - Can I see the frequency and status of each duplicate export schedule?
      instructions:
      - text: List scheduled duplicate exports, page {page} of size {size}.
        slots:
          page: query.page
          size: query.size
      - text: Show all merge request export schedules, {size} per page, page {page}.
        slots:
          size: query.size
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/scheduled-jobs/merge-request'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a duplicate data subjects export
      effect: write
      questions:
      - Can I schedule a recurring export of duplicate data subjects?
      - Which data elements decide whether two data subjects are duplicates?
      instructions:
      - text: Schedule duplicate export {mergeRequestName} with ID {mergeRequestId}, frequency {jobFrequency}, condition {mergeCondition}, elements {customDataElementNames}.
        slots:
          mergeRequestName: requestBody.mergeRequestName
          mergeRequestId: requestBody.mergeRequestId
          jobFrequency: requestBody.jobFrequency
          mergeCondition: requestBody.mergeCondition
          customDataElementNames: requestBody.customDataElementNames
      - text: Create a {jobFrequency} duplicate export named {mergeRequestName}.
        slots:
          jobFrequency: requestBody.jobFrequency
          mergeRequestName: requestBody.mergeRequestName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/scheduled-jobs/merge-request/{mergeRequestGuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scheduled duplicate export
      effect: read
      questions:
      - What is the status of one scheduled duplicate export?
      - Can I check a single merge request's export frequency?
      instructions:
      - text: Get scheduled export {mergeRequestGuid}.
        slots:
          mergeRequestGuid: path.mergeRequestGuid
      - text: Show the status of duplicate export schedule {mergeRequestGuid}.
        slots:
          mergeRequestGuid: path.mergeRequestGuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/scheduled-jobs/merge-request/{mergeRequestGuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled duplicate export
      effect: destructive
      questions:
      - Can I stop and remove a scheduled duplicate export?
      - Is deleting a merge request schedule permanent?
      instructions:
      - text: Delete scheduled export {mergeRequestGuid}.
        slots:
          mergeRequestGuid: path.mergeRequestGuid
      - text: Remove duplicate export schedule {mergeRequestGuid}.
        slots:
          mergeRequestGuid: path.mergeRequestGuid
      method: generated
      generated: '2026-09-26'