# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Onetrust Cookies API
  version: 1.0.0
extends: openapi/onetrust-cookies-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/cmp/v1/cookies/categorized'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up categorized cookies for a domain
      effect: read
      questions:
      - What category has each cookie on my domain been assigned?
      - Can I check the categorization of specific cookie IDs on a domain?
      instructions:
      - text: Show the categorized cookies for domain {domain}.
        slots:
          domain: requestBody.domain
      - text: Get categories for cookies {cookieIds} on {domain}.
        slots:
          cookieIds: requestBody.cookieIds
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/cookies'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit scanned cookies in bulk
      effect: write
      questions:
      - How do I edit many existing web scan cookies at once?
      - Can I bulk-update cookies found by my website scans?
      instructions:
      - text: Bulk edit the existing web scan cookies.
      - text: Apply my changes to several scanned cookies in one request.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/cookies'].post
  update:
    x-apievangelist-phrasing:
      intent: Add cookies to web scans in bulk
      effect: write
      questions:
      - How do I add a batch of cookies to my web scan results?
      - Can I add cookies the scanner missed?
      instructions:
      - text: Bulk add these cookies to my web scan results.
      - text: Add a batch of new cookies to the scanned cookie list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/cookies'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete scanned cookies by ID or filter
      effect: destructive
      questions:
      - How do I delete scanned cookies in bulk?
      - Can I delete cookies that match filter criteria instead of listing IDs?
      instructions:
      - text: Delete scanned cookies {cookieIds}.
        slots:
          cookieIds: requestBody.cookieIds
      - text: Delete every scanned cookie matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Remove all scanned cookies named {cookieName}.
        slots:
          cookieName: requestBody.cookieName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/languages/{language}/cookies/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter scanned cookies in a given language
      effect: read
      questions:
      - Which scanned cookies are third-party or long-lived in a given language view?
      - Can I filter web scan cookies by category, lifespan and domain?
      instructions:
      - text: Filter web scan cookies in language {language} by categories {categories}.
        slots:
          language: path.language
          categories: requestBody.categories
      - text: Find scanned cookies in {language} for domains {domains} with lifespan {lifespan}.
        slots:
          language: path.language
          domains: requestBody.domains
          lifespan: requestBody.lifespan
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/webscans/{scanId}/recategorize'].put
  update:
    x-apievangelist-phrasing:
      intent: Recategorize the cookies from a scan
      effect: write
      questions:
      - How do I rerun cookie categorization for a completed website scan?
      - Can I trigger recategorization of cookies for one scan?
      instructions:
      - text: Recategorize the cookies from scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Start cookie recategorization for web scan {scanId}.
        slots:
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/cookies'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a single cookie's details
      effect: write
      questions:
      - How do I change the description or category of a single cookie by its cookie ID?
      - Where do I find the cookie ID needed to update a cookie?
      instructions:
      - text: Update cookie {cookieId} with description {description}.
        slots:
          cookieId: requestBody.cookieId
          description: requestBody.description
      - text: Move cookie {cookieId} to custom category {customCategoryName}.
        slots:
          cookieId: requestBody.cookieId
          customCategoryName: requestBody.customCategoryName
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v1/cookies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a single new cookie
      effect: write
      questions:
      - How do I create one cookie with its host, lifespan and category?
      - What do I need to supply to define a new cookie by hand?
      instructions:
      - text: Create cookie {cookieName} on host {host} in category {customCategoryName}.
        slots:
          cookieName: requestBody.cookieName
          host: requestBody.host
          customCategoryName: requestBody.customCategoryName
      - text: Define a {lifespan} cookie {cookieName} for {host} with duration type {durationType} in {customCategoryName}.
        slots:
          lifespan: requestBody.lifespan
          cookieName: requestBody.cookieName
          host: requestBody.host
          durationType: requestBody.durationType
          customCategoryName: requestBody.customCategoryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/cookie-reports/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the cookie report across domains
      effect: read
      questions:
      - Can I search the cookie report for a cookie name across all my domains?
      - What cookies appear in the cookie report for a specific domain list?
      instructions:
      - text: Search the cookie report for {searchStr}.
        slots:
          searchStr: query.searchStr
      - text: Search the cookie report for domains {domains}, returning category names in language {language}.
        slots:
          domains: requestBody.domains
          language: query.language
      method: generated
      generated: '2026-10-02'