[kafka] branch 3.0 updated: KAFKA-13035 updated documentation for connector restart REST API to … (#10975)

[kkarantasis]

This is an automated email from the ASF dual-hosted git repository.

kkarantasis pushed a commit to branch 3.0
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/3.0 by this push:
     new d9817a6  KAFKA-13035  updated documentation for connector restart REST 
API to … (#10975)
d9817a6 is described below

commit d9817a6bd9fa52d39f8b3e897c46d8cadb9f95f3
Author: kpatelatwork <kpa...@confluent.io>
AuthorDate: Tue Jul 6 13:31:40 2021 -0500

    KAFKA-13035  updated documentation for connector restart REST API to … 
(#10975)
    
    Updated documentation for connector restart REST API to include the tasks 
restart behavior, including calling out that by default the same behavior of 
previous versions is preserved.
    
    Author: Kalpesh Patel <kpa...@confluent.io>
    Reviewer: Randall Hauch <rha...@gmail.com>
---
 docs/connect.html | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/connect.html b/docs/connect.html
index e522c8a..07f8778 100644
--- a/docs/connect.html
+++ b/docs/connect.html
@@ -310,7 +310,12 @@
         <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"), with the default ("false") 
preserving the same behavior as earlier versions.</li>
+                <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>
+            </ul>
+        </li>
         <li><code>POST /connectors/{name}/tasks/{taskId}/restart</code> - 
restart an individual task (typically because it has failed)</li>
         <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>