OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & Preferences - Cookie Consent (Swagger) Websites…

3 actions 3 updates phrasing extends openapi/onetrust-websites-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 3

$.info
$.paths['/v2/websites'].get
$.paths['/v2/websites'].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 Consent & Preferences - Cookie Consent (Swagger) Websites…
  version: 1.0.0
extends: openapi/onetrust-websites-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: 2
- target: $.paths['/v2/websites'].get
  update:
    x-apievangelist-phrasing:
      intent: List scanned websites
      effect: read
      questions:
      - Which websites are in the scanner and when were they last scanned?
      - Can I search websites in the scanner by name?
      instructions:
      - text: List all websites in the scanner.
      - text: Find scanner websites matching {searchStr}.
        slots:
          searchStr: query.searchStr
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/websites'].post
  update:
    x-apievangelist-phrasing:
      intent: Add websites to the scanner
      effect: write
      questions:
      - Can I add several websites to be scanned at once?
      - Do I need an organization to add a website for scanning?
      instructions:
      - text: Add websites to the scanner for organization {externalOrgId}.
        slots:
          externalOrgId: query.externalOrgId
      - text: Queue new sites for scanning under org {externalOrgId}.
        slots:
          externalOrgId: query.externalOrgId
      method: generated
      generated: '2026-09-26'