STstreamkap
Sources

Get Source Connector Schema

Changed on

JSON Forms form contract for an API-source connector.

Returns a clean json_schema (the config model's data schema — standard keywords only) plus a ui_schema: a JSON Forms UISchema grouping the fields into one Category per tab, each Control carrying its render hints in options. Legacy (Kafka Connect) connectors keep the mapping catalog and return 404 here.

get/sources/connectors/{code}/schema

Request

Path parameters

codestring required

Response

Successful Response

connectorstring required

The connector code.

entity_json_schemaobject required

JSON Schema of the shared entity fields (name).

entity_ui_schemaobject required

JSON Forms UISchema for the entity fields.

json_schemaobject required

JSON Schema of config: its fields, the auth_mode choices and which fields are required.

ui_schemaobject required

JSON Forms UISchema: one Category per tab, render hints in options.

topic_resource_fieldstring required

The config field whose entries each become one topic.

unavailable_reasonstring nullable required

Set exactly when capabilities.available is false: why no new source can be created here.

Changes