Update rest-api-spec (#5679)

Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com>

Author: github-actions[bot]

specification/_json_spec/clear_scroll.json

@@ -23,7 +23,10 @@
             "scroll_id": {
               "type": "list",
               "description": "A comma-separated list of scroll IDs to clear",
-              "deprecated": true
+              "deprecated": {
+                "version": "7.0.0",
+                "description": "A scroll id can be quite large and should be specified as part of the body"
+              }
             }
           },
           "deprecated": {

specification/_json_spec/cluster.exists_component_template.json

@@ -30,7 +30,10 @@
         "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "local": {
-        "deprecated": true,
+        "deprecated": {
+          "version": "9.0.0",
+          "description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
+        },
         "type": "boolean",
         "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"

specification/_json_spec/cluster.get_component_template.json

@@ -34,7 +34,10 @@
         "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "local": {
-        "deprecated": true,
+        "deprecated": {
+          "version": "9.0.0",
+          "description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
+        },
         "type": "boolean",
         "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"

specification/_json_spec/cluster.reroute.json

@@ -36,17 +36,10 @@
       },
       "metric": {
         "type": "list",
-        "options": [
-          "_all",
-          "blocks",
-          "metadata",
-          "nodes",
-          "none",
-          "routing_table",
-          "master_node",
-          "version"
-        ],
-        "default": "all",
+        "deprecated": {
+          "version": "8.6.0",
+          "description": "This parameter has no effect; its use will be forbidden in a future version."
+        },
         "description": "Limit the information returned to the specified metrics. Defaults to all but metadata"
       },
       "master_timeout": {

specification/_json_spec/cluster.state.json

@@ -24,6 +24,7 @@
               "options": [
                 "_all",
                 "blocks",
+                "customs",
                 "metadata",
                 "nodes",
                 "routing_table",
@@ -48,6 +49,7 @@
               "options": [
                 "_all",
                 "blocks",
+                "customs",
                 "metadata",
                 "nodes",
                 "routing_table",
@@ -63,7 +65,10 @@
     },
     "params": {
       "local": {
-        "deprecated": true,
+        "deprecated": {
+          "version": "9.0.0",
+          "description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
+        },
         "type": "boolean",
         "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"

specification/_json_spec/count.json

@@ -35,6 +35,10 @@
         "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
       },
       "ignore_throttled": {
+        "deprecated": {
+          "version": "7.16.0",
+          "description": "This parameter is deprecated because frozen indices have been deprecated."
+        },
         "type": "boolean",
         "default": true,
         "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled"

specification/_json_spec/delete_by_query.json

@@ -106,6 +106,10 @@
         "description": "Maximum number of documents to process (default: all documents)"
       },
       "sort": {
+        "deprecated": {
+          "version": "9.0.0",
+          "description": "This query parameter is not supported and will be removed in a future version"
+        },
         "type": "list",
         "description": "A comma-separated list of <field>:<direction> pairs"
       },

specification/_json_spec/indices.delete_sample_configuration.json

@@ -1,7 +1,7 @@
 {
   "indices.delete_sample_configuration": {
     "documentation": {
-      "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration",
+      "url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
       "description": "Delete sampling configuration for an index or data stream"
     },
     "stability": "experimental",
@@ -28,10 +28,12 @@
     "params": {
       "master_timeout": {
         "type": "time",
+        "default": "30s",
         "description": "Timeout for connection to master node"
       },
       "timeout": {
         "type": "time",
+        "default": "30s",
         "description": "Timeout for the request"
       }
     }

specification/_json_spec/indices.delete_template.json

@@ -6,6 +6,10 @@
     },
     "stability": "stable",
     "visibility": "public",
+    "deprecated": {
+      "version": "7.8.0",
+      "description": "Legacy index templates are deprecated in favor of composable templates"
+    },
     "headers": {
       "accept": ["application/json"]
     },

specification/_json_spec/indices.exists_template.json

@@ -35,7 +35,10 @@
         "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "local": {
-        "deprecated": true,
+        "deprecated": {
+          "version": "9.0.0",
+          "description": "This parameter has no effect, is now deprecated, and will be removed in a future version."
+        },
         "type": "boolean",
         "default": false,
         "description": "Return local information, do not retrieve the state from master node (default: false)"