Update rest-api-spec (#5475)

Co-authored-by: pquentin <[email protected]>

Author: github-actions[bot]

output/schema/schema.json

@@ -1,5 +1,16 @@
 {
-  "endpointErrors": {},
+  "endpointErrors": {
+    "cat.segments": {
+      "request": [
+        "Request: missing json spec query parameter 'ignore_unavailable'",
+        "Request: missing json spec query parameter 'ignore_throttled'",
+        "Request: missing json spec query parameter 'allow_no_indices'",
+        "Request: missing json spec query parameter 'expand_wildcards'",
+        "Request: missing json spec query parameter 'allow_closed'"
+      ],
+      "response": []
+    }
+  },
   "generalErrors": [
     "Dangling type '_global.scripts_painless_execute:PainlessExecutionPosition'",
     "Dangling type '_global.scripts_painless_execute:PainlessScript'",

output/schema/validation-errors.json

@@ -21,7 +21,7 @@
               "description": "the history id"
             },
             "version": {
-              "type": "integer",
+              "type": "int",
               "description": "the version number"
             }
           }

specification/_json_spec/_internal.update_desired_nodes.json

@@ -45,7 +45,7 @@
         "default": "5d"
       },
       "batched_reduce_size": {
-        "type": "number",
+        "type": "long",
         "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.",
         "default": 5
       },
@@ -90,7 +90,7 @@
         "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit"
       },
       "from": {
-        "type": "number",
+        "type": "int",
         "description": "Starting offset (default: 0)"
       },
       "ignore_unavailable": {
@@ -142,7 +142,7 @@
         "description": "Search operation type"
       },
       "size": {
-        "type": "number",
+        "type": "int",
         "description": "Number of hits to return (default: 10)"
       },
       "sort": {
@@ -162,7 +162,7 @@
         "description": "A list of fields to extract and return from the _source field"
       },
       "terminate_after": {
-        "type": "number",
+        "type": "long",
         "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."
       },
       "stats": {
@@ -180,7 +180,7 @@
         "description": "Specify suggest mode"
       },
       "suggest_size": {
-        "type": "number",
+        "type": "long",
         "description": "How many suggestions to return in response"
       },
       "suggest_text": {
@@ -217,13 +217,14 @@
         "description": "Specify whether to return sequence number and primary term of the last modification of each hit"
       },
       "max_concurrent_shard_requests": {
-        "type": "number",
+        "type": "int",
         "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests",
         "default": 5
       }
     },
     "body": {
-      "description": "The search definition using the Query DSL"
+      "description": "The search definition using the Query DSL",
+      "required": false
     }
   }
 }

specification/_json_spec/async_search.submit.json

@@ -71,6 +71,29 @@
         "type": "enum",
         "description": "The unit in which to display time values",
         "options": ["d", "h", "m", "s", "ms", "micros", "nanos"]
+      },
+      "ignore_unavailable": {
+        "type": "boolean",
+        "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression."
+      },
+      "ignore_throttled": {
+        "type": "boolean",
+        "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression."
+      },
+      "allow_no_indices": {
+        "type": "boolean",
+        "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). Only allowed when providing an index expression."
+      },
+      "expand_wildcards": {
+        "type": "enum",
+        "options": ["open", "closed", "hidden", "none", "all"],
+        "default": "open",
+        "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
+      },
+      "allow_closed": {
+        "type": "boolean",
+        "description": "If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices",
+        "default": false
       }
     }
   }

specification/_json_spec/cat.segments.json

@@ -35,7 +35,8 @@
     },
     "params": {},
     "body": {
-      "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter"
+      "description": "A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter",
+      "required": false
     }
   }
 }

specification/_json_spec/clear_scroll.json

@@ -20,7 +20,8 @@
     },
     "params": {},
     "body": {
-      "description": "a point-in-time id to close"
+      "description": "a point-in-time id to close",
+      "required": true
     }
   }
 }

specification/_json_spec/close_point_in_time.json

@@ -24,7 +24,7 @@
         "description": "Specifies the name of the index that you would like an explanation for"
       },
       "shard": {
-        "type": "number",
+        "type": "int",
         "description": "Specifies the ID of the shard that you would like an explanation for"
       },
       "primary": {
@@ -52,7 +52,8 @@
       }
     },
     "body": {
-      "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'"
+      "description": "The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'",
+      "required": false
     }
   }
 }

specification/_json_spec/cluster.allocation_explain.json

@@ -61,7 +61,8 @@
       }
     },
     "body": {
-      "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)"
+      "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)",
+      "required": false
     }
   }
 }

specification/_json_spec/cluster.reroute.json

@@ -79,7 +79,7 @@
         "description": "Return settings in flat format (default: false)"
       },
       "wait_for_metadata_version": {
-        "type": "number",
+        "type": "long",
         "description": "Wait for the metadata version to be equal or greater than the specified metadata version"
       },
       "wait_for_timeout": {