# 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-the-data-streaming-platform-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 at once?
      - Is there a bulk way to edit business metadata already attached to topics?
      instructions:
      - text: Update the business metadata already applied to these entities in one bulk call.
      - text: Bulk edit the existing business metadata attribute values on my 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 in one request?
      - Can I add business metadata to many Stream Catalog entities in bulk?
      instructions:
      - text: Attach business metadata to these catalog entities in one bulk request.
      - text: Bulk add new business metadata to several topics at once.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List business metadata on an entity
      effect: read
      questions:
      - What business metadata is attached to a particular topic or schema?
      - Can I read the business metadata for a single catalog entity?
      instructions:
      - text: Show the business metadata on {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:
      - How do I detach one business metadata from a topic in the catalog?
      - Can I remove a specific business metadata from a single entity?
      instructions:
      - text: Remove business metadata {bmName} from {typeName} entity {qualifiedName}.
        slots:
          bmName: path.bmName
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: Detach {bmName} from entity {qualifiedName} of type {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 change the attributes of tags already applied to many entities?
      - Is there a bulk way to edit existing tag assignments in the catalog?
      instructions:
      - text: Update the tags already applied to these entities in one bulk call.
      - text: Bulk edit existing tag attributes across my catalog 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 several topics as PII in one request?
      - Can I apply tags to many Stream Catalog entities at once?
      instructions:
      - text: Apply these tags to several catalog entities in one bulk request.
      - text: Bulk tag my topics and schemas with new tags.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/catalog/v1/entity/type/{typeName}/name/{qualifiedName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog entity
      effect: read
      questions:
      - Can I fetch the full catalog definition of a topic by its qualified name?
      - Is there a way to read an entity without pulling in its relationships?
      instructions:
      - text: Get the {typeName} entity {qualifiedName} from the catalog.
        slots:
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: Show entity {qualifiedName} of type {typeName} while 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 attached to a particular topic?
      - Can I see all the tags on one catalog entity?
      instructions:
      - text: List the tags on {typeName} entity {qualifiedName}.
        slots:
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: Show which tags are applied to {qualifiedName} of type {typeName}.
        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 an entity attribute
      effect: write
      questions:
      - Can I change a single attribute of a catalog entity, like a topic's description?
      - Is partial updating of an entity's attributes supported?
      instructions:
      - text: Update this attribute on catalog entity {entity}.
        slots:
          entity: requestBody.entity
      - text: Partially update entity {entity} with a new attribute value.
        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 catalog?
      - Can I remove one tag from a single entity without touching others?
      instructions:
      - text: Remove tag {tagName} from {typeName} entity {qualifiedName}.
        slots:
          tagName: path.tagName
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      - text: Untag {qualifiedName} of type {typeName} by deleting {tagName}.
        slots:
          tagName: path.tagName
          typeName: path.typeName
          qualifiedName: path.qualifiedName
      method: generated
      generated: '2026-09-26'