{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/confluent/main/json-schema/confluent-connect-v1-connector-with-offsets-schema.json",
  "title": "connect.v1.ConnectorWithOffsets",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/confluent-connectors-connect-v1-api-openapi.yml#/components/schemas/connect.v1.ConnectorWithOffsets",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the connector"
    },
    "config": {
      "type": "object",
      "description": "Configuration parameters for the connector. These configurations\nare the minimum set of key-value pairs which can be used to\ndefine how the connector connects Kafka to the external system.\nSome of these key-value pairs are common to all the connectors, such as\nconnection parameters to Kafka, connector metadata, etc. The list\nof common connector configurations is as follows\n- cloud.environment\n- cloud.provider\n- connector.class\n- kafka.api.key\n- kafka.api.secret\n- kafka.endpoint\n- kafka.region\n- name\nA specific connector such as `GcsSink` would have additional\nparameters such as `gcs.bucket.name`, `flush.size`, etc.",
      "required": [
        "cloud.environment",
        "cloud.provider",
        "connector.class",
        "name",
        "kafka.endpoint",
        "kafka.region",
        "kafka.api.key",
        "kafka.api.secret"
      ],
      "properties": {
        "cloud.environment": {
          "type": "string",
          "description": "The cloud environment type."
        },
        "cloud.provider": {
          "type": "string",
          "description": "The cloud service provider, e.g. aws, azure, etc.",
          "x-extensible-enum": [
            "aws",
            "azure",
            "gcp"
          ]
        },
        "connector.class": {
          "type": "string",
          "description": "The connector class name. E.g. BigQuerySink, GcsSink, etc."
        },
        "name": {
          "type": "string",
          "description": "Name or alias of the class (plugin) for this connector."
        },
        "kafka.endpoint": {
          "type": "string",
          "description": "The Kafka cluster endpoint."
        },
        "kafka.region": {
          "type": "string",
          "description": "The Kafka cluster region."
        },
        "kafka.api.key": {
          "type": "string",
          "description": "The Kafka cluster API key."
        },
        "kafka.api.secret": {
          "type": "string",
          "description": "The Kafka cluster API secret.",
          "x-redact": true
        }
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "tasks": {
      "type": "array",
      "description": "List of active tasks generated by the connector",
      "items": {
        "type": "object",
        "properties": {
          "connector": {
            "type": "string",
            "description": "The name of the connector the task belongs to"
          },
          "task": {
            "type": "integer",
            "description": "Task ID within the connector"
          }
        },
        "required": [
          "connector",
          "task"
        ]
      }
    },
    "type": {
      "type": "string",
      "description": "Type of connector, sink or source",
      "enum": [
        "sink",
        "source"
      ]
    },
    "offsets": {
      "$ref": "#/$defs/connect.v1.Offsets"
    }
  },
  "required": [
    "name",
    "config"
  ],
  "$defs": {
    "connect.v1.Offsets": {
      "type": "array",
      "description": "Array of offsets which are categorised into partitions.",
      "items": {
        "type": "object",
        "properties": {
          "partition": {
            "type": "object",
            "additionalProperties": true,
            "description": "The partition information. For sink connectors this is the kafka topic and \npartition. For source connectors this is depends on the partitions defined by the \nsource connector. For example, the table which this task is pulling data from in a\nJDBC based MySQL source connector.\nPlease refer to the [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) for \nmore information."
          },
          "offset": {
            "type": "object",
            "additionalProperties": true,
            "description": "The offset of the partition. For sink connectors this is the kafka offset. For \nsource connectors this is depends on the offset defined by the source connector. \nFor example, the timestamp and incrementing column info in a table, for a JDBC based \nMySQL source connector.\nPlease refer to the [documentation](https://docs.confluent.io/cloud/current/connectors/offsets.html#manage-offsets-for-fully-managed-connectors-in-ccloud) for \nmore information."
          }
        }
      }
    }
  }
}