KAFKA-14930: Document the new PATCH and DELETE offsets REST APIs for Connect#13915
Conversation
C0urante
left a comment
C0urante
left a comment
There was a problem hiding this comment.
Thanks Yash! Have some thoughts. Also, correct me if I'm wrong, but I think the term "endpoint" is generally more fitting here than "REST API".
| <li>Offsets management REST APIs (see <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-875%3A+First-class+offsets+support+in+Kafka+Connect">KIP-875</a> for more details): | ||
| <ul> | ||
| <li><code>GET /connectors/{name}/offsets</code> - get the current offsets for a connector</li> | ||
| <li><code>DELETE /connectors/{name}/offsets</code> - reset the offsets for a connector. The connector must exist and must be in the stopped state.</li> |
There was a problem hiding this comment.
Nit: for consistency, we should leave out the period from the last sentence of each item
| <li><code>DELETE /connectors/{name}/offsets</code> - reset the offsets for a connector. The connector must exist and must be in the stopped state.</li> | |
| <li><code>DELETE /connectors/{name}/offsets</code> - reset the offsets for a connector. The connector must exist and must be in the stopped state</li> |
Also, would it be possible to link to the docs for the PUT /connectors/{name}/stop endpoint when we refer to it here?
There was a problem hiding this comment.
Hm the PUT /connectors/{name}/stop endpoint docs are in the same connect_rest section as these docs and I don't think it is possible to link to individual list items inside the section?
There was a problem hiding this comment.
It's possible; I'll add some GH suggestions demonstrating how.
Co-authored-by: Chris Egerton <fearthecellos@gmail.com>
Co-authored-by: Chris Egerton <fearthecellos@gmail.com>
Co-authored-by: Chris Egerton <fearthecellos@gmail.com>
Co-authored-by: Chris Egerton <fearthecellos@gmail.com>
…endpoint; add a note on using a null offset to reset the offset for a partition; add a note on request body format differences between source and sink connectors
C0urante
left a comment
C0urante
left a comment
There was a problem hiding this comment.
I believe I figured out how to link to the docs for individual endpoints; give this a try and LMK
…sets endpoints; break compact JSON request body examples into multi-line JSON
|
Thanks Chris. I applied your suggestions and checked it out locally; things look good! |
C0urante
left a comment
C0urante
left a comment
There was a problem hiding this comment.
Wonderful, thanks Yash!
|
Given that this change only touches on our HTML docs, I'll merge without waiting for CI. |
2 participants
https://cwiki.apache.org/confluence/display/KAFKA/KIP-875%3A+First-class+offsets+support+in+Kafka+Connect
https://issues.apache.org/jira/browse/KAFKA-14930
KAFKA-14368: Connect offset write REST API #13465; KAFKA-14784: Connect offset reset REST API #13818
Previous documentation PRs for REST APIs introduced in KIP-875 - KAFKA-14876: Document the new 'GET /connectors/{name}/offsets' REST API for Connect #13587, KAFKA-14876: Document the new 'PUT /connectors/{name}/stop' REST API for Connect #13657
Preview of the documentation changes in this PR:
Committer Checklist (excluded from commit message)