KAFKA-14930: Document the new PATCH and DELETE offsets REST APIs for Connect #13915
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
C0urante
reviewed
Jun 26, 2023
docs/connect.html
Outdated
| <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
Suggested change
| <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
reviewed
Jun 28, 2023
C0urante
reviewed
Jun 28, 2023
…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
approved these changes
Jun 29, 2023
|
Given that this change only touches on our HTML docs, I'll merge without waiting for CI. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)