C0urante commented on code in PR #13657:
URL: https://github.com/apache/kafka/pull/13657#discussion_r1182739254
##########
docs/connect.html:
##########
@@ -301,7 +301,8 @@ <h4><a id="connect_rest" href="#connect_rest">REST
API</a></h4>
<li><code>GET /connectors/{name}/tasks</code> - get a list of tasks
currently running for a connector</li>
<li><code>GET /connectors/{name}/tasks/{taskid}/status</code> - get
current status of the task, including if it is running, failed, paused, etc.,
which worker it is assigned to, and error information if it has failed</li>
<li><code>PUT /connectors/{name}/pause</code> - pause the connector
and its tasks, which stops message processing until the connector is
resumed</li>
Review Comment:
```suggestion
<li><code>PUT /connectors/{name}/pause</code> - pause the connector
and its tasks, which stops message processing until the connector is resumed.
Any resources claimed by its tasks are left allocated, which allows the
connector to begin processing data quickly once it is resumed.</li>
```
##########
docs/connect.html:
##########
@@ -301,7 +301,8 @@ <h4><a id="connect_rest" href="#connect_rest">REST
API</a></h4>
<li><code>GET /connectors/{name}/tasks</code> - get a list of tasks
currently running for a connector</li>
<li><code>GET /connectors/{name}/tasks/{taskid}/status</code> - get
current status of the task, including if it is running, failed, paused, etc.,
which worker it is assigned to, and error information if it has failed</li>
<li><code>PUT /connectors/{name}/pause</code> - pause the connector
and its tasks, which stops message processing until the connector is
resumed</li>
- <li><code>PUT /connectors/{name}/resume</code> - resume a paused
connector (or do nothing if the connector is not paused)</li>
+ <li><code>PUT /connectors/{name}/stop</code> - stop the connector and
its tasks, and also remove its tasks from the Connect cluster. This is
different from the paused state where the tasks aren't stopped and removed, but
only suspended.</li>
Review Comment:
Nit: wording
```suggestion
<li><code>PUT /connectors/{name}/stop</code> - stop the connector
and shut down its tasks, deallocating any resources claimed by its tasks. This
is less resource-intensive than pausing the connector, but can cause it to take
longer to begin processing data once resumed.</li>
```
--
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: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
