Skip to content

Commit

Permalink
KAFKA-9810: Document Connect Root REST API on / (#8408)
Browse files Browse the repository at this point in the history
Document the supported endpoint at the top-level (root) REST API resource and the information that it returns when a request is made to a Connect worker.

Fixes an omission in documentation after KAFKA-2369 and KAFKA-6311 (KIP-238)

Reviewers: Toby Drake <tobydrake7@gmail.com>, Soenke Liebau <soenke.liebau@opencore.com>
  • Loading branch information
kkonstantine committed Apr 3, 2020
1 parent 4c30eed commit 4cfad84
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/connect.html
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,12 @@ <h4><a id="connect_rest" href="#connect_rest">REST API</a></h4>
<li><code>PUT /connector-plugins/{connector-type}/config/validate</code> - validate the provided configuration values against the configuration definition. This API performs per config validation, returns suggested values and error messages during validation.</li>
</ul>

<p>The following is a supported REST request at the top-level (root) endpoint:</p>

<ul>
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>

<h3><a id="connect_development" href="#connect_development">8.3 Connector Development Guide</a></h3>

<p>This guide describes how developers can write new connectors for Kafka Connect to move data between Kafka and other systems. It briefly reviews a few key concepts and then describes how to create a simple connector.</p>
Expand Down

0 comments on commit 4cfad84

Please sign in to comment.