Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Search (v1) API

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-search-v1-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/catalog/v1/search/attribute'].get

$.paths['/catalog/v1/search/basic'].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 Confluent Cloud Search (v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-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['/catalog/v1/search/attribute'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the catalog by attribute
      effect: read
      questions:
      - Can I find topics or schemas whose attribute matches a given value?
      - How do I search the Stream Catalog by an attribute name and value prefix?
      instructions:
      - text: Search for {type} entities where {attr} starts with {prefix}.
        slots:
          type: query.type
          attr: query.attrName
          prefix: query.attrValuePrefix
      - text: Find entities tagged {tag} by attribute.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/search/basic'].get
  update:
    x-apievangelist-phrasing:
      intent: Full-text search the Stream Catalog
      effect: read
      questions:
      - Can I do a free-text search across topics, schemas and connectors?
      - Is there a keyword search for my data catalog?
      instructions:
      - text: Search the catalog for {query}.
        slots:
          query: query.query
      - text: Full-text search {type} entities for {query}.
        slots:
          type: query.type
          query: query.query
      method: generated
      generated: '2026-09-26'