API Evangelist conversational phrasing for Confluent Cloud Entity (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 Entity (v1) API
  version: 1.0.0
extends: openapi/confluent-entity-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/entity/businessmetadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update business metadata on entities
      effect: write
      questions:
      - Can I change business metadata values on many catalog entities in one call?
      - Is there a bulk way to edit business metadata already attached to my topics?
      instructions:
      - text: Update the business metadata already attached to these catalog entities in bulk.
      - text: Bulk edit existing business metadata values across my Stream Catalog entities.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/businessmetadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk attach business metadata to entities
      effect: write
      questions:
      - How do I attach business metadata to several topics or schemas at once?
      - Can I add new business metadata to many Stream Catalog entities in a single request?
      instructions:
      - text: Attach new business metadata to these catalog entities in bulk.
      - text: Bulk create business metadata on my topics and schemas.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Read business metadata on an entity
      effect: read
      questions:
      - What business metadata is attached to a particular topic in the catalog?
      - Can I list the business metadata for one entity by its qualified name?
      instructions:
      - text: Show the business metadata on the {typeName} entity {qualifiedName}.
        slots:
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: List business metadata attached to {qualifiedName} of type {typeName}.
        slots:
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove business metadata from an entity
      effect: destructive
      questions:
      - Can I detach a single business metadata from one catalog entity?
      - How do I remove business metadata I added to a topic by mistake?
      instructions:
      - text: Remove business metadata {bmName} from the {typeName} entity {qualifiedName}.
        slots:
          bmName: path.bmName
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: Delete the {bmName} business metadata on {qualifiedName} ({typeName}).
        slots:
          bmName: path.bmName
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/tags'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update tags on entities
      effect: write
      questions:
      - Can I update tags that are already applied to many entities in one go?
      - Is there a bulk endpoint to edit existing tag attributes on catalog entities?
      instructions:
      - text: Update the existing tags on these catalog entities in bulk.
      - text: Bulk edit tag assignments already applied across my entities.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk tag entities
      effect: write
      questions:
      - How do I tag many topics or schemas with a classification at once?
      - Can I apply new tags to several Stream Catalog entities in one request?
      instructions:
      - text: Tag these catalog entities in bulk.
      - text: Bulk apply new tags to my topics and schemas.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/type/{typeName}/name/{qualifiedName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a catalog entity
      effect: read
      questions:
      - What is the full catalog definition of a topic or schema entity?
      - Can I fetch an entity without its relationships to keep the response small?
      instructions:
      - text: Get the catalog entity {qualifiedName} of type {typeName}.
        slots:
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: 'Read {typeName} entity {qualifiedName} ignoring relationships: {ignoreRelationships}.'
        slots:
          typeName: path.typeName
          qualifiedName: path.qualifiedName
          ignoreRelationships: query.ignoreRelationships
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags on an entity
      effect: read
      questions:
      - Which tags are applied to a specific topic in the catalog?
      - Can I see the tags on one entity by its qualified name?
      instructions:
      - text: List the tags on the {typeName} entity {qualifiedName}.
        slots:
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: Show me which tags {qualifiedName} ({typeName}) carries.
        slots:
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one attribute of a catalog entity
      effect: write
      questions:
      - Can I change a single attribute of a catalog entity, like its description?
      - Is there a way to partially update an entity without resending the whole definition?
      instructions:
      - text: Update an attribute on catalog entity {entity}.
        slots:
          entity: requestBody.entity
      - text: Partially update the entity {entity} in Stream Catalog.
        slots:
          entity: requestBody.entity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from an entity
      effect: destructive
      questions:
      - How do I untag a topic in the Stream Catalog?
      - Can I remove one specific tag from an entity while keeping the others?
      instructions:
      - text: Remove tag {tagName} from the {typeName} entity {qualifiedName}.
        slots:
          tagName: path.tagName
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: Untag {qualifiedName} ({typeName}) from {tagName}.
        slots:
          tagName: path.tagName
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      method: generated
      generated: '2026-09-26'