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

# 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-the-data-streaming-platform-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:
      - Which 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: Update business metadata definitions in bulk
      effect: write
      questions:
      - How do I change several existing business metadata definitions at once?
      - Can I bulk-edit the attributes on my business metadata definitions?
      instructions:
      - text: Bulk update my existing business metadata definitions.
      - text: Apply these changes to the business metadata definitions already in the catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/businessmetadatadefs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create business metadata definitions in bulk
      effect: write
      questions:
      - How do I define new business metadata to attach to topics and schemas?
      - Can I create several business metadata definitions in one request?
      instructions:
      - text: Create these new business metadata definitions in the catalog.
      - text: Bulk create business metadata definitions for owner and team attributes.
      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 particular business metadata definition have?
      - Can I look up one business metadata definition by its name?
      instructions:
      - text: Get 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:
      - How do I remove a business metadata definition I no longer use?
      - Can I delete one business metadata definition by name?
      instructions:
      - text: Delete business metadata definition {bmName}.
        slots:
          bmName: path.bmName
      - text: Remove the {bmName} business metadata definition 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 are available in the Stream Catalog?
      - Can I list tag definitions that start with a certain prefix?
      instructions:
      - text: List all tag definitions.
      - text: List tag definitions with names starting {prefix}.
        slots:
          prefix: query.prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/tagdefs'].put
  update:
    x-apievangelist-phrasing:
      intent: Update tag definitions in bulk
      effect: write
      questions:
      - How do I edit several existing tag definitions at once?
      - Can I change the description of tag definitions I already created?
      instructions:
      - text: Bulk update my existing tag definitions.
      - text: Apply these edits to tag definitions already in the catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/types/tagdefs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create tag definitions in bulk
      effect: write
      questions:
      - How do I create a new tag like Sensitive to label topics and schemas?
      - Can I define multiple catalog tags in one request?
      instructions:
      - text: Create these new tag definitions in the catalog.
      - text: Bulk create tag definitions for PII and Sensitive.
      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 specific tag definition contain?
      - Can I look up one catalog tag definition by name?
      instructions:
      - text: Get tag definition {tagName}.
        slots:
          tagName: path.tagName
      - text: Show the details of the {tagName} tag definition.
        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:
      - How do I remove a tag definition from the Stream Catalog?
      - Can I delete an unused catalog tag by name?
      instructions:
      - text: Delete tag definition {tagName}.
        slots:
          tagName: path.tagName
      - text: Remove the {tagName} tag definition from the catalog.
        slots:
          tagName: path.tagName
      method: generated
      generated: '2026-09-26'