Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

KAFKA-9810: Document Connect Root REST API on / #8408

Merged
merged 2 commits into from
Apr 3, 2020
Merged

KAFKA-9810: Document Connect Root REST API on / #8408

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1abdcbc
KAFKA-9810: Document Connect Root REST API on /
kkonstantine Apr 2, 2020
9a8739e
KAFKA-9810: Rephrase intro paragraph
kkonstantine Apr 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/connect.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,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.
Copy link
Contributor

@soenkeliebau soenkeliebau Apr 3, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the other list entries have a whitespace after </code>

Ups, sorry. Overlooked that this is merged already, please disregard :)

</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