Unstructured-IO / Unstructured-IO/unstructured-python-client

bug/SaaS API Kafka Cloud Connector inconsistency

Ouverte
#308 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug
Langage dominant
Python
Étoiles
119
Forks
22
Merge moyen
1 j 21 h
PR mergées (30 j)
1

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par reproduire POST /api/v1/sources/ et comparez ses erreurs de validation au singulier et au pluriel. Inspectez src/unstructured_client/models/shared/kafkacloudsourceconnectorconfiginput.py et comparez-le à la documentation liée du Kafka source connector ; le travail est terminé lorsque le nom de champ accepté et le comportement de validation sont cohérents.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
kafka, python
Domaine
api
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.