[kafka] branch 2.5 updated: KAFKA-9810: Document Connect Root REST API on / (#8408)

[kk...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kkarantasis pushed a commit to branch 2.5
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/2.5 by this push:
     new b4fe7cc  KAFKA-9810: Document Connect Root REST API on / (#8408)
b4fe7cc is described below

commit b4fe7cca13d5906b4bec6d0ec2faee1bf55901e9
Author: Konstantine Karantasis <ko...@confluent.io>
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 <to...@gmail.com>, Soenke Liebau <so...@opencore.com>
---
 docs/connect.html | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/connect.html b/docs/connect.html
index d7fa409..2e6bf3a 100644
--- a/docs/connect.html
+++ b/docs/connect.html
@@ -252,6 +252,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>