[Backport 8.2] Add missing params to shutdown APIs (#1720)

Co-authored-by: Tomas Della Vedova <[email protected]>

Author: github-actions[bot]

output/schema/schema.json

@@ -0,0 +1,24 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export enum Type {
+  restart,
+  remove,
+  replace
+}

output/schema/validation-errors.json

@@ -19,6 +19,7 @@
 
 import { RequestBase } from '@_types/Base'
 import { NodeId } from '@_types/common'
+import { TimeUnit } from '@_types/Time'
 
 /**
  * @rest_spec_name shutdown.delete_node
@@ -29,4 +30,16 @@ export interface Request extends RequestBase {
   path_parts: {
     node_id: NodeId
   }
+  query_parameters: {
+    /**
+     * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
+    master_timeout?: TimeUnit
+    /**
+     * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
+    timeout?: TimeUnit
+  }
 }

output/typescript/types.ts

@@ -19,6 +19,7 @@
 
 import { RequestBase } from '@_types/Base'
 import { NodeIds } from '@_types/common'
+import { TimeUnit } from '@_types/Time'
 
 /**
  * @rest_spec_name shutdown.get_node
@@ -29,4 +30,16 @@ export interface Request extends RequestBase {
   path_parts: {
     node_id?: NodeIds
   }
+  query_parameters: {
+    /**
+     * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
+    master_timeout?: TimeUnit
+    /**
+     * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
+    timeout?: TimeUnit
+  }
 }

specification/shutdown/_types/types.ts

@@ -19,6 +19,8 @@
 
 import { RequestBase } from '@_types/Base'
 import { NodeId } from '@_types/common'
+import { TimeUnit } from '@_types/Time'
+import { Type } from '../_types/types'
 
 /**
  * @rest_spec_name shutdown.put_node
@@ -29,4 +31,47 @@ export interface Request extends RequestBase {
   path_parts: {
     node_id: NodeId
   }
+  query_parameters: {
+    /**
+     * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
+    master_timeout?: TimeUnit
+    /**
+     * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
+    timeout?: TimeUnit
+  }
+  body: {
+    /**
+     * Valid values are restart, remove, or replace.
+     * Use restart when you need to temporarily shut down a node to perform an upgrade, make configuration changes, or perform other maintenance.
+     * Because the node is expected to rejoin the cluster, data is not migrated off of the node.
+     * Use remove when you need to permanently remove a node from the cluster.
+     * The node is not marked ready for shutdown until data is migrated off of the node Use replace to do a 1:1 replacement of a node with another node.
+     * Certain allocation decisions will be ignored (such as disk watermarks) in the interest of true replacement of the source node with the target node.
+     * During a replace-type shutdown, rollover and index creation may result in unassigned shards, and shrink may fail until the replacement is complete.
+     */
+    type: Type
+    /**
+     * A human-readable reason that the node is being shut down.
+     * This field provides information for other cluster operators; it does not affect the shut down process.
+     */
+    reason: string
+    /**
+     * Only valid if type is restart.
+     * Controls how long Elasticsearch will wait for the node to restart and join the cluster before reassigning its shards to other nodes.
+     * This works the same as delaying allocation with the index.unassigned.node_left.delayed_timeout setting.
+     * If you specify both a restart allocation delay and an index-level allocation delay, the longer of the two is used.
+     */
+    allocation_delay?: string
+    /**
+     * Only valid if type is replace.
+     * Specifies the name of the node that is replacing the node being shut down.
+     * Shards from the shut down node are only allowed to be allocated to the target node, and no other data will be allocated to the target node.
+     * During relocation of data certain allocation rules are ignored, such as disk watermarks or user attribute filtering rules.
+     */
+    target_node_name?: string
+  }
 }