OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Use Governance - Data Catalog Glossaries API

3 actions 3 updates phrasing extends openapi/onetrust-glossaries-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['/api/glossary/v1/glossaries/all/names'].get
$.paths['/api/glossary/v1/glossaries/name/{glossaryName}'].get

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 Data Use Governance - Data Catalog Glossaries API
  version: 1.0.0
extends: openapi/onetrust-glossaries-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['/api/glossary/v1/glossaries/all/names'].get
  update:
    x-apievangelist-phrasing:
      intent: List business glossaries
      effect: read
      questions:
      - Which business glossaries are defined?
      - Can I get the names of all glossaries?
      instructions:
      - text: List all business glossaries.
      - text: Show every glossary name.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/glossary/v1/glossaries/name/{glossaryName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business glossary by name
      effect: read
      questions:
      - Can I look up a glossary by its name?
      - When was a particular business glossary created?
      instructions:
      - text: Get glossary {glossaryName}.
        slots:
          glossaryName: path.glossaryName
      - text: Show the description of the {glossaryName} glossary.
        slots:
          glossaryName: path.glossaryName
      method: generated
      generated: '2026-09-26'