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-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'