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

# 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 Terms API
  version: 1.0.0
extends: openapi/onetrust-terms-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: 6
- target: $.paths['/api/glossary/v1/terms'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search glossary terms
      effect: read
      questions:
      - Which terms are in my business glossary?
      - Can I search glossary terms by name and see which glossary each is in?
      instructions:
      - text: List all glossary terms.
      - text: Search terms named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/glossary/v1/terms/attribute-details/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a term attribute
      effect: read
      questions:
      - What are the details of a specific term attribute?
      - Can I look up a term attribute by its name?
      instructions:
      - text: Get the term attribute {name}.
        slots:
          name: path.name
      - text: Show details for term attribute {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/glossary/v1/terms/attribute-names'].get
  update:
    x-apievangelist-phrasing:
      intent: List term attributes
      effect: read
      questions:
      - Which term attributes have internal and external systems created?
      - What custom attributes can a glossary term have?
      instructions:
      - text: List all term attributes.
      - text: Show every attribute name defined for terms.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/glossary/v1/terms/name/{termName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary term by name
      effect: read
      questions:
      - What's the description and type of a specific glossary term?
      - Which tags are attached to a term?
      instructions:
      - text: Get the term {termName}.
        slots:
          termName: path.termName
      - text: Show description and tags of term {termName}.
        slots:
          termName: path.termName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/glossary/v1/terms/names'].get
  update:
    x-apievangelist-phrasing:
      intent: List glossary term names
      effect: read
      questions:
      - Can I get just the names of all glossary terms?
      - Is there a compact list of term names?
      instructions:
      - text: List all term names.
      - text: Give me only the names of glossary terms.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/glossary/v2/terms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a glossary term
      effect: write
      questions:
      - How do I add a new term to a glossary?
      - Can a new term be created as already approved?
      instructions:
      - text: Create term {name} of type {type} in glossary {glossaryName}.
        slots:
          name: requestBody.name
          type: requestBody.type
          glossaryName: requestBody.glossaryName
      - text: Add approved term {name} ({type}) to glossary {glossaryName} with description {shortDescription}.
        slots:
          name: requestBody.name
          type: requestBody.type
          glossaryName: requestBody.glossaryName
          shortDescription: requestBody.shortDescription
      method: generated
      generated: '2026-09-26'