API Evangelist conversational phrasing for Confluent Cloud Exporters (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 Exporters (v1) API
  version: 1.0.0
extends: openapi/confluent-exporters-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: 11
- target: $.paths['/exporters'].get
  update:
    x-apievangelist-phrasing:
      intent: List schema exporters
      effect: read
      questions:
      - Which schema exporters have been set up in my Schema Registry?
      - Can I see every schema exporter that has been created so far?
      instructions:
      - text: List all my schema exporters.
      - text: Show me the names of every schema exporter in Schema Registry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a schema exporter
      effect: write
      questions:
      - How do I set up a new schema exporter to copy schemas to another cluster?
      - Can a new exporter rename subjects in the destination cluster with a format string?
      - What context types can I pick when creating a schema exporter?
      instructions:
      - text: Create a schema exporter named {name} for subjects {subjects}.
        slots:
          name: requestBody.name
          subjects: requestBody.subjects
      - text: Register a new exporter {name} with context type {contextType} and config {config}.
        slots:
          name: requestBody.name
          contextType: requestBody.contextType
          config: requestBody.config
      - text: Create exporter {name} that renames subjects using {subjectRenameFormat}.
        slots:
          name: requestBody.name
          subjectRenameFormat: requestBody.subjectRenameFormat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a schema exporter's details
      effect: read
      questions:
      - What subjects and context does a given schema exporter cover?
      - Can I look up the definition of one schema exporter by its name?
      instructions:
      - text: Show me the details of schema exporter {name}.
        slots:
          name: path.name
      - text: Get the subjects and context settings for exporter {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a schema exporter's settings
      effect: write
      questions:
      - Can I change which subjects an existing schema exporter copies?
      - Is it possible to switch an existing exporter's context type after creating it?
      instructions:
      - text: Update exporter {name} to export subjects {subjects}.
        slots:
          name: path.name
          subjects: requestBody.subjects
      - text: Change the context type of exporter {name} to {contextType}.
        slots:
          name: path.name
          contextType: requestBody.contextType
      - text: Set the KEK rename format of exporter {name} to {kekRenameFormat}.
        slots:
          name: path.name
          kekRenameFormat: requestBody.kekRenameFormat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a schema exporter
      effect: destructive
      questions:
      - How do I remove a schema exporter I no longer need?
      - Can I delete a schema exporter by name?
      instructions:
      - text: Delete schema exporter {name}.
        slots:
          name: path.name
      - text: Remove the exporter called {name} from Schema Registry.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a schema exporter's status
      effect: read
      questions:
      - Is my schema exporter currently running, paused or in an error state?
      - Where can I see the current state of a schema exporter?
      instructions:
      - text: Check the status of schema exporter {name}.
        slots:
          name: path.name
      - text: Tell me whether exporter {name} is running.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a schema exporter's config
      effect: read
      questions:
      - What destination Schema Registry URL is a given exporter configured with?
      - Can I read back just the configuration map of a schema exporter?
      instructions:
      - text: Show the configuration of exporter {name}.
        slots:
          name: path.name
      - text: Get the destination registry config for schema exporter {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a schema exporter's config
      effect: write
      questions:
      - Can I point an existing exporter at a different destination Schema Registry URL?
      - How can I rotate the basic auth credentials an exporter uses for its destination?
      instructions:
      - text: Point exporter {name} at destination registry {url}.
        slots:
          name: path.name
          url: requestBody.schema.registry.url
      - text: Update the basic auth user info of exporter {name} to {userinfo}.
        slots:
          name: path.name
          userinfo: requestBody.basic.auth.user.info
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}/pause'].put
  update:
    x-apievangelist-phrasing:
      intent: Pause a schema exporter
      effect: write
      questions:
      - Can I temporarily stop a schema exporter from copying schemas?
      - What happens to an exporter's state when I pause it?
      instructions:
      - text: Pause schema exporter {name}.
        slots:
          name: path.name
      - text: Stop exporter {name} from exporting for now.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}/reset'].put
  update:
    x-apievangelist-phrasing:
      intent: Reset a schema exporter's state
      effect: destructive
      questions:
      - Can I reset a schema exporter so it starts over from scratch?
      - Is there a way to clear the export progress of a stuck exporter?
      instructions:
      - text: Reset the state of schema exporter {name}.
        slots:
          name: path.name
      - text: Clear the export progress for exporter {name} and start it over.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exporters/{name}/resume'].put
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused schema exporter
      effect: write
      questions:
      - How do I restart a schema exporter that I paused earlier?
      - Can a paused exporter pick up running again?
      instructions:
      - text: Resume schema exporter {name}.
        slots:
          name: path.name
      - text: Start exporter {name} running again after the pause.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'