Update rest-api-spec 8.19

output/schema/validation-errors.json

@@ -1,8 +1,12 @@
 {
   "endpointErrors": {
-    "streams.status": {
+    "cat.segments": {
       "request": [
-        "Request: query parameter 'master_timeout' does not exist in the json spec"
+        "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": []
     }

specification/_json_spec/async_search.status.json

@@ -26,6 +26,7 @@
     "params": {
       "keep_alive": {
         "type": "time",
+        "default": "5d",
         "description": "Specify the time interval in which the results (partial or final) for this search will be available"
       }
     }

specification/_json_spec/async_search.submit.json

@@ -51,6 +51,7 @@
       },
       "request_cache": {
         "type": "boolean",
+        "default": true,
         "description": "Specify if request cache should be used for this request or not, defaults to true"
       },
       "analyzer": {
@@ -218,7 +219,8 @@
       }
     },
     "body": {
-      "description": "The search definition using the Query DSL"
+      "description": "The search definition using the Query DSL",
+      "required": false
     }
   }
 }

specification/_json_spec/autoscaling.delete_autoscaling_policy.json

@@ -31,6 +31,7 @@
       },
       "timeout": {
         "type": "time",
+        "default": "30s",
         "description": "Timeout for acknowledgement of update from all nodes in cluster"
       }
     }

specification/_json_spec/autoscaling.put_autoscaling_policy.json

@@ -32,6 +32,7 @@
       },
       "timeout": {
         "type": "time",
+        "default": "30s",
         "description": "Timeout for acknowledgement of update from all nodes in cluster"
       }
     },

specification/_json_spec/bulk.json

@@ -31,11 +31,13 @@
     "params": {
       "wait_for_active_shards": {
         "type": "string",
+        "default": "1",
         "description": "Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"
       },
       "refresh": {
         "type": "enum",
         "options": ["true", "false", "wait_for"],
+        "default": "false",
         "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."
       },
       "routing": {
@@ -44,6 +46,7 @@
       },
       "timeout": {
         "type": "time",
+        "default": "1m",
         "description": "Explicit operation timeout"
       },
       "_source": {
@@ -64,18 +67,22 @@
       },
       "require_alias": {
         "type": "boolean",
-        "description": "Sets require_alias for all incoming documents. Defaults to unset (false)"
+        "default": false,
+        "description": "If true, the request's actions must target an index alias. Defaults to false."
       },
       "require_data_stream": {
         "type": "boolean",
-        "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false"
+        "default": false,
+        "description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false"
       },
       "list_executed_pipelines": {
         "type": "boolean",
+        "default": false,
         "description": "Sets list_executed_pipelines for all incoming documents. Defaults to unset (false)"
       },
       "include_source_on_error": {
         "type": "boolean",
+        "default": true,
         "description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true."
       }
     },

specification/_json_spec/cat.allocation.json

@@ -45,6 +45,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {

specification/_json_spec/cat.component_templates.json

@@ -35,6 +35,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {

specification/_json_spec/cat.master.json

@@ -25,6 +25,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {

specification/_json_spec/cat.ml_data_frame_analytics.json

@@ -30,6 +30,7 @@
     "params": {
       "allow_no_match": {
         "type": "boolean",
+        "default": false,
         "description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)"
       },
       "bytes": {
@@ -44,6 +45,7 @@
       },
       "h": {
         "type": "list",
+        "default": "create_time,id,state,type",
         "description": "Comma-separated list of column names to display"
       },
       "help": {

specification/_json_spec/cat.ml_datafeeds.json

@@ -30,6 +30,7 @@
     "params": {
       "allow_no_match": {
         "type": "boolean",
+        "default": true,
         "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"
       },
       "format": {
@@ -39,6 +40,7 @@
       },
       "h": {
         "type": "list",
+        "default": "['bc', 'id', 'sc', 's']",
         "description": "Comma-separated list of column names to display"
       },
       "help": {

specification/_json_spec/cat.ml_jobs.json

@@ -30,6 +30,7 @@
     "params": {
       "allow_no_match": {
         "type": "boolean",
+        "default": true,
         "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"
       },
       "bytes": {
@@ -44,6 +45,7 @@
       },
       "h": {
         "type": "list",
+        "default": "buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state",
         "description": "Comma-separated list of column names to display"
       },
       "help": {

specification/_json_spec/cat.nodeattrs.json

@@ -25,6 +25,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {

specification/_json_spec/cat.nodes.json

@@ -30,6 +30,7 @@
       },
       "full_id": {
         "type": "boolean",
+        "default": false,
         "description": "Return the full node ID instead of the shortened version (default: false)"
       },
       "master_timeout": {
@@ -39,6 +40,7 @@
       },
       "h": {
         "type": "list",
+        "default": "ip,hp,rp,r,m,n,cpu,l",
         "description": "Comma-separated list of column names to display"
       },
       "help": {

specification/_json_spec/cat.pending_tasks.json

@@ -25,6 +25,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {

specification/_json_spec/cat.plugins.json

@@ -25,6 +25,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {

specification/_json_spec/cat.recovery.json

@@ -50,6 +50,7 @@
       },
       "h": {
         "type": "list",
+        "default": "ip,hp,rp,r,m,n,cpu,l",
         "description": "Comma-separated list of column names to display"
       },
       "help": {

specification/_json_spec/cat.segments.json

@@ -35,6 +35,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {
@@ -49,6 +50,7 @@
       },
       "h": {
         "type": "list",
+        "default": "ip,hp,rp,r,m,n,cpu,l",
         "description": "Comma-separated list of column names to display"
       },
       "help": {
@@ -69,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.snapshots.json

@@ -45,6 +45,7 @@
       },
       "h": {
         "type": "list",
+        "default": "ip,hp,rp,r,m,n,cpu,l",
         "description": "Comma-separated list of column names to display"
       },
       "help": {

specification/_json_spec/cat.tasks.json

@@ -33,6 +33,7 @@
       },
       "detailed": {
         "type": "boolean",
+        "default": false,
         "description": "Return detailed task information (default: false)"
       },
       "parent_task_id": {

specification/_json_spec/cat.templates.json

@@ -35,6 +35,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {

specification/_json_spec/cat.thread_pool.json

@@ -40,6 +40,7 @@
       },
       "local": {
         "type": "boolean",
+        "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },
       "master_timeout": {

specification/_json_spec/cat.transforms.json

@@ -30,14 +30,17 @@
     "params": {
       "from": {
         "type": "int",
+        "default": 0,
         "description": "skips a number of transform configs, defaults to 0"
       },
       "size": {
         "type": "int",
+        "default": 100,
         "description": "specifies a max number of transforms to get, defaults to 100"
       },
       "allow_no_match": {
         "type": "boolean",
+        "default": true,
         "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"
       },
       "format": {
@@ -47,6 +50,7 @@
       },
       "h": {
         "type": "list",
+        "default": "changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state",
         "description": "Comma-separated list of column names to display"
       },
       "help": {

specification/_json_spec/ccr.follow_stats.json

@@ -26,6 +26,7 @@
     "params": {
       "timeout": {
         "type": "time",
+        "default": "30s",
         "description": "Explicit operation timeout"
       }
     }

specification/_json_spec/ccr.forget_follower.json

@@ -27,6 +27,7 @@
     "params": {
       "timeout": {
         "type": "time",
+        "default": "30s",
         "description": "Explicit operation timeout"
       }
     },

specification/_json_spec/ccr.stats.json

@@ -20,6 +20,7 @@
     "params": {
       "timeout": {
         "type": "time",
+        "default": "30s",
         "description": "Explicit operation timeout"
       },
       "master_timeout": {

specification/_json_spec/clear_scroll.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/close_point_in_time.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
     }
   }
 }