Update rest-api-spec

elastic · Jan 22, 2025 · c722957 · c722957
1 parent ed872aa
commit c722957
Show file tree

Hide file tree

Showing 18 changed files with 77 additions and 40 deletions.
diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json
@@ -122,6 +122,24 @@
       ],
       "response": []
     },
+    "connector.delete": {
+      "request": [
+        "Request: missing json spec query parameter 'hard'"
+      ],
+      "response": []
+    },
+    "connector.get": {
+      "request": [
+        "Request: missing json spec query parameter 'include_deleted'"
+      ],
+      "response": []
+    },
+    "connector.list": {
+      "request": [
+        "Request: missing json spec query parameter 'include_deleted'"
+      ],
+      "response": []
+    },
     "connector.secret_delete": {
       "request": [
         "Missing request & response"
@@ -237,8 +255,7 @@
     },
     "indices.rollover": {
       "request": [
-        "Request: missing json spec query parameter 'lazy'",
-        "Request: missing json spec query parameter 'target_failure_store'"
+        "Request: missing json spec query parameter 'lazy'"
       ],
       "response": []
     },
@@ -264,8 +281,7 @@
     "license.post_start_trial": {
       "request": [
         "Request: query parameter 'type_query_string' does not exist in the json spec",
-        "Request: missing json spec query parameter 'type'",
-        "Request: missing json spec query parameter 'timeout'"
+        "Request: missing json spec query parameter 'type'"
       ],
       "response": []
     },
@@ -356,20 +372,6 @@
       ],
       "response": []
     },
-    "shutdown.delete_node": {
-      "request": [
-        "Request: query parameter 'master_timeout' does not exist in the json spec",
-        "Request: query parameter 'timeout' does not exist in the json spec"
-      ],
-      "response": []
-    },
-    "shutdown.put_node": {
-      "request": [
-        "Request: query parameter 'master_timeout' does not exist in the json spec",
-        "Request: query parameter 'timeout' does not exist in the json spec"
-      ],
-      "response": []
-    },
     "snapshot.clone": {
       "request": [
         "Request: query parameter 'timeout' does not exist in the json spec"
@@ -411,7 +413,6 @@
     },
     "xpack.info": {
       "request": [
-        "Request: query parameter 'human' does not exist in the json spec",
         "request definition xpack.info:Request / query - Property 'human' is already defined in an ancestor class"
       ],
       "response": []

diff --git a/specification/_json_spec/cluster.exists_component_template.json b/specification/_json_spec/cluster.exists_component_template.json
@@ -26,9 +26,10 @@
     "params": {
       "master_timeout": {
         "type": "time",
-        "description": "Explicit operation timeout for connection to master node"
+        "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "local": {
+        "deprecated": true,
         "type": "boolean",
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       }

diff --git a/specification/_json_spec/cluster.get_component_template.json b/specification/_json_spec/cluster.get_component_template.json
@@ -30,9 +30,10 @@
     "params": {
       "master_timeout": {
         "type": "time",
-        "description": "Explicit operation timeout for connection to master node"
+        "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "local": {
+        "deprecated": true,
         "type": "boolean",
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },

diff --git a/specification/_json_spec/cluster.get_settings.json b/specification/_json_spec/cluster.get_settings.json
@@ -24,7 +24,7 @@
       },
       "master_timeout": {
         "type": "time",
-        "description": "Explicit operation timeout for connection to master node"
+        "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "timeout": {
         "type": "time",

diff --git a/specification/_json_spec/connector.delete.json b/specification/_json_spec/connector.delete.json
@@ -24,6 +24,11 @@
       ]
     },
     "params": {
+      "hard": {
+        "type": "boolean",
+        "default": false,
+        "description": "If true, the connector doc is deleted. If false, connector doc is marked as deleted (soft-deleted)."
+      },
       "delete_sync_jobs": {
         "type": "boolean",
         "default": false,

diff --git a/specification/_json_spec/connector.get.json b/specification/_json_spec/connector.get.json
@@ -22,6 +22,13 @@
           }
         }
       ]
+    },
+    "params": {
+      "include_deleted": {
+        "type": "boolean",
+        "default": false,
+        "description": "A flag indicating whether to return connectors that have been soft-deleted."
+      }
     }
   }
 }
diff --git a/specification/_json_spec/connector.list.json b/specification/_json_spec/connector.list.json
@@ -43,6 +43,11 @@
       "query": {
         "type": "string",
         "description": "A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names"
+      },
+      "include_deleted": {
+        "type": "boolean",
+        "default": false,
+        "description": "A flag indicating whether to return connectors that have been soft-deleted."
       }
     }
   }

diff --git a/specification/_json_spec/indices.exists_template.json b/specification/_json_spec/indices.exists_template.json
@@ -30,9 +30,10 @@
       },
       "master_timeout": {
         "type": "time",
-        "description": "Explicit operation timeout for connection to master node"
+        "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "local": {
+        "deprecated": true,
         "type": "boolean",
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       }

diff --git a/specification/_json_spec/indices.get_index_template.json b/specification/_json_spec/indices.get_index_template.json
@@ -34,9 +34,10 @@
       },
       "master_timeout": {
         "type": "time",
-        "description": "Explicit operation timeout for connection to master node"
+        "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "local": {
+        "deprecated": true,
         "type": "boolean",
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       },

diff --git a/specification/_json_spec/indices.get_template.json b/specification/_json_spec/indices.get_template.json
@@ -34,9 +34,10 @@
       },
       "master_timeout": {
         "type": "time",
-        "description": "Explicit operation timeout for connection to master node"
+        "description": "Timeout for waiting for new cluster state in case it is blocked"
       },
       "local": {
+        "deprecated": true,
         "type": "boolean",
         "description": "Return local information, do not retrieve the state from master node (default: false)"
       }

diff --git a/specification/_json_spec/indices.rollover.json b/specification/_json_spec/indices.rollover.json
@@ -59,12 +59,6 @@
         "type": "boolean",
         "default": "false",
         "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams."
-      },
-      "target_failure_store": {
-        "type": "boolean",
-        "description": "If set to true, the rollover action will be applied on the failure store of the data stream.",
-        "visibility": "feature_flag",
-        "feature_flag": "es.failure_store_feature_flag_enabled"
       }
     },
     "body": {

diff --git a/specification/_json_spec/license.post_start_trial.json b/specification/_json_spec/license.post_start_trial.json
@@ -29,10 +29,6 @@
       "master_timeout": {
         "type": "time",
         "description": "Timeout for processing on master node"
-      },
-      "timeout": {
-        "type": "time",
-        "description": "Timeout for acknowledgement of update from all nodes in cluster"
       }
     }
   }

diff --git a/specification/_json_spec/migrate.cancel_reindex.json b/specification/_json_spec/migrate.cancel_reindex.json
@@ -2,7 +2,7 @@
   "migrate.cancel_reindex": {
     "documentation": {
       "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
-      "description": "This API cancels migration reindex attempt for a data stream or index"
+      "description": "This API returns the status of a migration reindex attempt for a data stream or index"
     },
     "stability": "experimental",
     "visibility": "private",

diff --git a/specification/_json_spec/migrate.create_from.json b/specification/_json_spec/migrate.create_from.json
@@ -29,7 +29,7 @@
       ]
     },
     "body": {
-      "description": "The body contains the fields `mappings_override` and `settings_override`.",
+      "description": "The body contains the fields `mappings_override`, `settings_override`, and `remove_index_blocks`.",
       "required": false
     }
   }

diff --git a/specification/_json_spec/migrate.reindex.json b/specification/_json_spec/migrate.reindex.json
@@ -19,7 +19,7 @@
       ]
     },
     "body": {
-      "description": "The body contains the fields `mode` and `source.index`, where the only mode currently supported is `upgrade`, and the `source.index` must be a data stream name",
+      "description": "The body contains the fields `mode` and `source.index, where the only mode currently supported is `upgrade`, and the `source.index` must be a data stream name",
       "required": true
     }
   }

diff --git a/specification/_json_spec/shutdown.delete_node.json b/specification/_json_spec/shutdown.delete_node.json
@@ -24,6 +24,15 @@
         }
       ]
     },
-    "params": {}
+    "params": {
+      "master_timeout": {
+        "type": "time",
+        "description": "Explicit operation timeout for connection to master node"
+      },
+      "timeout": {
+        "type": "time",
+        "description": "Explicit operation timeout"
+      }
+    }
   }
 }
diff --git a/specification/_json_spec/shutdown.put_node.json b/specification/_json_spec/shutdown.put_node.json
@@ -24,7 +24,16 @@
         }
       ]
     },
-    "params": {},
+    "params": {
+      "master_timeout": {
+        "type": "time",
+        "description": "Explicit operation timeout for connection to master node"
+      },
+      "timeout": {
+        "type": "time",
+        "description": "Explicit operation timeout"
+      }
+    },
     "body": {
       "description": "The shutdown type definition to register",
       "required": true

diff --git a/specification/_json_spec/xpack.info.json b/specification/_json_spec/xpack.info.json
@@ -18,6 +18,12 @@
       ]
     },
     "params": {
+      "human": {
+        "type": "boolean",
+        "required": false,
+        "description": "Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true.",
+        "default": true
+      },
       "categories": {
         "type": "list",
         "description": "Comma-separated list of info categories. Can be any of: build, license, features"