Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Offsets (connect/v1) API

4 actions 4 updates phrasing extends openapi/confluent-offsets-connect-v1-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets'].get

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request'].post

$.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status'].get

OpenAPI Overlay

# 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 Offsets (connect/v1) API
  version: 1.0.0
extends: openapi/confluent-offsets-connect-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: 3
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connector's current offsets
      effect: read
      questions:
      - Where in the source system is my connector currently reading from?
      - Can I see the latest committed offsets for a managed connector?
      instructions:
      - text: Get the offsets of connector {connector_name} in {environment_id}, cluster {kafka_cluster_id}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      - text: Show current source positions for connector {connector_name} on {kafka_cluster_id}, environment {environment_id}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request'].post
  update:
    x-apievangelist-phrasing:
      intent: Change or reset a connector's offsets
      effect: write
      questions:
      - How do I rewind a connector to reprocess data from an earlier offset?
      - Can I delete a connector's offsets so it starts over, and will it cause downtime?
      instructions:
      - text: Alter offsets of connector {connector_name} in {environment_id}/{kafka_cluster_id} with type {type} to {offsets}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          type: requestBody.type
          offsets: requestBody.offsets
      - text: Reset connector {connector_name} offsets on {kafka_cluster_id} in {environment_id} using operation {type}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check status of an offset change request
      effect: read
      questions:
      - Did my request to alter a connector's offsets finish successfully?
      - Is the previous offset reset on my connector still in progress?
      instructions:
      - text: Get the status of the last offset alter request for connector {connector_name} in {environment_id}, cluster {kafka_cluster_id}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      - text: Check whether connector {connector_name}'s offset change completed on {kafka_cluster_id}, environment {environment_id}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'