[GitHub] [kafka] rhauch commented on a change in pull request #10975: KAFKA-13035 updated documentation for connector restart REST API to …

[GitBox]

rhauch commented on a change in pull request #10975:
URL: https://github.com/apache/kafka/pull/10975#discussion_r664659210



##########
File path: docs/connect.html
##########
@@ -310,7 +310,12 @@ <h4><a id="connect_rest" href="#connect_rest">REST 
API</a></h4>
         <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>POST /connectors/{name}/restart</code> - restart a connector 
(typically because it has failed)</li>
+        <li><code>POST 
/connectors/{name}/restart?includeTasks=&lt;true|false&gt;&amp;onlyFailed=&lt;true|false&gt;</code>
 - restart a connector and its tasks instances.
+            <ul>
+                <li>the "includeTasks" parameter specifies whether to restart 
the connector instance and task instances ("includeTasks=true") or just the 
connector instance ("includeTasks=false"), and defaults to "false".</li>
+                <li>the "onlyFailed" parameter specifies whether to restart 
just the instances with a FAILED status ("onlyFailed=true") or all instances 
("onlyFailed=false"), and defaults to "false".</li>

Review comment:
       ```suggestion
                   <li>the "onlyFailed" parameter specifies whether to restart 
just the instances with a FAILED status ("onlyFailed=true") or all instances 
("onlyFailed=false"), with the default ("false") preserving the same behavior 
as earlier versions.</li>
   ```

##########
File path: docs/connect.html
##########
@@ -310,7 +310,12 @@ <h4><a id="connect_rest" href="#connect_rest">REST 
API</a></h4>
         <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>POST /connectors/{name}/restart</code> - restart a connector 
(typically because it has failed)</li>
+        <li><code>POST 
/connectors/{name}/restart?includeTasks=&lt;true|false&gt;&amp;onlyFailed=&lt;true|false&gt;</code>
 - restart a connector and its tasks instances.
+            <ul>
+                <li>the "includeTasks" parameter specifies whether to restart 
the connector instance and task instances ("includeTasks=true") or just the 
connector instance ("includeTasks=false"), and defaults to "false".</li>

Review comment:
       Let's mention maintaining backward compatibility:
   ```suggestion
                   <li>the "includeTasks" parameter specifies whether to 
restart the connector instance and task instances ("includeTasks=true") or just 
the connector instance ("includeTasks=false"), with the default ("false") 
preserving the same behavior as earlier versions.</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