OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Onetrust Domains API

8 actions 8 updates phrasing extends openapi/onetrust-domains-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 8

$.info
$.paths['/api/cmp/v1/domains/{domainId}'].delete
$.paths['/api/cmp/v1/domains/{domainId}/domaingroup'].post
$.paths['/api/cmp/v1/domains/{id}/branding-attributes'].get
$.paths['/api/cmp/v1/domains/{id}/branding-attributes'].put
$.paths['/api/cmp/v1/webscans/domains/schedule'].post
$.paths['/api/cmp/v1/webscans/domains/schedule/cancel'].post
$.paths['/v1/domains/{domainId}/domaingroup'].post

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 Onetrust Domains API
  version: 1.0.0
extends: openapi/onetrust-domains-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: 7
- target: $.paths['/api/cmp/v1/domains/{domainId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a domain
      effect: destructive
      questions:
      - Can I remove a domain from the cookie consent setup?
      - Is deleting a domain permanent?
      instructions:
      - text: Delete domain {domainId}.
        slots:
          domainId: path.domainId
      - text: Remove the domain with ID {domainId}.
        slots:
          domainId: path.domainId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/domains/{domainId}/domaingroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a domain group (CMP v1)
      effect: write
      questions:
      - Can I group several URLs under one domain using the CMP v1 endpoint?
      - Is it possible to replace an existing domain group's URLs?
      instructions:
      - text: Create a domain group on {domainId} with URLs {urls} via the CMP v1 path.
        slots:
          domainId: path.domainId
          urls: requestBody.urls
      - text: Update CMP domain group {domainId}, removing existing entries {removeExisting}.
        slots:
          domainId: path.domainId
          removeExisting: requestBody.removeExisting
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/domains/{id}/branding-attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's branding attributes
      effect: read
      questions:
      - Which branding colors and styles are set on a domain's banner?
      - Can I read the branding attributes for one domain?
      instructions:
      - text: Get branding attributes for domain {id}.
        slots:
          id: path.id
      - text: Show the banner branding settings on domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/domains/{id}/branding-attributes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a domain's branding attributes
      effect: write
      questions:
      - Can I change the branding attributes of a domain's consent banner?
      - Is it possible to restyle a domain's banner programmatically?
      instructions:
      - text: Update branding attributes on domain {id} to {attributes}.
        slots:
          id: path.id
          attributes: requestBody.attributes
      - text: Restyle domain {id}'s banner branding.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/domains/schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule website scans
      effect: write
      questions:
      - Can I schedule cookie scans for several domains at once?
      - Is there a way to set up recurring website scans?
      instructions:
      - text: Schedule scans for my domains.
      - text: Set up scheduled website scans for the listed domains.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/domains/schedule/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel scheduled website scans
      effect: destructive
      questions:
      - Can I cancel scans that are already scheduled?
      - Is it possible to stop scheduled scans in bulk?
      instructions:
      - text: Cancel the scheduled website scans.
      - text: Bulk-cancel my domains' scan schedules.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/domains/{domainId}/domaingroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a domain group (legacy v1)
      effect: write
      questions:
      - Is there an older v1 domains path for creating a domain group?
      - Can I add URLs to a domain group using the legacy endpoint?
      instructions:
      - text: Create a domain group on {domainId} with URLs {urls} via the legacy v1 domains path.
        slots:
          domainId: path.domainId
          urls: requestBody.urls
      - text: Using the legacy endpoint, update domain group {domainId}.
        slots:
          domainId: path.domainId
      method: generated
      generated: '2026-09-26'