OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Onetrust Scripts API

10 actions 10 updates phrasing extends openapi/onetrust-scripts-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 10

$.info

$.paths['/api/cmp/v1/applications/{id}/publish'].put

$.paths['/api/cmp/v1/applications/{id}/script-details'].get

$.paths['/api/cmp/v1/domains/publish'].put

$.paths['/api/cmp/v1/domains/scripts'].get

$.paths['/api/cmp/v1/domains/{domainId}/script-details'].get

$.paths['/api/cmp/v1/domains/{domainId}/scripts'].get

$.paths['/v1/script-integration/{domainId}/downloadscriptv2'].get

$.paths['/v2/websites/scripts'].get

$.paths['/v2/websites/publish'].put

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 Onetrust Scripts API
  version: 1.0.0
extends: openapi/onetrust-scripts-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: 9
- target: $.paths['/api/cmp/v1/applications/{id}/publish'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish an app's SDK configuration
      effect: write
      questions:
      - Can I publish the consent SDK configuration for a mobile application?
      - Is it possible to require reconsent when publishing an app's SDK?
      instructions:
      - text: Publish the SDK configuration for application {id}.
        slots:
          id: path.id
      - text: Publish app {id} SDK to production {production} for languages {langCodes}.
        slots:
          id: path.id
          production: requestBody.production
          langCodes: requestBody.langCodes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/script-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application's script details
      effect: read
      questions:
      - Where can I see the script details configured for a mobile app?
      - Can I check an application's consent script settings?
      instructions:
      - text: Get script details for application {id}.
        slots:
          id: path.id
      - text: Show the app script configuration of {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/domains/publish'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish cookie script to a website (CMP v1)
      effect: write
      questions:
      - Can I publish my cookie consent script to a website through the CMP v1 endpoint?
      - Does the CMP publish call let me turn on auto-blocking and SPA support?
      instructions:
      - text: Publish the cookie script to website {website} via the CMP v1 endpoint.
        slots:
          website: query.website
      - text: Publish CMP script version {scriptVersion} to {website} with autoblock {autoblockEnabled}.
        slots:
          scriptVersion: requestBody.scriptVersion
          website: query.website
          autoblockEnabled: requestBody.autoblockEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/domains/scripts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website's script (CMP v1)
      effect: read
      questions:
      - Can I fetch a website's consent script from the CMP v1 path?
      - Which script type does the CMP script lookup return for my site?
      instructions:
      - text: Get the website script for {website} from the CMP v1 endpoint.
        slots:
          website: query.website
      - text: Fetch the {scriptType} CMP script for site {website}.
        slots:
          scriptType: query.scriptType
          website: query.website
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/domains/{domainId}/script-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get script details for a domain ID
      effect: read
      questions:
      - Can I get script details using a domain's ID rather than its URL?
      - Where are the script settings for one domain stored?
      instructions:
      - text: Get script details for domain {domainId}.
        slots:
          domainId: path.domainId
      - text: Show the {scriptType} script details of domain ID {domainId}.
        slots:
          scriptType: query.scriptType
          domainId: path.domainId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/domains/{domainId}/scripts'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a domain's script files (CMP)
      effect: read
      questions:
      - Can I download the published cookie script files to self-host them?
      - Does a domain need to be published before its script files can be downloaded?
      instructions:
      - text: Download the CMP script files for domain {domainId}.
        slots:
          domainId: path.domainId
      - text: Grab the script folder blob for published domain {domainId} from the CMP path.
        slots:
          domainId: path.domainId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/script-integration/{domainId}/downloadscriptv2'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a domain's script files (integration)
      effect: read
      questions:
      - Is there a script-integration endpoint for downloading script files locally?
      - Can I pull script files through the downloadscriptv2 route?
      instructions:
      - text: Download script files for domain {domainId} via the script-integration endpoint.
        slots:
          domainId: path.domainId
      - text: Save domain {domainId}'s scripts locally using downloadscriptv2.
        slots:
          domainId: path.domainId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/websites/scripts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website's script (v2)
      effect: read
      questions:
      - Can I fetch a site's cookie script from the v2 websites endpoint?
      - What script does the v2 websites lookup return?
      instructions:
      - text: Get the v2 website script for {website}.
        slots:
          website: query.website
      - text: Fetch the {scriptType} script for {website} from the v2 websites path.
        slots:
          scriptType: query.scriptType
          website: query.website
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/websites/publish'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish cookie script to a website (v2)
      effect: write
      questions:
      - Can I publish a website's cookie script through the v2 websites endpoint?
      - Does the v2 publish let me suppress the banner or preference center?
      instructions:
      - text: Publish the cookie script to {website} via the v2 websites endpoint.
        slots:
          website: query.website
      - text: Publish v2 script to {website} for languages {languages} with reconsent {requireReconsent}.
        slots:
          website: query.website
          languages: requestBody.languages
          requireReconsent: requestBody.requireReconsent
      method: generated
      generated: '2026-09-26'