yashmayya commented on code in PR #13915:
URL: https://github.com/apache/kafka/pull/13915#discussion_r1243145305
##########
docs/connect.html:
##########
@@ -313,7 +313,13 @@ <h4><a id="connect_rest" href="#connect_rest">REST
API</a></h4>
<li><code>DELETE /connectors/{name}</code> - delete a connector,
halting all tasks and deleting its configuration</li>
<li><code>GET /connectors/{name}/topics</code> - get the set of topics
that a specific connector is using since the connector was created or since a
request to reset its set of active topics was issued</li>
<li><code>PUT /connectors/{name}/topics/reset</code> - send a request
to empty the set of active topics of a connector</li>
- <li><code>GET /connectors/{name}/offsets</code> - get the current
offsets for a connector (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)</li>
+ <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>
+ <li><code>PATCH /connectors/{name}/offsets</code> - alter the
offsets for a connector. The connector must exist and must be in the stopped
state. The request body should be a JSON object containing a JSON array
<code>offsets</code> field, similar to the response body of the <code>GET
/connectors/{name}/offsets</code> REST API.</li>
Review Comment:
There is a link to the generated OpenAPI docs at the end of this section so
I don't think it's necessary to add the same link here as well? Also, I think
an actual example might be more helpful than the generated OpenAPI spec where
the finest level of granularity is the
[ConnectorOffset](https://github.com/apache/kafka/blob/c5889fceddb9a0174452ae60a57c8ff3f087a6a4/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/rest/entities/ConnectorOffset.java#L41)
schema describing the `partition` and `offset` keys having JSON object values.
I was hoping that the link to the KIP should be sufficient, but I do see the
value of including actual examples directly in the docs as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
