OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Use Governance - Data Catalog Catalog Search V1 API

3 actions 3 updates phrasing extends openapi/onetrust-catalog-search-v1-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/data-governance/v1/catalog/search'].post

$.paths['/api/data-governance/v1/field-details'].get

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 Catalog Search V1 API
  version: 1.0.0
extends: openapi/onetrust-catalog-search-v1-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/data-governance/v1/catalog/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the data catalog
      effect: read
      questions:
      - Which data assets in the catalog mention customer email?
      - Can I run a partial-match catalog search and get facets back?
      instructions:
      - text: Search the data catalog for {searchText}.
        slots:
          searchText: requestBody.searchText
      - text: Search catalog assets for {searchText} filtered by {filterCriteria}.
        slots:
          searchText: requestBody.searchText
          filterCriteria: requestBody.filterCriteria
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/v1/field-details'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog search fields
      effect: read
      questions:
      - What fields can I search or filter on in the data catalog?
      - Which operators does each catalog search field support?
      instructions:
      - text: List the catalog search fields.
      - text: Show search field names, data types and operators.
      method: generated
      generated: '2026-09-26'