bug/SaaS API Kafka Cloud Connector inconsistency

Open
#308 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
kafka, python
Domain
api

Research direction

Start with the POST /api/v1/sources/ reproduction and compare its singular and plural validation errors. Inspect src/unstructured_client/models/shared/kafkacloudsourceconnectorconfiginput.py and compare it with the linked Kafka source connector documentation; done means the accepted field name and validation behavior are consistent.

Written by the indexing model from the issue text.

Description

bug

Describe the bug

When attempting to create a Kafka Cloud source connector directly with the API, there appears to be no minimum viable configuration that can successfully create the connector because the server is inconsistent about the requirement for a bootstrap_server{,s} key.

First, attempting to create the connector with bootstrap_servers:

POST /api/v1/sources/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 168
Content-Type: application/json
Host: platform.unstructuredapp.io
User-Agent: HTTPie/3.2.4
unstructured-api-key: ******

{
    "config": {
        "bootstrap_servers": "https://example.com",
        "kafka_api_key": "foo",
        "secret": "foo",
        "topic": "foo"
    },
    "name": "test-kafka-connector",
    "type": "kafka-cloud"
}


HTTP/1.1 412 Precondition Failed
content-length: 71
content-type: application/json
date: Wed, 20 Aug 2025 20:22:42 GMT
server: istio-envoy
x-envoy-upstream-service-time: 50

{
    "errors": [
        {
            "field": "bootstrap_server",
            "message": "Field is required"
        }
    ]
}

The error message indicates that it should be bootstrap_server.

POST /api/v1/sources/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 167
Content-Type: application/json
Host: platform.unstructuredapp.io
User-Agent: HTTPie/3.2.4
unstructured-api-key: ******

{
    "config": {
        "bootstrap_server": "https://example.com",
        "kafka_api_key": "foo",
        "secret": "foo",
        "topic": "foo"
    },
    "name": "test-kafka-connector",
    "type": "kafka-cloud"
}


HTTP/1.1 422 Unprocessable Entity
content-length: 191
content-type: application/json
date: Wed, 20 Aug 2025 20:23:50 GMT
server: istio-envoy
x-envoy-upstream-service-time: 80

{
    "detail": [
        {
            "input": {
                "bootstrap_server": "https://example.com",
                "kafka_api_key": "foo",
                "secret": "foo",
                "topic": "foo"
            },
            "loc": [
                "body",
                "bootstrap_servers"
            ],
            "msg": "Field required",
            "type": "missing"
        }
    ]
}

Now the error message says that bootstrap_servers is missing.

To Reproduce

Using HTTPie:

$ http -jv POST https://platform.unstructuredapp.io/api/v1/sources/ unstructured-api-key:$UNSTRUCTURED_API_KEY name=test-kafka-connector type=kafka-cloud config:='{"topic":"foo","kafka_api_key":"foo","secret":"foo","bootstrap_servers":"https://example.com"}'
$ http -jv POST https://platform.unstructuredapp.io/api/v1/sources/ unstructured-api-key:$UNSTRUCTURED_API_KEY name=test-kafka-connector type=kafka-cloud config:='{"topic":"foo","kafka_api_key":"foo","secret":"foo","bootstrap_server":"https://example.com"}'

Expected behavior

One of these two should have worked, or should have moved on to some other validation message.

Additional context

Documentation for the source connector shows the singular bootstrap_connector. The Python SDK uses the plural bootstrap_connectors.

Dominant language
Python
Stars
119
Forks
22
Avg merge
1d 21h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Unstructured-IO/unstructured-python-client

All issues in Unstructured-IO/unstructured-python-client

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.