KAFKA-9810: Document Connect Root REST API on / #8408
Conversation
docs/connect.html
Outdated
| @@ -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>Finally, supported REST requests at the top-level endpoint are:</p> | |||
There was a problem hiding this comment.
suggest: The following is a supported REST request at the top-level (root) endpoint:
There was a problem hiding this comment.
Is there a specific reason why you chose to add this as a extra paragraph instead of insert it at the top of the endpoint list in line 231?
There was a problem hiding this comment.
@soenkeliebau , yes. I noticed there's a semantic (yet maybe incidental) grouping of the endpoints in groups of /connector/ endpoints, /connector-plugins/ and now /.
To me it seems that, for the time being, this reads better than attaching the missing doc with any of the other groups.
Thanks @tobydrake7. Incorporated.
There was a problem hiding this comment.
When reading the previous sections I wondered about that grouping as well. It is not mentioned in the text anywhere and seems to be mostly coincidental.
I wonder whether it might make sense to just pull all of them together?
There was a problem hiding this comment.
I agree. But all the endpoints are still under the same paragraph no far apart with each other, and the text reads well. I also like that visually I can distinguish those 3 groups easily, instead of having to scan one by one a long list of endpoints. I'll keep this for this doc bugfix that will backport cleanly and we can return to this doc with another ticket, if that's ok.
There was a problem hiding this comment.
Absolutely! It was more of an observation and very much boils down to personal preference I believe :)
|
Thanks @tobydrake7, @soenkeliebau Success with JDK11 reveals that there are no formatting errors. |
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>
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>
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>
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>
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>
| <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. |
There was a problem hiding this comment.
Nit: the other list entries have a whitespace after </code>
Ups, sorry. Overlooked that this is merged already, please disregard :)
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>
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)
Committer Checklist (excluded from commit message)