Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluent-the-data-streaming-platform-offsets-connect-v1-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform 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

Raw ↑ 
# 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-the-data-streaming-platform-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 a managed connector's current offsets?
      instructions:
      - text: Show the offsets of connector {connector_name} on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      - text: Get current offsets for {connector_name}.
        slots:
          connector_name: path.connector_name
      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: Alter or reset a connector's offsets
      effect: write
      questions:
      - How do I reset or change the offsets of a connector?
      - Will altering connector offsets cause any downtime?
      instructions:
      - text: Submit a {type} offsets request for connector {connector_name} on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          type: requestBody.type
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      - text: Set the offsets of connector {connector_name} to {offsets}.
        slots:
          connector_name: path.connector_name
          offsets: requestBody.offsets
      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 an offset change request's status
      effect: read
      questions:
      - Did my last request to alter connector offsets finish?
      - Can I check the status of a pending offset reset?
      instructions:
      - text: Show the status of the last offset alter request for {connector_name} on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      - text: Check whether the offset change for {connector_name} completed.
        slots:
          connector_name: path.connector_name
      method: generated
      generated: '2026-09-26'