OneTrust · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/onetrust-tags-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/glossary/v1/tag-names'].get

$.paths['/api/glossary/v1/tags/{name}/details'].get

$.paths['/api/glossary/v2/tags'].post

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 Data Use Governance - Data Catalog Tags API
  version: 1.0.0
extends: openapi/onetrust-tags-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/glossary/v1/tag-names'].get
  update:
    x-apievangelist-phrasing:
      intent: List glossary tag names
      effect: read
      questions:
      - What tags exist in the data governance glossary?
      - Can I list only tags of a certain type, like CATEGORY?
      instructions:
      - text: List all glossary tag names.
      - text: List tag names of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/glossary/v1/tags/{name}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary tag
      effect: read
      questions:
      - What terms are associated with a particular tag?
      - How do I see the details of one glossary tag by name?
      instructions:
      - text: Show tag {name}.
        slots:
          name: path.name
      - text: Get the details and linked terms for tag {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/glossary/v2/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a glossary tag
      effect: write
      questions:
      - How do I add a new tag to the glossary?
      - Is the tag type case-sensitive when creating a tag?
      instructions:
      - text: Create a tag named {name}.
        slots:
          name: requestBody.name
      - text: Create tag {name} of type {type} described as {description}.
        slots:
          name: requestBody.name
          type: requestBody.type
          description: requestBody.description
      method: generated
      generated: '2026-09-26'