API Evangelist conversational phrasing for Consent & Preferences - Cookie Consent Scans API

# 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 Scans API
  version: 1.0.0
extends: openapi/onetrust-scans-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/webscans'].get
  update:
    x-apievangelist-phrasing:
      intent: List websites in the cookie scanner
      effect: read
      questions:
      - Which websites are set up in the cookie scanner?
      - Can I search scanned websites by name for a child organization?
      instructions:
      - text: List websites in the scanner.
      - text: Find scanned websites matching {searchStr} for organization {externalOrgId}.
        slots:
          searchStr: query.searchStr
          externalOrgId: query.externalOrgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans'].post
  update:
    x-apievangelist-phrasing:
      intent: Start cookie scans for domains
      effect: write
      questions:
      - How do I kick off a cookie scan of my website?
      - Can I scan several domains at once for an organization?
      instructions:
      - text: Start scans for the given domains.
      - text: Scan websites for organization {externalOrgId}.
        slots:
          externalOrgId: query.externalOrgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive website scans
      effect: write
      questions:
      - Can I archive old cookie scans I no longer need?
      - Is there a way to move scans out of the active list?
      instructions:
      - text: Archive the specified scans.
      - text: Move these completed scans to the archive.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/domains/{domainId}/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List scans for a domain
      effect: read
      questions:
      - What scans have run on a particular domain?
      - Can I filter a domain's scans by status or date range?
      instructions:
      - text: List scans for domain {domainId}.
        slots:
          domainId: path.domainId
      - text: Show scans of domain {domainId} with status {status} between {startDate} and {endDate}.
        slots:
          domainId: path.domainId
          status: query.status
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/scandelta'].get
  update:
    x-apievangelist-phrasing:
      intent: List cookies added or removed since last scan
      effect: read
      questions:
      - Which cookies appeared or disappeared on my site since the previous scan?
      - Can I compare two consecutive cookie scans?
      instructions:
      - text: Show cookies added or removed in scan {scanId} of domain {domainId}.
        slots:
          scanId: path.scanId
          domainId: path.domainId
      - text: Compare scan {scanId} with the previous one for domain {domainId}.
        slots:
          scanId: path.scanId
          domainId: path.domainId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/scanresults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get detailed scan results
      effect: read
      questions:
      - What cookies, tags and forms did a scan find on my website?
      - Can I pull scan results for just one entity type, like forms?
      instructions:
      - text: Get {entityType} results for scan {scanId} on domain {domainId}.
        slots:
          entityType: query.entityType
          scanId: path.scanId
          domainId: path.domainId
      - text: List the {entityType} found by scan {scanId} of domain {domainId}, page {page}.
        slots:
          entityType: query.entityType
          scanId: path.scanId
          domainId: path.domainId
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan's summary counts
      effect: read
      questions:
      - How many cookies and tags did a scan find in total?
      - Is there a quick summary of a website scan's findings?
      instructions:
      - text: Summarize scan {scanId} for domain {domainId}.
        slots:
          scanId: path.scanId
          domainId: path.domainId
      - text: Give me the entity counts from scan {scanId} on domain {domainId}.
        slots:
          scanId: path.scanId
          domainId: path.domainId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check status of scans
      effect: read
      questions:
      - Are my website scans still running or finished?
      - Can I check several scans' statuses in one call?
      instructions:
      - text: Check the status of the specified scans.
      - text: Tell me whether these scans have completed.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/{scanId}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a website scan
      effect: destructive
      questions:
      - Can I stop a cookie scan that is in progress?
      - What happens if I cancel a running scan?
      instructions:
      - text: Cancel scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Stop the running website scan {scanId}.
        slots:
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'