This is an automated email from the ASF dual-hosted git repository.
kkarantasis pushed a commit to branch 2.1
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/2.1 by this push:
new c70bc3b KAFKA-9810: Document Connect Root REST API on / (#8408)
c70bc3b is described below
commit c70bc3b00dba37452d24830ea980739debd9fa78
Author: Konstantine Karantasis <[email protected]>
AuthorDate: Fri Apr 3 13:27:27 2020 -0700
KAFKA-9810: Document Connect Root REST API on / (#8408)
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 <[email protected]>, Soenke Liebau
<[email protected]>
---
docs/connect.html | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/connect.html b/docs/connect.html
index 1f30da4..ffc6b53 100644
--- a/docs/connect.html
+++ b/docs/connect.html
@@ -248,6 +248,12 @@
<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>
