Confluent · OpenAPI Overlay 1.0.0

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

11 actions 11 updates phrasing extends openapi/confluent-types-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 11

$.info
$.paths['/catalog/v1/types/businessmetadatadefs'].get
$.paths['/catalog/v1/types/businessmetadatadefs'].put
$.paths['/catalog/v1/types/businessmetadatadefs'].post
$.paths['/catalog/v1/types/businessmetadatadefs/{bmName}'].get
$.paths['/catalog/v1/types/businessmetadatadefs/{bmName}'].delete
$.paths['/catalog/v1/types/tagdefs'].get
$.paths['/catalog/v1/types/tagdefs'].put
$.paths['/catalog/v1/types/tagdefs'].post
$.paths['/catalog/v1/types/tagdefs/{tagName}'].get
$.paths['/catalog/v1/types/tagdefs/{tagName}'].delete

OpenAPI Overlay

Raw ↑ 
# 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 Types (v1) API
  version: 1.0.0
extends: openapi/confluent-types-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: 10
- target: $.paths['/catalog/v1/types/businessmetadatadefs'].get
  update:
    x-apievangelist-phrasing:
      intent: List business metadata definitions
      effect: read
      questions:
      - What business metadata definitions exist in my Stream Catalog?
      - Can I filter business metadata definitions by a name prefix?
      instructions:
      - text: List all business metadata definitions.
      - text: List business metadata definitions whose names start with {prefix}.
        slots:
          prefix: query.prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/businessmetadatadefs'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update business metadata definitions
      effect: write
      questions:
      - Can I edit several business metadata definitions in one request?
      - How do I change the attributes on existing business metadata definitions?
      instructions:
      - text: Bulk update my existing business metadata definitions.
      - text: Push these edits to the business metadata definitions in the catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/businessmetadatadefs'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create business metadata definitions
      effect: write
      questions:
      - How do I define new business metadata like owner or team for catalog entities?
      - Can I create multiple business metadata definitions at once?
      instructions:
      - text: Create these new business metadata definitions in the catalog.
      - text: Bulk add new business metadata definitions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/businessmetadatadefs/{bmName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business metadata definition
      effect: read
      questions:
      - What attributes does a specific business metadata definition have?
      - Where can I look up one business metadata definition by its name?
      instructions:
      - text: Get the business metadata definition {bmName}.
        slots:
          bmName: path.bmName
      - text: Show the attributes of business metadata {bmName}.
        slots:
          bmName: path.bmName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/businessmetadatadefs/{bmName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a business metadata definition
      effect: destructive
      questions:
      - Can I remove a business metadata definition I no longer use?
      - What call deletes one business metadata definition by name?
      instructions:
      - text: Delete the business metadata definition {bmName}.
        slots:
          bmName: path.bmName
      - text: Remove business metadata {bmName} from the catalog.
        slots:
          bmName: path.bmName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/tagdefs'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag definitions
      effect: read
      questions:
      - Which tag definitions like PII or sensitive exist in my catalog?
      - Can I list only the tag definitions that start with a given prefix?
      instructions:
      - text: List all tag definitions.
      - text: List tag definitions whose names begin with {prefix}.
        slots:
          prefix: query.prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/tagdefs'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update tag definitions
      effect: write
      questions:
      - Can I update several catalog tag definitions in one call?
      - How do I change the description of existing tag definitions?
      instructions:
      - text: Bulk update my existing tag definitions.
      - text: Push these edits to the catalog's tag definitions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/tagdefs'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create tag definitions
      effect: write
      questions:
      - How do I create a new tag like PII to label schemas and topics?
      - Can I define several new tags at once?
      instructions:
      - text: Create these new tag definitions in the catalog.
      - text: Bulk add new tag definitions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/tagdefs/{tagName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag definition
      effect: read
      questions:
      - What does a particular tag definition contain?
      - Where do I read one tag definition by name?
      instructions:
      - text: Get the tag definition {tagName}.
        slots:
          tagName: path.tagName
      - text: Show me the details of tag {tagName}.
        slots:
          tagName: path.tagName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/tagdefs/{tagName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag definition
      effect: destructive
      questions:
      - Can I delete a tag definition from the catalog?
      - What removes one tag definition by its name?
      instructions:
      - text: Delete the tag definition {tagName}.
        slots:
          tagName: path.tagName
      - text: Remove tag {tagName} from the catalog.
        slots:
          tagName: path.tagName
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/confluent-types-v1-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.