OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & Preferences - Cookie Consent Geolocation Rules API

4 actions 4 updates phrasing extends openapi/onetrust-geolocation-rules-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 4

$.info

$.paths['/api/cmp/v1/georulegroups'].get

$.paths['/api/cmp/v1/georulegroups/{geoRuleGroupId}'].get

$.paths['/api/cmp/v1/georulegroups/{geoRuleGroupId}/assign'].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 Consent & Preferences - Cookie Consent Geolocation Rules API
  version: 1.0.0
extends: openapi/onetrust-geolocation-rules-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: 3
- target: $.paths['/api/cmp/v1/georulegroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List geolocation rule groups
      effect: read
      questions:
      - Which geolocation rule groups are configured for cookie consent?
      - Can I search geolocation rule groups by name?
      instructions:
      - text: List geolocation rule groups.
      - text: Find geolocation rule groups named like {searchStr}.
        slots:
          searchStr: query.searchStr
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/georulegroups/{geoRuleGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a geolocation rule group's rules
      effect: read
      questions:
      - Which regions and consent models are in a geolocation rule group?
      - Can I see the cookie categories each geo rule applies?
      instructions:
      - text: Get geolocation rule group {geoRuleGroupId}.
        slots:
          geoRuleGroupId: path.geoRuleGroupId
      - text: Show the regions and consent models in rule group {geoRuleGroupId}.
        slots:
          geoRuleGroupId: path.geoRuleGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/georulegroups/{geoRuleGroupId}/assign'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign domains or apps to a geo rule group
      effect: write
      questions:
      - Can I assign several domains to a geolocation rule group at once?
      - Is it possible to unassign a mobile app from a geolocation rule group?
      instructions:
      - text: Assign domains {domainIds} to geolocation rule group {geoRuleGroupId}.
        slots:
          domainIds: requestBody.domainIds
          geoRuleGroupId: path.geoRuleGroupId
      - text: Set application assignments {applicationIds} on rule group {geoRuleGroupId}.
        slots:
          applicationIds: requestBody.applicationIds
          geoRuleGroupId: path.geoRuleGroupId
      method: generated
      generated: '2026-09-26'