Confluent · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/confluent-search-v1-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent 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-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 catalog entities whose attribute value starts with a prefix?
      - Which topics have an owner attribute beginning with a given name?
      instructions:
      - text: Search entities where {attrName} starts with {attrValuePrefix}.
        slots:
          attrName: query.attrName
          attrValuePrefix: query.attrValuePrefix
      - text: Find {type} entities with attribute {attrName} beginning {attrValuePrefix}.
        slots:
          type: query.type
          attrName: query.attrName
          attrValuePrefix: query.attrValuePrefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/search/basic'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the catalog by full text
      effect: read
      questions:
      - How do I search the Stream Catalog with a free-text query?
      - Can I limit a full-text catalog search to entities with a certain tag?
      instructions:
      - text: Search the catalog for {query}.
        slots:
          query: query.query
      - text: Full-text search for {query} among entities tagged {tag}.
        slots:
          query: query.query
          tag: query.tag
      method: generated
      generated: '2026-09-26'