diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index cf9dcbc30d..401919efdc 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -4182,7 +4182,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11877,7 +11878,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -12288,7 +12290,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -14218,7 +14221,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -14442,7 +14446,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -18440,7 +18445,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -18762,7 +18768,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -18849,7 +18856,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -18930,7 +18938,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19017,7 +19026,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19104,7 +19114,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19191,7 +19202,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19298,7 +19310,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19388,7 +19401,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19474,7 +19488,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19561,7 +19576,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19648,7 +19664,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19735,7 +19752,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19813,7 +19831,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19900,7 +19919,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -19987,7 +20007,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -20062,7 +20083,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -20162,7 +20184,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -20263,7 +20286,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -20345,7 +20369,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -20429,7 +20454,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -38815,7 +38841,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -39585,36 +39612,6 @@ "type": "number" }, "style": "form" - }, - { - "in": "query", - "name": "slm_policy_filter", - "description": "Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.\n\nYou can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.\nFor example, the pattern `*,-policy-a-\\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.\nNote that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.\nTo include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Name" - }, - "style": "form" - }, - { - "in": "query", - "name": "sort", - "description": "The sort order for the result.\nThe default behavior is sorting by snapshot start time stamp.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/snapshot._types.SnapshotSort" - }, - "style": "form" - }, - { - "in": "query", - "name": "verbose", - "description": "If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.\n\nNOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined.", - "deprecated": false, - "schema": { - "type": "boolean" - }, - "style": "form" } ], "responses": { @@ -98940,18 +98937,6 @@ } ] }, - "snapshot._types.SnapshotSort": { - "type": "string", - "enum": [ - "start_time", - "duration", - "name", - "index_count", - "repository", - "shard_count", - "failed_shard_count" - ] - }, "snapshot.get.SnapshotResponseItem": { "type": "object", "properties": { @@ -110233,7 +110218,7 @@ "cluster.state-master_timeout": { "in": "query", "name": "master_timeout", - "description": "Specify timeout for connection to master", + "description": "Timeout for waiting for new cluster state in case it is blocked", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.Duration" @@ -110640,6 +110625,7 @@ "eql.search-allow_no_indices": { "in": "query", "name": "allow_no_indices", + "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)", "deprecated": false, "schema": { "type": "boolean" @@ -110669,6 +110655,7 @@ "eql.search-expand_wildcards": { "in": "query", "name": "expand_wildcards", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.ExpandWildcards" @@ -118869,7 +118856,8 @@ } } } - } + }, + "required": true }, "graph.explore": { "content": { @@ -118902,7 +118890,8 @@ } } } - } + }, + "required": true }, "index": { "content": { @@ -119014,7 +119003,8 @@ } } } - } + }, + "required": true }, "indices.clone": { "content": { @@ -119374,7 +119364,8 @@ } } } - } + }, + "required": true }, "indices.simulate_template": { "content": { @@ -119463,7 +119454,8 @@ } } } - } + }, + "required": true }, "indices.validate_query": { "content": { @@ -119512,7 +119504,8 @@ ] } } - } + }, + "required": true }, "inference.put": { "content": { @@ -120163,7 +120156,8 @@ } } } - } + }, + "required": true }, "rollup.rollup_search": { "content": { @@ -120235,7 +120229,8 @@ } } } - } + }, + "required": true }, "scroll": { "content": { @@ -121552,7 +121547,8 @@ } } } - } + }, + "required": true }, "termvectors": { "content": { @@ -121845,7 +121841,8 @@ } } } - } + }, + "required": true }, "watcher.query_watches": { "content": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 04551230de..2ae0443b9e 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1615,7 +1615,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -8225,7 +8226,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -8409,7 +8411,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -10084,7 +10087,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -10406,7 +10410,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -10493,7 +10498,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -10574,7 +10580,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -10661,7 +10668,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -10748,7 +10756,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -10835,7 +10844,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -10942,7 +10952,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11032,7 +11043,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11118,7 +11130,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11205,7 +11218,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11292,7 +11306,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11379,7 +11394,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11457,7 +11473,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11544,7 +11561,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11631,7 +11649,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11706,7 +11725,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11806,7 +11826,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11907,7 +11928,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -11998,7 +12020,8 @@ } } } - } + }, + "required": true }, "responses": { "200": { @@ -67044,6 +67067,7 @@ "eql.search-allow_no_indices": { "in": "query", "name": "allow_no_indices", + "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)", "deprecated": false, "schema": { "type": "boolean" @@ -67073,6 +67097,7 @@ "eql.search-expand_wildcards": { "in": "query", "name": "expand_wildcards", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types.ExpandWildcards" @@ -71402,7 +71427,8 @@ } } } - } + }, + "required": true }, "index": { "content": { @@ -71514,7 +71540,8 @@ } } } - } + }, + "required": true }, "indices.put_alias": { "content": { @@ -71851,7 +71878,8 @@ ] } } - } + }, + "required": true }, "inference.put": { "content": { @@ -72217,7 +72245,8 @@ } } } - } + }, + "required": true }, "scripts_painless_execute": { "content": { @@ -72254,7 +72283,8 @@ } } } - } + }, + "required": true }, "scroll": { "content": { @@ -73029,7 +73059,8 @@ } } } - } + }, + "required": true }, "termvectors": { "content": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 5f7c5bfa03..b7ed1b425e 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -14,8 +14,8 @@ "visibility": "private" } }, - "description": "This API is a diagnostics API and the output should not be relied upon for building applications.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-balance.html", + "description": "This API is a diagnostics API and the output should not be relied upon for building applications", + "docUrl": null, "name": "_internal.delete_desired_balance", "request": null, "requestBodyRequired": false, @@ -39,8 +39,8 @@ "visibility": "private" } }, - "description": "Deletes the desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-nodes.html", + "description": "Designed for indirect use by ECE/ESS and ECK, direct use is not supported.", + "docUrl": null, "name": "_internal.delete_desired_nodes", "request": null, "requestBodyRequired": false, @@ -64,8 +64,8 @@ "visibility": "private" } }, - "description": "This API is a diagnostics API and the output should not be relied upon for building applications.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-balance.html", + "description": "This API is a diagnostics API and the output should not be relied upon for building applications", + "docUrl": null, "name": "_internal.get_desired_balance", "request": null, "requestBodyRequired": false, @@ -89,8 +89,8 @@ "visibility": "private" } }, - "description": "Gets the latest desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-nodes.html", + "description": "Gets the latest desired nodes", + "docUrl": null, "name": "_internal.get_desired_nodes", "request": null, "requestBodyRequired": false, @@ -110,12 +110,12 @@ { "availability": { "stack": { - "stability": "stable", + "stability": "experimental", "visibility": "private" } }, "description": "Prevalidates node removal from the cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/prevalidate-node-removal-api.html", + "docUrl": null, "name": "_internal.prevalidate_node_removal", "request": null, "requestBodyRequired": false, @@ -139,8 +139,8 @@ "visibility": "private" } }, - "description": "Updates the desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-desired-nodes.html", + "description": "Designed for indirect use by ECE/ESS and ECK, direct use is not supported.", + "docUrl": null, "name": "_internal.update_desired_nodes", "request": null, "requestBodyRequired": true, @@ -2290,7 +2290,7 @@ "name": "Request", "namespace": "_global.close_point_in_time" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -3255,7 +3255,7 @@ "visibility": "private" } }, - "description": "Deletes a connector secret.", + "description": "Deletes a connector secret", "docUrl": null, "name": "connector.secret_delete", "request": null, @@ -3280,7 +3280,7 @@ "visibility": "private" } }, - "description": "Retrieves a secret stored by Connectors.", + "description": "Retrieves a secret stored by Connectors", "docUrl": null, "name": "connector.secret_get", "request": null, @@ -3305,7 +3305,7 @@ "visibility": "private" } }, - "description": "Creates a secret for a Connector.", + "description": "Creates a secret for a Connector", "docUrl": null, "name": "connector.secret_post", "request": null, @@ -3330,7 +3330,7 @@ "visibility": "private" } }, - "description": "Creates or updates a secret for a Connector.", + "description": "Creates or updates a secret for a Connector", "docUrl": null, "name": "connector.secret_put", "request": null, @@ -5108,7 +5108,9 @@ "name": "Response", "namespace": "esql.get_query" }, - "responseMediaType": [], + "responseMediaType": [ + "application/json" + ], "urls": [ { "methods": [ @@ -5455,7 +5457,7 @@ "visibility": "private" } }, - "description": "Deletes a secret stored by Fleet.", + "description": "Deletes a secret stored by Fleet", "docUrl": null, "name": "fleet.delete_secret", "request": null, @@ -5480,7 +5482,7 @@ "visibility": "private" } }, - "description": "Retrieves a secret stored by Fleet.", + "description": "Retrieves a secret stored by Fleet", "docUrl": null, "name": "fleet.get_secret", "request": null, @@ -5596,7 +5598,7 @@ "visibility": "private" } }, - "description": "Creates a secret stored by Fleet.", + "description": "Creates a secret stored by Fleet", "docUrl": null, "name": "fleet.post_secret", "request": null, @@ -5638,7 +5640,7 @@ "name": "Request", "namespace": "fleet.search" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -5878,7 +5880,7 @@ "name": "Request", "namespace": "graph.explore" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -6154,7 +6156,7 @@ "name": "Request", "namespace": "ilm.move_to_step" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -6199,7 +6201,7 @@ "name": "Request", "namespace": "ilm.put_lifecycle" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -6481,7 +6483,7 @@ "name": "Request", "namespace": "indices.analyze" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -7027,7 +7029,7 @@ } }, "description": "Delete data stream options.\nRemoves the data stream options from a data stream.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream-options", "name": "indices.delete_data_stream_options", "request": { "name": "Request", @@ -7091,6 +7093,34 @@ } ] }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Delete sampling configuration for an index or data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration", + "name": "indices.delete_sample_configuration", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "DELETE" + ], + "path": "/{index}/_sample/config" + } + ] + }, { "availability": { "stack": { @@ -7630,6 +7660,31 @@ } ] }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Get sampling configurations for all indices and data streams", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-all-sample-configuration", + "name": "indices.get_all_sample_configuration", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_sample/config" + } + ] + }, { "availability": { "serverless": { @@ -7753,6 +7808,31 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Get data stream mappings", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-mappings", + "name": "indices.get_data_stream_mappings", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_data_stream/{name}/_mappings" + } + ] + }, { "availability": { "serverless": { @@ -7766,7 +7846,7 @@ }, "description": "Get data stream options.\n\nGet the data stream options configuration of one or more data streams.", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-options", "name": "indices.get_data_stream_options", "request": { "name": "Request", @@ -8007,6 +8087,81 @@ } ] }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Get random sample of ingested data", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample", + "name": "indices.get_sample", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/{index}/_sample" + } + ] + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Get sampling configuration for an index or data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample-configuration", + "name": "indices.get_sample_configuration", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/{index}/_sample/config" + } + ] + }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Get stats about a random sample of ingested data", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample", + "name": "indices.get_sample_stats", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/{index}/_sample/stats" + } + ] + }, { "availability": { "serverless": { @@ -8370,7 +8525,7 @@ "name": "Request", "namespace": "indices.put_data_lifecycle" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -8390,6 +8545,31 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Update data stream mappings", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-mappings", + "name": "indices.put_data_stream_mappings", + "request": null, + "requestBodyRequired": true, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_data_stream/{name}/_mappings" + } + ] + }, { "availability": { "serverless": { @@ -8403,13 +8583,13 @@ }, "description": "Update data stream options.\nUpdate the data stream options of the specified data streams.", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-options", "name": "indices.put_data_stream_options", "request": { "name": "Request", "namespace": "indices.put_data_stream_options" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -8563,6 +8743,34 @@ } ] }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Configure sampling for an index or data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-sample-configuration", + "name": "indices.put_sample_configuration", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/{index}/_sample/config" + } + ] + }, { "availability": { "serverless": { @@ -8795,6 +9003,31 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Remove an index block", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block", + "name": "indices.remove_block", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "DELETE" + ], + "path": "/{index}/_block/{block}" + } + ] + }, { "availability": { "stack": { @@ -9037,7 +9270,7 @@ "name": "Request", "namespace": "indices.shrink" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9171,7 +9404,7 @@ "name": "Request", "namespace": "indices.split" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9397,7 +9630,7 @@ "name": "Request", "namespace": "inference.completion" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9534,7 +9767,7 @@ "name": "Request", "namespace": "inference.inference" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9611,6 +9844,34 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Create a AI21 inference endpoint", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-ai21", + "name": "inference.put_ai21", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{ai21_inference_id}" + } + ] + }, { "availability": { "serverless": { @@ -9636,7 +9897,7 @@ "name": "Request", "namespace": "inference.put_alibabacloud" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9681,7 +9942,7 @@ "name": "Request", "namespace": "inference.put_amazonbedrock" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9701,6 +9962,34 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Create an Amazon SageMaker inference endpoint", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonsagemaker", + "name": "inference.put_amazonsagemaker", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{amazonsagemaker_inference_id}" + } + ] + }, { "availability": { "serverless": { @@ -9726,7 +10015,7 @@ "name": "Request", "namespace": "inference.put_anthropic" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9771,7 +10060,7 @@ "name": "Request", "namespace": "inference.put_azureaistudio" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9816,7 +10105,7 @@ "name": "Request", "namespace": "inference.put_azureopenai" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9861,7 +10150,7 @@ "name": "Request", "namespace": "inference.put_cohere" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9881,6 +10170,90 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Create an Contextual AI inference endpoint", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-contextualai", + "name": "inference.put_contextualai", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{contextualai_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Create a custom inference endpoint", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-custom", + "name": "inference.put_custom", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{custom_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Create a DeepSeek inference endpoint", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-deepseek", + "name": "inference.put_deepseek", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{deepseek_inference_id}" + } + ] + }, { "availability": { "serverless": { @@ -9906,7 +10279,7 @@ "name": "Request", "namespace": "inference.put_elasticsearch" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -9955,7 +10328,7 @@ "name": "Request", "namespace": "inference.put_elser" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10000,7 +10373,7 @@ "name": "Request", "namespace": "inference.put_googleaistudio" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10045,7 +10418,7 @@ "name": "Request", "namespace": "inference.put_googlevertexai" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10090,7 +10463,7 @@ "name": "Request", "namespace": "inference.put_hugging_face" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10135,7 +10508,7 @@ "name": "Request", "namespace": "inference.put_jinaai" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10155,6 +10528,34 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Create a Llama inference endpoint", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-llama", + "name": "inference.put_llama", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{llama_inference_id}" + } + ] + }, { "availability": { "serverless": { @@ -10180,7 +10581,7 @@ "name": "Request", "namespace": "inference.put_mistral" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10225,7 +10626,7 @@ "name": "Request", "namespace": "inference.put_openai" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10270,7 +10671,7 @@ "name": "Request", "namespace": "inference.put_voyageai" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10315,7 +10716,7 @@ "name": "Request", "namespace": "inference.put_watsonx" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10360,7 +10761,7 @@ "name": "Request", "namespace": "inference.rerank" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10400,7 +10801,7 @@ "name": "Request", "namespace": "inference.sparse_embedding" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10441,7 +10842,7 @@ "name": "Request", "namespace": "inference.stream_completion" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -10481,7 +10882,7 @@ "name": "Request", "namespace": "inference.text_embedding" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -11090,11 +11491,11 @@ "visibility": "public" } }, - "description": "Performs a kNN search.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", + "description": "Performs a kNN search", + "docUrl": null, "name": "knn_search", "request": null, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -15695,7 +16096,7 @@ "visibility": "private" } }, - "description": "Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.", + "description": "Extracts a UI-optimized structure to render flamegraphs from Universal Profiling", "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", "name": "profiling.flamegraph", "request": null, @@ -15723,7 +16124,7 @@ "visibility": "private" } }, - "description": "Extracts raw stacktrace information from Universal Profiling.", + "description": "Extracts raw stacktrace information from Universal Profiling", "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", "name": "profiling.stacktraces", "request": null, @@ -15751,7 +16152,7 @@ "visibility": "private" } }, - "description": "Returns basic information about the status of Universal Profiling.", + "description": "Returns basic information about the status of Universal Profiling", "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", "name": "profiling.status", "request": null, @@ -15776,7 +16177,7 @@ "visibility": "private" } }, - "description": "Extracts a list of topN functions from Universal Profiling.", + "description": "Extracts a list of topN functions from Universal Profiling", "docUrl": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", "name": "profiling.topn_functions", "request": null, @@ -15797,6 +16198,31 @@ } ] }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Return tags defined for the project", + "docUrl": null, + "name": "project.tags", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_project/tags" + } + ] + }, { "availability": { "serverless": { @@ -16354,7 +16780,7 @@ "name": "Request", "namespace": "_global.render_search_template" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -16745,7 +17171,7 @@ "name": "Request", "namespace": "_global.scripts_painless_execute" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -19061,6 +19487,34 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Get security statistics for all nodes", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-stats", + "name": "security.get_stats", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_security/stats" + } + ] + }, { "availability": { "serverless": { @@ -20785,7 +21239,7 @@ "name": "Request", "namespace": "slm.put_lifecycle" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -21741,6 +22195,86 @@ } ] }, + { + "availability": { + "stack": { + "featureFlag": "logs_stream", + "stability": "experimental", + "visibility": "feature_flag" + } + }, + "description": "Disable the Logs Streams feature for this cluster", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", + "name": "streams.logs_disable", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json", + "text/plain" + ], + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_streams/logs/_disable" + } + ] + }, + { + "availability": { + "stack": { + "featureFlag": "logs_stream", + "stability": "experimental", + "visibility": "feature_flag" + } + }, + "description": "Enable the Logs Streams feature for this cluster", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", + "name": "streams.logs_enable", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json", + "text/plain" + ], + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_streams/logs/_enable" + } + ] + }, + { + "availability": { + "stack": { + "featureFlag": "logs_stream", + "stability": "experimental", + "visibility": "feature_flag" + } + }, + "description": "Return the current status of the streams feature for each streams type", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", + "name": "streams.status", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_streams/status" + } + ] + }, { "availability": { "serverless": { @@ -22189,7 +22723,7 @@ "name": "Request", "namespace": "_global.terms_enum" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -22478,7 +23012,7 @@ "visibility": "public" } }, - "description": "Retrieves transform usage information for transform nodes.", + "description": "Retrieves transform usage information for transform nodes", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html", "name": "transform.get_node_stats", "request": null, @@ -22779,6 +23313,31 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Set upgrade_mode for transform indices", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode", + "name": "transform.set_upgrade_mode", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_transform/set_upgrade_mode" + } + ] + }, { "availability": { "serverless": { @@ -23383,7 +23942,7 @@ "name": "Request", "namespace": "watcher.put_watch" }, - "requestBodyRequired": false, + "requestBodyRequired": true, "requestMediaType": [ "application/json" ], @@ -121462,7 +122021,7 @@ } }, { - "description": "Specify timeout for connection to master", + "description": "Timeout for waiting for new cluster state in case it is blocked", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -132644,6 +133203,7 @@ ], "query": [ { + "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)", "name": "allow_no_indices", "required": false, "serverDefault": true, @@ -132682,6 +133242,7 @@ } }, { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -242292,7 +242853,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotIndexDetails.ts#L23-L28" + "specLocation": "snapshot/_types/SnapshotIndexDetails.ts#L24-L29" }, { "kind": "interface", @@ -243613,55 +244174,6 @@ ], "specLocation": "snapshot/_types/SnapshotShardsStatus.ts#L24-L27" }, - { - "kind": "enum", - "members": [ - { - "name": "start_time" - }, - { - "name": "duration" - }, - { - "name": "name" - }, - { - "name": "index_count" - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "repository" - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "shard_count" - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "failed_shard_count" - } - ], - "name": { - "name": "SnapshotSort", - "namespace": "snapshot._types" - }, - "specLocation": "snapshot/_types/SnapshotInfo.ts#L73-L93" - }, { "kind": "interface", "name": { @@ -245273,59 +245785,9 @@ "namespace": "_types" } } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "description": "Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.\n\nYou can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.\nFor example, the pattern `*,-policy-a-\\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.\nNote that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.\nTo include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.", - "name": "slm_policy_filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "7.14.0" - } - }, - "description": "The sort order for the result.\nThe default behavior is sorting by snapshot start time stamp.", - "name": "sort", - "required": false, - "serverDefault": "start_time", - "type": { - "kind": "instance_of", - "type": { - "name": "SnapshotSort", - "namespace": "snapshot._types" - } - } - }, - { - "description": "If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.\n\nNOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined.", - "name": "verbose", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } } ], - "specLocation": "snapshot/get/SnapshotGetRequest.ts#L27-L158" + "specLocation": "snapshot/get/SnapshotGetRequest.ts#L27-L132" }, { "kind": "response", diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index c08c05427d..00416523ca 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -2,20 +2,158 @@ "endpointErrors": { "async_search.submit": { "request": [ + "Request: missing json spec query parameter 'project_routing'", "interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required", "interface definition _types:RankContainer - Property rrf is a single-variant and must be required" ], "response": [] }, + "cat.aliases": { + "request": [ + "Request: missing json spec query parameter 'bytes'", + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.allocation": { + "request": [ + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.component_templates": { + "request": [ + "Request: missing json spec query parameter 'bytes'", + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.count": { + "request": [ + "Request: missing json spec query parameter 'project_routing'", + "Request: missing json spec query parameter 'bytes'", + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.fielddata": { + "request": [ + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.health": { + "request": [ + "Request: missing json spec query parameter 'bytes'" + ], + "response": [] + }, + "cat.master": { + "request": [ + "Request: missing json spec query parameter 'bytes'", + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.ml_datafeeds": { + "request": [ + "Request: missing json spec query parameter 'bytes'" + ], + "response": [] + }, + "cat.nodeattrs": { + "request": [ + "Request: missing json spec query parameter 'bytes'", + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.pending_tasks": { + "request": [ + "Request: missing json spec query parameter 'bytes'" + ], + "response": [] + }, + "cat.plugins": { + "request": [ + "Request: missing json spec query parameter 'bytes'", + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.repositories": { + "request": [ + "Request: missing json spec query parameter 'bytes'", + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.segments": { + "request": [ + "Request: missing json spec query parameter 'time'", + "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": [] + }, + "cat.snapshots": { + "request": [ + "Request: missing json spec query parameter 'bytes'" + ], + "response": [] + }, + "cat.tasks": { + "request": [ + "Request: missing json spec query parameter 'bytes'" + ], + "response": [] + }, + "cat.templates": { + "request": [ + "Request: missing json spec query parameter 'bytes'", + "Request: missing json spec query parameter 'time'" + ], + "response": [] + }, + "cat.thread_pool": { + "request": [ + "Request: missing json spec query parameter 'bytes'" + ], + "response": [] + }, + "cat.transforms": { + "request": [ + "Request: missing json spec query parameter 'bytes'" + ], + "response": [] + }, + "cluster.allocation_explain": { + "request": [ + "Request: missing json spec query parameter 'index'", + "Request: missing json spec query parameter 'shard'", + "Request: missing json spec query parameter 'primary'", + "Request: missing json spec query parameter 'current_node'" + ], + "response": [] + }, "cluster.get_component_template": { "request": [ - "Request: query parameter 'flat_settings' does not exist in the json spec" + "Request: missing json spec query parameter 'settings_filter'" ], "response": [] }, "cluster.put_component_template": { "request": [ - "Request: missing json spec query parameter 'timeout'" + "Request: missing json spec query parameter 'cause'" + ], + "response": [] + }, + "count": { + "request": [ + "Request: missing json spec query parameter 'project_routing'" ], "response": [] }, @@ -23,17 +161,32 @@ "request": [ "Request: query parameter 'if_primary_term' does not exist in the json spec", "Request: query parameter 'if_seq_no' does not exist in the json spec", - "Request: query parameter 'op_type' does not exist in the json spec", - "Request: query parameter 'require_alias' does not exist in the json spec", - "Request: query parameter 'require_data_stream' does not exist in the json spec" + "Request: query parameter 'op_type' does not exist in the json spec" ], "response": [] }, "eql.search": { "request": [ - "Request: query parameter 'allow_no_indices' does not exist in the json spec", - "Request: query parameter 'expand_wildcards' does not exist in the json spec", - "Request: query parameter 'ignore_unavailable' does not exist in the json spec" + "Request: missing json spec query parameter 'ccs_minimize_roundtrips'", + "Request: missing json spec query parameter 'project_routing'" + ], + "response": [] + }, + "esql.async_query_get": { + "request": [ + "Request: missing json spec query parameter 'format'" + ], + "response": [] + }, + "field_caps": { + "request": [ + "Request: missing json spec query parameter 'project_routing'" + ], + "response": [] + }, + "get": { + "request": [ + "Request: missing json spec query parameter '_source_exclude_vectors'" ], "response": [] }, @@ -49,9 +202,18 @@ ], "response": [] }, - "ingest.get_ip_location_database": { + "indices.recovery": { "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 'allow_no_indices'", + "Request: missing json spec query parameter 'expand_wildcards'" + ], + "response": [] + }, + "indices.resolve_index": { + "request": [ + "Request: missing json spec query parameter 'mode'", + "Request: missing json spec query parameter 'project_routing'" ], "response": [] }, @@ -64,46 +226,46 @@ }, "msearch": { "request": [ - "Request: query parameter 'allow_no_indices' does not exist in the json spec", - "Request: query parameter 'expand_wildcards' does not exist in the json spec", - "Request: query parameter 'ignore_throttled' does not exist in the json spec", - "Request: query parameter 'ignore_unavailable' does not exist in the json spec", - "Request: query parameter 'include_named_queries_score' does not exist in the json spec", - "Request: query parameter 'routing' does not exist in the json spec" + "Request: missing json spec query parameter 'index'", + "Request: missing json spec query parameter 'project_routing'" + ], + "response": [] + }, + "msearch_template": { + "request": [ + "Request: missing json spec query parameter 'project_routing'" ], "response": [] }, "open_point_in_time": { "request": [ - "Request: query parameter 'max_concurrent_shard_requests' does not exist in the json spec" + "Request: missing json spec query parameter 'project_routing'" ], "response": [] }, "reindex": { "request": [ - "Request: query parameter 'require_alias' does not exist in the json spec", "Request: missing json spec query parameter 'max_docs'" ], "response": [] }, - "search_mvt": { + "search": { "request": [ - "Request: query parameter 'grid_agg' does not exist in the json spec", - "Request: missing json spec query parameter 'track_total_hits'" + "Request: missing json spec query parameter 'project_routing'", + "Request: missing json spec query parameter '_source_exclude_vectors'" ], "response": [] }, - "searchable_snapshots.clear_cache": { + "search_mvt": { "request": [ - "Request: missing json spec query parameter 'index'" + "Request: missing json spec query parameter 'project_routing'", + "Request: missing json spec query parameter 'track_total_hits'" ], "response": [] }, - "security.get_user_privileges": { + "search_template": { "request": [ - "Request: query parameter 'application' does not exist in the json spec", - "Request: query parameter 'priviledge' does not exist in the json spec", - "Request: query parameter 'username' does not exist in the json spec" + "Request: missing json spec query parameter 'project_routing'" ], "response": [] }, @@ -113,6 +275,12 @@ ], "response": [] }, + "simulate.ingest": { + "request": [ + "Request: missing json spec query parameter 'merge_type'" + ], + "response": [] + }, "snapshot.delete": { "request": [ "Request: missing json spec query parameter 'wait_for_completion'" @@ -121,13 +289,16 @@ }, "snapshot.get": { "request": [ + "Request: missing json spec query parameter 'sort'", + "Request: missing json spec query parameter 'slm_policy_filter'", + "Request: missing json spec query parameter 'verbose'", "Request: missing json spec query parameter 'state'" ], "response": [] }, - "snapshot.repository_analyze": { + "sql.query": { "request": [ - "Request: query parameter 'register_operation_count' does not exist in the json spec" + "Request: missing json spec query parameter 'project_routing'" ], "response": [] }, diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 4ad93b3da8..cb93b7cf54 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -21007,8 +21007,6 @@ export interface SnapshotSnapshotShardsStatus { stats: SnapshotShardsStatsSummary } -export type SnapshotSnapshotSort = 'start_time' | 'duration' | 'name' | 'index_count' | 'repository' | 'shard_count' | 'failed_shard_count' - export interface SnapshotSnapshotStats { incremental: SnapshotFileCountSnapshotStats start_time_in_millis: EpochTime @@ -21127,9 +21125,6 @@ export interface SnapshotGetRequest extends RequestBase { order?: SortOrder offset?: integer size?: integer - slm_policy_filter?: Name - sort?: SnapshotSnapshotSort - verbose?: boolean } export interface SnapshotGetResponse { diff --git a/package-lock.json b/package-lock.json index d8f36c63ae..50f5452c2d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,7 +5,7 @@ "packages": { "": { "dependencies": { - "@redocly/cli": "^1.34.3", + "@redocly/cli": "^1.34.5", "@stoplight/spectral-cli": "^6.14.2" } }, @@ -33,9 +33,9 @@ } }, "node_modules/@babel/helper-validator-identifier": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.27.1.tgz", - "integrity": "sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow==", + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", "license": "MIT", "engines": { "node": ">=6.9.0" @@ -489,9 +489,9 @@ } }, "node_modules/@redocly/cli": { - "version": "1.34.3", - "resolved": "https://registry.npmjs.org/@redocly/cli/-/cli-1.34.3.tgz", - "integrity": "sha512-GJNBTMfm5wTCtH6K+RtPQZuGbqflMclXqAZ5My12tfux6xFDMW1l0MNd5RMpnIS1aeFcDX++P1gnnROWlesj4w==", + "version": "1.34.5", + "resolved": "https://registry.npmjs.org/@redocly/cli/-/cli-1.34.5.tgz", + "integrity": "sha512-5IEwxs7SGP5KEXjBKLU8Ffdz9by/KqNSeBk6YUVQaGxMXK//uYlTJIPntgUXbo1KAGG2d2q2XF8y4iFz6qNeiw==", "license": "MIT", "dependencies": { "@opentelemetry/api": "1.9.0", @@ -500,14 +500,14 @@ "@opentelemetry/sdk-trace-node": "1.26.0", "@opentelemetry/semantic-conventions": "1.27.0", "@redocly/config": "^0.22.0", - "@redocly/openapi-core": "1.34.3", - "@redocly/respect-core": "1.34.3", + "@redocly/openapi-core": "1.34.5", + "@redocly/respect-core": "1.34.5", "abort-controller": "^3.0.0", "chokidar": "^3.5.1", "colorette": "^1.2.0", "core-js": "^3.32.1", - "dotenv": "^16.4.7", - "form-data": "^4.0.0", + "dotenv": "16.4.7", + "form-data": "^4.0.4", "get-port-please": "^3.0.1", "glob": "^7.1.6", "handlebars": "^4.7.6", @@ -537,9 +537,9 @@ "license": "MIT" }, "node_modules/@redocly/openapi-core": { - "version": "1.34.3", - "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.34.3.tgz", - "integrity": "sha512-3arRdUp1fNx55itnjKiUhO6t4Mf91TsrTIYINDNLAZPS0TPd5YpiXRctwjel0qqWoOOhjA34cZ3m4dksLDFUYg==", + "version": "1.34.5", + "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.34.5.tgz", + "integrity": "sha512-0EbE8LRbkogtcCXU7liAyC00n9uNG9hJ+eMyHFdUsy9lB/WGqnEBgwjA9q2cyzAVcdTkQqTBBU1XePNnN3OijA==", "license": "MIT", "dependencies": { "@redocly/ajv": "^8.11.2", @@ -558,20 +558,20 @@ } }, "node_modules/@redocly/respect-core": { - "version": "1.34.3", - "resolved": "https://registry.npmjs.org/@redocly/respect-core/-/respect-core-1.34.3.tgz", - "integrity": "sha512-vo/gu7dRGwTVsRueVSjVk04jOQuL0w22RBJRdRUWkfyse791tYXgMCOx35ijKekL83Q/7Okxf/YX6UY1v5CAug==", + "version": "1.34.5", + "resolved": "https://registry.npmjs.org/@redocly/respect-core/-/respect-core-1.34.5.tgz", + "integrity": "sha512-GheC/g/QFztPe9UA9LamooSplQuy9pe0Yr8XGTqkz0ahivLDl7svoy/LSQNn1QH3XGtLKwFYMfTwFR2TAYyh5Q==", "license": "MIT", "dependencies": { "@faker-js/faker": "^7.6.0", "@redocly/ajv": "8.11.2", - "@redocly/openapi-core": "1.34.3", + "@redocly/openapi-core": "1.34.5", "better-ajv-errors": "^1.2.0", "colorette": "^2.0.20", "concat-stream": "^2.0.0", "cookie": "^0.7.2", - "dotenv": "16.4.5", - "form-data": "4.0.0", + "dotenv": "16.4.7", + "form-data": "^4.0.4", "jest-diff": "^29.3.1", "jest-matcher-utils": "^29.3.1", "js-yaml": "4.1.0", @@ -594,32 +594,6 @@ "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==", "license": "MIT" }, - "node_modules/@redocly/respect-core/node_modules/dotenv": { - "version": "16.4.5", - "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.5.tgz", - "integrity": "sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==", - "license": "BSD-2-Clause", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://dotenvx.com" - } - }, - "node_modules/@redocly/respect-core/node_modules/form-data": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz", - "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==", - "license": "MIT", - "dependencies": { - "asynckit": "^0.4.0", - "combined-stream": "^1.0.8", - "mime-types": "^2.1.12" - }, - "engines": { - "node": ">= 6" - } - }, "node_modules/@rollup/plugin-commonjs": { "version": "22.0.2", "resolved": "https://registry.npmjs.org/@rollup/plugin-commonjs/-/plugin-commonjs-22.0.2.tgz", @@ -1961,9 +1935,9 @@ } }, "node_modules/dotenv": { - "version": "16.5.0", - "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.5.0.tgz", - "integrity": "sha512-m/C+AwOAr9/W1UOIZUo232ejMNnJAJtYQjUbHoNTBNTJSvqzzDh7vnrei3o3r3m9blf6ZoDkvcw0VmozNRFJxg==", + "version": "16.4.7", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.7.tgz", + "integrity": "sha512-47qPchRCykZC03FhkYAhrvwU4xDBFIj1QPqaarj6mdM/hgUzfPHcpkHJOn3mJAufFeeAxAzeGsr5X0M4k6fLZQ==", "license": "BSD-2-Clause", "engines": { "node": ">=12" @@ -2291,9 +2265,9 @@ "license": "MIT" }, "node_modules/form-data": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.3.tgz", - "integrity": "sha512-qsITQPfmvMOSAdeyZ+12I1c+CKSstAFAwu+97zrnWAbIr5u8wfsExUzCesVLC8NgHuRUqNN4Zy6UPWUTRGslcA==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.4.tgz", + "integrity": "sha512-KrGhL9Q4zjj0kiUt5OO4Mr/A/jlI2jDYs5eHBpYHPcBEVSiipAvn2Ko2HnPe20rmcuuvMHNdZFp+4IlGTMF0Ow==", "license": "MIT", "dependencies": { "asynckit": "^0.4.0", @@ -3761,15 +3735,15 @@ } }, "node_modules/open": { - "version": "10.1.2", - "resolved": "https://registry.npmjs.org/open/-/open-10.1.2.tgz", - "integrity": "sha512-cxN6aIDPz6rm8hbebcP7vrQNhvRcveZoJU72Y7vskh4oIm+BZwBECnx5nTmrlres1Qapvx27Qo1Auukpf8PKXw==", + "version": "10.2.0", + "resolved": "https://registry.npmjs.org/open/-/open-10.2.0.tgz", + "integrity": "sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA==", "license": "MIT", "dependencies": { "default-browser": "^5.2.1", "define-lazy-prop": "^3.0.0", "is-inside-container": "^1.0.0", - "is-wsl": "^3.1.0" + "wsl-utils": "^0.1.0" }, "engines": { "node": ">=18" @@ -4270,9 +4244,9 @@ } }, "node_modules/run-applescript": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/run-applescript/-/run-applescript-7.0.0.tgz", - "integrity": "sha512-9by4Ij99JUr/MCFBUkDKLWK3G9HVXmabKz9U5MlIAIuvuzkiOicRYs8XJLxX+xahD+mLiiCYDqF9dKAgtzKP1A==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/run-applescript/-/run-applescript-7.1.0.tgz", + "integrity": "sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q==", "license": "MIT", "engines": { "node": ">=18" @@ -5021,9 +4995,9 @@ } }, "node_modules/undici": { - "version": "6.21.3", - "resolved": "https://registry.npmjs.org/undici/-/undici-6.21.3.tgz", - "integrity": "sha512-gBLkYIlEnSp8pFbT64yFgGE6UIB9tAkhukC23PmMDCe5Nd+cRqKxSjw5y54MK2AZMgZfJWMaNE4nYUHgi1XEOw==", + "version": "6.22.0", + "resolved": "https://registry.npmjs.org/undici/-/undici-6.22.0.tgz", + "integrity": "sha512-hU/10obOIu62MGYjdskASR3CUAiYaFTtC9Pa6vHyf//mAipSvSQg6od2CnJswq7fvzNS3zJhxoRkgNVaHurWKw==", "license": "MIT", "engines": { "node": ">=18.17" @@ -5246,6 +5220,21 @@ } } }, + "node_modules/wsl-utils": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/wsl-utils/-/wsl-utils-0.1.0.tgz", + "integrity": "sha512-h3Fbisa2nKGPxCpm89Hk33lBLsnaGBvctQopaBSOW/uIs6FTe1ATyAnKFJrzVs9vpGdsTe73WF3V4lIsk4Gacw==", + "license": "MIT", + "dependencies": { + "is-wsl": "^3.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/y18n": { "version": "5.0.8", "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", diff --git a/package.json b/package.json index 894d629b9b..a8d71d5a7b 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "transform-to-openapi": "npm run transform-to-openapi --prefix compiler --" }, "dependencies": { - "@redocly/cli": "^1.34.3", + "@redocly/cli": "^1.34.5", "@stoplight/spectral-cli": "^6.14.2" } } diff --git a/specification/_json_spec/_internal.delete_desired_balance.json b/specification/_json_spec/_internal.delete_desired_balance.json index af574d6f08..5a917cce51 100644 --- a/specification/_json_spec/_internal.delete_desired_balance.json +++ b/specification/_json_spec/_internal.delete_desired_balance.json @@ -1,8 +1,8 @@ { "_internal.delete_desired_balance": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-balance.html", - "description": "This API is a diagnostics API and the output should not be relied upon for building applications." + "url": null, + "description": "This API is a diagnostics API and the output should not be relied upon for building applications" }, "stability": "experimental", "visibility": "private", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" } } diff --git a/specification/_json_spec/_internal.delete_desired_nodes.json b/specification/_json_spec/_internal.delete_desired_nodes.json index 80e32032b6..f1d561d132 100644 --- a/specification/_json_spec/_internal.delete_desired_nodes.json +++ b/specification/_json_spec/_internal.delete_desired_nodes.json @@ -1,8 +1,8 @@ { "_internal.delete_desired_nodes": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-nodes.html", - "description": "Deletes the desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": null, + "description": "Designed for indirect use by ECE/ESS and ECK, direct use is not supported." }, "stability": "experimental", "visibility": "private", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" }, "timeout": { diff --git a/specification/_json_spec/_internal.get_desired_balance.json b/specification/_json_spec/_internal.get_desired_balance.json index f122174d25..70c4ce6a59 100644 --- a/specification/_json_spec/_internal.get_desired_balance.json +++ b/specification/_json_spec/_internal.get_desired_balance.json @@ -1,8 +1,8 @@ { "_internal.get_desired_balance": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-balance.html", - "description": "This API is a diagnostics API and the output should not be relied upon for building applications." + "url": null, + "description": "This API is a diagnostics API and the output should not be relied upon for building applications" }, "stability": "experimental", "visibility": "private", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" } } diff --git a/specification/_json_spec/_internal.get_desired_nodes.json b/specification/_json_spec/_internal.get_desired_nodes.json index d72443a0b0..6b0a03fe8c 100644 --- a/specification/_json_spec/_internal.get_desired_nodes.json +++ b/specification/_json_spec/_internal.get_desired_nodes.json @@ -1,8 +1,8 @@ { "_internal.get_desired_nodes": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-nodes.html", - "description": "Gets the latest desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": null, + "description": "Gets the latest desired nodes" }, "stability": "experimental", "visibility": "private", diff --git a/specification/_json_spec/_internal.prevalidate_node_removal.json b/specification/_json_spec/_internal.prevalidate_node_removal.json index 9d883726f9..9320c6508e 100644 --- a/specification/_json_spec/_internal.prevalidate_node_removal.json +++ b/specification/_json_spec/_internal.prevalidate_node_removal.json @@ -1,10 +1,10 @@ { "_internal.prevalidate_node_removal": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/prevalidate-node-removal-api.html", + "url": null, "description": "Prevalidates node removal from the cluster" }, - "stability": "stable", + "stability": "experimental", "visibility": "private", "headers": { "accept": ["application/json"] @@ -32,6 +32,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { diff --git a/specification/_json_spec/_internal.update_desired_nodes.json b/specification/_json_spec/_internal.update_desired_nodes.json index 9125984eee..72c16720c1 100644 --- a/specification/_json_spec/_internal.update_desired_nodes.json +++ b/specification/_json_spec/_internal.update_desired_nodes.json @@ -1,8 +1,8 @@ { "_internal.update_desired_nodes": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-desired-nodes.html", - "description": "Updates the desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": null, + "description": "Designed for indirect use by ECE/ESS and ECK, direct use is not supported." }, "stability": "experimental", "visibility": "private", @@ -21,7 +21,7 @@ "description": "the history id" }, "version": { - "type": "integer", + "type": "int", "description": "the version number" } } diff --git a/specification/_json_spec/async_search.delete.json b/specification/_json_spec/async_search.delete.json index d36d45082e..6e31918855 100644 --- a/specification/_json_spec/async_search.delete.json +++ b/specification/_json_spec/async_search.delete.json @@ -1,8 +1,8 @@ { "async_search.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", - "description": "Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "description": "Delete an async search" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/async_search.get.json b/specification/_json_spec/async_search.get.json index cadf94dba2..f06f8d206b 100644 --- a/specification/_json_spec/async_search.get.json +++ b/specification/_json_spec/async_search.get.json @@ -1,8 +1,8 @@ { "async_search.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", - "description": "Retrieves the results of a previously submitted async search request given its ID." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "description": "Get async search results" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/async_search.status.json b/specification/_json_spec/async_search.status.json index 29a628eb98..6cefe95fe0 100644 --- a/specification/_json_spec/async_search.status.json +++ b/specification/_json_spec/async_search.status.json @@ -1,8 +1,8 @@ { "async_search.status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", - "description": "Retrieves the status of a previously submitted async search request given its ID." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "description": "Get the async search status" }, "stability": "stable", "visibility": "public", @@ -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" } } diff --git a/specification/_json_spec/async_search.submit.json b/specification/_json_spec/async_search.submit.json index 5bff2b1606..bfb55ef4ba 100644 --- a/specification/_json_spec/async_search.submit.json +++ b/specification/_json_spec/async_search.submit.json @@ -1,8 +1,8 @@ { "async_search.submit": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html", - "description": "Executes a search request asynchronously." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "description": "Run an async search" }, "stability": "stable", "visibility": "public", @@ -45,12 +45,13 @@ "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 }, "request_cache": { "type": "boolean", + "default": true, "description": "Specify if request cache should be used for this request or not, defaults to true" }, "analyzer": { @@ -68,8 +69,8 @@ }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -89,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": { @@ -118,6 +119,10 @@ "type": "string", "description": "Specify the node or shard the operation should be performed on (default: random)" }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." + }, "rest_total_hits_as_int": { "type": "boolean", "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", @@ -137,7 +142,7 @@ "description": "Search operation type" }, "size": { - "type": "number", + "type": "int", "description": "Number of hits to return (default: 10)" }, "sort": { @@ -157,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": { @@ -175,7 +180,7 @@ "description": "Specify suggest mode" }, "suggest_size": { - "type": "number", + "type": "long", "description": "How many suggestions to return in response" }, "suggest_text": { @@ -212,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 } } } diff --git a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json index a02953cf9d..20183fcfc9 100644 --- a/specification/_json_spec/autoscaling.delete_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.delete_autoscaling_policy.json @@ -1,8 +1,8 @@ { "autoscaling.delete_autoscaling_policy": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html", - "description": "Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy", + "description": "Delete an autoscaling policy" }, "stability": "stable", "visibility": "private", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/autoscaling.get_autoscaling_capacity.json b/specification/_json_spec/autoscaling.get_autoscaling_capacity.json index 5137f8d7c3..0d6844476b 100644 --- a/specification/_json_spec/autoscaling.get_autoscaling_capacity.json +++ b/specification/_json_spec/autoscaling.get_autoscaling_capacity.json @@ -1,8 +1,8 @@ { "autoscaling.get_autoscaling_capacity": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html", - "description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity", + "description": "Get the autoscaling capacity" }, "stability": "stable", "visibility": "private", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/autoscaling.get_autoscaling_policy.json b/specification/_json_spec/autoscaling.get_autoscaling_policy.json index cfec626ff6..b3380cc855 100644 --- a/specification/_json_spec/autoscaling.get_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.get_autoscaling_policy.json @@ -1,8 +1,8 @@ { "autoscaling.get_autoscaling_policy": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html", - "description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity", + "description": "Get an autoscaling policy" }, "stability": "stable", "visibility": "private", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/autoscaling.put_autoscaling_policy.json b/specification/_json_spec/autoscaling.put_autoscaling_policy.json index 2334b59a74..48ecc2294e 100644 --- a/specification/_json_spec/autoscaling.put_autoscaling_policy.json +++ b/specification/_json_spec/autoscaling.put_autoscaling_policy.json @@ -1,8 +1,8 @@ { "autoscaling.put_autoscaling_policy": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html", - "description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy", + "description": "Create or update an autoscaling policy" }, "stability": "stable", "visibility": "private", @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, diff --git a/specification/_json_spec/bulk.json b/specification/_json_spec/bulk.json index 8e35c3fbf1..95dd4f0720 100644 --- a/specification/_json_spec/bulk.json +++ b/specification/_json_spec/bulk.json @@ -1,8 +1,8 @@ { "bulk": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html", - "description": "Allows to perform multiple index/update/delete operations in a single request." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk", + "description": "Bulk index or delete documents" }, "stability": "stable", "visibility": "public", @@ -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": "If true, the request’s actions must target an index alias. Defaults to false." + "default": false, + "description": "If true, the request's actions must target an index alias. Defaults to false." }, "require_data_stream": { "type": "boolean", + "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." } }, diff --git a/specification/_json_spec/cat.aliases.json b/specification/_json_spec/cat.aliases.json index 27e20cf4d8..9fc78fd6fd 100644 --- a/specification/_json_spec/cat.aliases.json +++ b/specification/_json_spec/cat.aliases.json @@ -1,8 +1,8 @@ { "cat.aliases": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html", - "description": "Shows information about currently configured aliases to indices including filter and routing infos." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases", + "description": "Get aliases" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "h": { @@ -58,8 +59,18 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for waiting for new cluster state in case it is blocked", - "default": "30s" + "default": "30s", + "description": "Timeout for waiting for new cluster state in case it is blocked" + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.allocation.json b/specification/_json_spec/cat.allocation.json index 43f6610408..0f41072b13 100644 --- a/specification/_json_spec/cat.allocation.json +++ b/specification/_json_spec/cat.allocation.json @@ -1,8 +1,8 @@ { "cat.allocation": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html", - "description": "Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation", + "description": "Get shard allocation information" }, "stability": "stable", "visibility": "public", @@ -30,19 +30,27 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "bytes": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.component_templates.json b/specification/_json_spec/cat.component_templates.json index 23da11ca96..a0726ba991 100644 --- a/specification/_json_spec/cat.component_templates.json +++ b/specification/_json_spec/cat.component_templates.json @@ -1,8 +1,8 @@ { "cat.component_templates": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html", - "description": "Returns information about existing component_templates templates." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates", + "description": "Get component templates" }, "stability": "stable", "visibility": "public", @@ -30,14 +30,17 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { @@ -57,6 +60,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.count.json b/specification/_json_spec/cat.count.json index 991bd3e79a..360e4d04ce 100644 --- a/specification/_json_spec/cat.count.json +++ b/specification/_json_spec/cat.count.json @@ -1,8 +1,8 @@ { "cat.count": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html", - "description": "Provides quick access to the document count of the entire cluster, or individual indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count", + "description": "Get a document count" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "h": { @@ -41,6 +42,10 @@ "description": "Return help information", "default": false }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." + }, "s": { "type": "list", "description": "Comma-separated list of column names or column aliases to sort by" @@ -49,6 +54,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.fielddata.json b/specification/_json_spec/cat.fielddata.json index 0231ee6049..d99f49cfd0 100644 --- a/specification/_json_spec/cat.fielddata.json +++ b/specification/_json_spec/cat.fielddata.json @@ -1,8 +1,8 @@ { "cat.fielddata": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html", - "description": "Shows how much heap memory is currently being used by fielddata on every data node in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata", + "description": "Get field data cache information" }, "stability": "stable", "visibility": "public", @@ -30,12 +30,13 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "bytes": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "h": { "type": "list", @@ -58,6 +59,11 @@ "fields": { "type": "list", "description": "A comma-separated list of fields to return in the output" + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.health.json b/specification/_json_spec/cat.health.json index 953e5d37c4..2d421cbfbf 100644 --- a/specification/_json_spec/cat.health.json +++ b/specification/_json_spec/cat.health.json @@ -1,8 +1,8 @@ { "cat.health": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html", - "description": "Returns a concise representation of the cluster health." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health", + "description": "Get the cluster health status" }, "stability": "stable", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "h": { @@ -49,6 +50,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.help.json b/specification/_json_spec/cat.help.json index d37747f882..0e31dae1df 100644 --- a/specification/_json_spec/cat.help.json +++ b/specification/_json_spec/cat.help.json @@ -1,8 +1,8 @@ { "cat.help": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html", - "description": "Returns help for the Cat APIs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat", + "description": "Get CAT help" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/cat.indices.json b/specification/_json_spec/cat.indices.json index 025ef367ec..9cb526b086 100644 --- a/specification/_json_spec/cat.indices.json +++ b/specification/_json_spec/cat.indices.json @@ -1,8 +1,8 @@ { "cat.indices": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html", - "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, ..." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices", + "description": "Get index information" }, "stability": "stable", "visibility": "public", @@ -30,15 +30,17 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "bytes": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.master.json b/specification/_json_spec/cat.master.json index 15828d62dc..d57a92fab8 100644 --- a/specification/_json_spec/cat.master.json +++ b/specification/_json_spec/cat.master.json @@ -1,8 +1,8 @@ { "cat.master": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html", - "description": "Returns information about the master node." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master", + "description": "Get master node information" }, "stability": "stable", "visibility": "public", @@ -20,14 +20,17 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { @@ -47,6 +50,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.ml_data_frame_analytics.json b/specification/_json_spec/cat.ml_data_frame_analytics.json index fc21d22a32..240d036f68 100644 --- a/specification/_json_spec/cat.ml_data_frame_analytics.json +++ b/specification/_json_spec/cat.ml_data_frame_analytics.json @@ -1,8 +1,8 @@ { "cat.ml_data_frame_analytics": { "documentation": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html", - "description": "Gets configuration and usage information about data frame analytics jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics", + "description": "Get data frame analytics jobs" }, "stability": "stable", "visibility": "public", @@ -30,20 +30,22 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "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": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "h": { "type": "list", + "default": "create_time,id,state,type", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/specification/_json_spec/cat.ml_datafeeds.json b/specification/_json_spec/cat.ml_datafeeds.json index 5d6cf5066f..3a370e943b 100644 --- a/specification/_json_spec/cat.ml_datafeeds.json +++ b/specification/_json_spec/cat.ml_datafeeds.json @@ -1,8 +1,8 @@ { "cat.ml_datafeeds": { "documentation": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html", - "description": "Gets configuration and usage information about datafeeds." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds", + "description": "Get datafeeds" }, "stability": "stable", "visibility": "public", @@ -30,15 +30,17 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "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": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "h": { "type": "list", + "default": "['bc', 'id', 'sc', 's']", "description": "Comma-separated list of column names to display" }, "help": { @@ -59,6 +61,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.ml_jobs.json b/specification/_json_spec/cat.ml_jobs.json index c59c95afb9..1e1ff05b88 100644 --- a/specification/_json_spec/cat.ml_jobs.json +++ b/specification/_json_spec/cat.ml_jobs.json @@ -1,8 +1,8 @@ { "cat.ml_jobs": { "documentation": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html", - "description": "Gets configuration and usage information about anomaly detection jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs", + "description": "Get anomaly detection jobs" }, "stability": "stable", "visibility": "public", @@ -30,20 +30,22 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "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": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "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": { diff --git a/specification/_json_spec/cat.ml_trained_models.json b/specification/_json_spec/cat.ml_trained_models.json index 9ccab29352..f6a7396972 100644 --- a/specification/_json_spec/cat.ml_trained_models.json +++ b/specification/_json_spec/cat.ml_trained_models.json @@ -1,8 +1,8 @@ { "cat.ml_trained_models": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html", - "description": "Gets configuration and usage information about inference trained models." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models", + "description": "Get trained models" }, "stability": "stable", "visibility": "public", @@ -30,7 +30,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default": true }, @@ -47,10 +46,11 @@ "bytes": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "h": { diff --git a/specification/_json_spec/cat.nodeattrs.json b/specification/_json_spec/cat.nodeattrs.json index 17ba63cb81..0bd62a78d9 100644 --- a/specification/_json_spec/cat.nodeattrs.json +++ b/specification/_json_spec/cat.nodeattrs.json @@ -1,8 +1,8 @@ { "cat.nodeattrs": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html", - "description": "Returns information about custom node attributes." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs", + "description": "Get node attribute information" }, "stability": "stable", "visibility": "public", @@ -20,14 +20,17 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { @@ -47,6 +50,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.nodes.json b/specification/_json_spec/cat.nodes.json index 647c1d1c36..4e687f2e4e 100644 --- a/specification/_json_spec/cat.nodes.json +++ b/specification/_json_spec/cat.nodes.json @@ -1,8 +1,8 @@ { "cat.nodes": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html", - "description": "Returns basic statistics about performance of cluster nodes." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes", + "description": "Get node information" }, "stability": "stable", "visibility": "public", @@ -21,22 +21,26 @@ "bytes": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "full_id": { "type": "boolean", + "default": false, "description": "Return the full node ID instead of the shortened version (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { diff --git a/specification/_json_spec/cat.pending_tasks.json b/specification/_json_spec/cat.pending_tasks.json index ca7c60a235..8db95f12b2 100644 --- a/specification/_json_spec/cat.pending_tasks.json +++ b/specification/_json_spec/cat.pending_tasks.json @@ -1,8 +1,8 @@ { "cat.pending_tasks": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html", - "description": "Returns a concise representation of the cluster pending tasks." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks", + "description": "Get pending task information" }, "stability": "stable", "visibility": "public", @@ -20,14 +20,17 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { @@ -52,6 +55,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.plugins.json b/specification/_json_spec/cat.plugins.json index b625af2e34..77d44dd75a 100644 --- a/specification/_json_spec/cat.plugins.json +++ b/specification/_json_spec/cat.plugins.json @@ -1,8 +1,8 @@ { "cat.plugins": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html", - "description": "Returns information about installed plugins across nodes node." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins", + "description": "Get plugin information" }, "stability": "stable", "visibility": "public", @@ -20,14 +20,17 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { @@ -52,6 +55,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.recovery.json b/specification/_json_spec/cat.recovery.json index 6b64d33102..bf9a513cc8 100644 --- a/specification/_json_spec/cat.recovery.json +++ b/specification/_json_spec/cat.recovery.json @@ -1,8 +1,8 @@ { "cat.recovery": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html", - "description": "Returns information about index shard recoveries, both on-going completed." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery", + "description": "Get shard recovery information" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "active_only": { @@ -40,7 +41,7 @@ "bytes": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "detailed": { "type": "boolean", @@ -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": { diff --git a/specification/_json_spec/cat.repositories.json b/specification/_json_spec/cat.repositories.json index e0d173cdff..7a86196778 100644 --- a/specification/_json_spec/cat.repositories.json +++ b/specification/_json_spec/cat.repositories.json @@ -1,8 +1,8 @@ { "cat.repositories": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html", - "description": "Returns information about snapshot repositories registered in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories", + "description": "Get snapshot repository information" }, "stability": "stable", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "local": { @@ -29,6 +30,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { @@ -48,6 +50,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index 369c813aba..d33bb93cd4 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -1,8 +1,8 @@ { "cat.segments": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html", - "description": "Provides low-level information about the segments in the shards of an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments", + "description": "Get segment information" }, "stability": "stable", "visibility": "public", @@ -30,23 +30,27 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "bytes": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { @@ -62,6 +66,34 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "time": { + "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 } } } diff --git a/specification/_json_spec/cat.shards.json b/specification/_json_spec/cat.shards.json index 700f205cd8..e753db39f3 100644 --- a/specification/_json_spec/cat.shards.json +++ b/specification/_json_spec/cat.shards.json @@ -1,8 +1,8 @@ { "cat.shards": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html", - "description": "Provides a detailed view of shard allocation on nodes." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards", + "description": "Get shard information" }, "stability": "stable", "visibility": "public", @@ -30,15 +30,17 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "bytes": { "type": "enum", "description": "The unit in which to display byte values", - "options": ["b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb"] + "options": ["b", "kb", "mb", "gb", "tb", "pb"] }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { diff --git a/specification/_json_spec/cat.snapshots.json b/specification/_json_spec/cat.snapshots.json index 604560cc4b..9733a93bf0 100644 --- a/specification/_json_spec/cat.snapshots.json +++ b/specification/_json_spec/cat.snapshots.json @@ -1,8 +1,8 @@ { "cat.snapshots": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html", - "description": "Returns all snapshots in a specific repository." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots", + "description": "Get snapshot information" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "ignore_unavailable": { @@ -39,10 +40,12 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { "type": "list", + "default": "ip,hp,rp,r,m,n,cpu,l", "description": "Comma-separated list of column names to display" }, "help": { @@ -63,6 +66,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.tasks.json b/specification/_json_spec/cat.tasks.json index 24164f3857..0d952f290f 100644 --- a/specification/_json_spec/cat.tasks.json +++ b/specification/_json_spec/cat.tasks.json @@ -1,8 +1,8 @@ { "cat.tasks": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", - "description": "Returns information about the tasks currently executing on one or more nodes in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks", + "description": "Get task information" }, "stability": "experimental", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "nodes": { @@ -32,6 +33,7 @@ }, "detailed": { "type": "boolean", + "default": false, "description": "Return detailed task information (default: false)" }, "parent_task_id": { @@ -70,6 +72,11 @@ "type": "boolean", "default": false, "description": "If `true`, the request blocks until the task has completed." + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.templates.json b/specification/_json_spec/cat.templates.json index 993ddf49d0..fc69b211b2 100644 --- a/specification/_json_spec/cat.templates.json +++ b/specification/_json_spec/cat.templates.json @@ -1,8 +1,8 @@ { "cat.templates": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html", - "description": "Returns information about existing templates." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates", + "description": "Get index template information" }, "stability": "stable", "visibility": "public", @@ -30,14 +30,17 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { @@ -57,6 +60,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] + }, + "time": { + "type": "enum", + "description": "The unit in which to display time values", + "options": ["d", "h", "m", "s", "ms", "micros", "nanos"] } } } diff --git a/specification/_json_spec/cat.thread_pool.json b/specification/_json_spec/cat.thread_pool.json index 4b7d5d5e79..4b72a21f2c 100644 --- a/specification/_json_spec/cat.thread_pool.json +++ b/specification/_json_spec/cat.thread_pool.json @@ -1,8 +1,8 @@ { "cat.thread_pool": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html", - "description": "Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool", + "description": "Get thread pool statistics" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "format": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "time": { @@ -39,10 +40,12 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "h": { @@ -62,6 +65,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/cat.transforms.json b/specification/_json_spec/cat.transforms.json index 6af12bf197..99d93b1eb5 100644 --- a/specification/_json_spec/cat.transforms.json +++ b/specification/_json_spec/cat.transforms.json @@ -1,8 +1,8 @@ { "cat.transforms": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html", - "description": "Gets configuration and usage information about transforms." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms", + "description": "Get transform information" }, "stability": "stable", "visibility": "public", @@ -30,25 +30,27 @@ "params": { "from": { "type": "int", - "required": false, + "default": 0, "description": "skips a number of transform configs, defaults to 0" }, "size": { "type": "int", - "required": false, + "default": 100, "description": "specifies a max number of transforms to get, defaults to 100" }, "allow_no_match": { "type": "boolean", - "required": false, + "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": { "type": "string", + "default": "text", "description": "a short version of the Accept header, e.g. json, yaml" }, "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": { @@ -69,6 +71,11 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "bytes": { + "type": "enum", + "description": "The unit in which to display byte values", + "options": ["b", "kb", "mb", "gb", "tb", "pb"] } } } diff --git a/specification/_json_spec/ccr.delete_auto_follow_pattern.json b/specification/_json_spec/ccr.delete_auto_follow_pattern.json index 8609fc4321..3de651d098 100644 --- a/specification/_json_spec/ccr.delete_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.delete_auto_follow_pattern.json @@ -1,8 +1,8 @@ { "ccr.delete_auto_follow_pattern": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html", - "description": "Deletes auto-follow patterns." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern", + "description": "Delete auto-follow patterns" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.follow.json b/specification/_json_spec/ccr.follow.json index c4c098fb6c..6d0bb46e2d 100644 --- a/specification/_json_spec/ccr.follow.json +++ b/specification/_json_spec/ccr.follow.json @@ -1,8 +1,8 @@ { "ccr.follow": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html", - "description": "Creates a new follower index configured to follow the referenced leader index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow", + "description": "Create a follower" }, "stability": "stable", "visibility": "public", @@ -32,6 +32,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } }, diff --git a/specification/_json_spec/ccr.follow_info.json b/specification/_json_spec/ccr.follow_info.json index 286c883ab6..dcff396a56 100644 --- a/specification/_json_spec/ccr.follow_info.json +++ b/specification/_json_spec/ccr.follow_info.json @@ -1,8 +1,8 @@ { "ccr.follow_info": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html", - "description": "Retrieves information about all follower indices, including parameters and status for each follower index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info", + "description": "Get follower information" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.follow_stats.json b/specification/_json_spec/ccr.follow_stats.json index 4c74385e48..0852bb3f4f 100644 --- a/specification/_json_spec/ccr.follow_stats.json +++ b/specification/_json_spec/ccr.follow_stats.json @@ -1,8 +1,8 @@ { "ccr.follow_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html", - "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats", + "description": "Get follower stats" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ccr.forget_follower.json b/specification/_json_spec/ccr.forget_follower.json index 1011971350..b1cab12116 100644 --- a/specification/_json_spec/ccr.forget_follower.json +++ b/specification/_json_spec/ccr.forget_follower.json @@ -1,8 +1,8 @@ { "ccr.forget_follower": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html", - "description": "Removes the follower retention leases from the leader." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower", + "description": "Forget a follower" }, "stability": "stable", "visibility": "public", @@ -27,6 +27,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ccr.get_auto_follow_pattern.json b/specification/_json_spec/ccr.get_auto_follow_pattern.json index 54479b784f..8fcdec0433 100644 --- a/specification/_json_spec/ccr.get_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.get_auto_follow_pattern.json @@ -1,8 +1,8 @@ { "ccr.get_auto_follow_pattern": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html", - "description": "Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1", + "description": "Get auto-follow patterns" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.pause_auto_follow_pattern.json b/specification/_json_spec/ccr.pause_auto_follow_pattern.json index 322a7ac947..91f14ead8f 100644 --- a/specification/_json_spec/ccr.pause_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.pause_auto_follow_pattern.json @@ -1,8 +1,8 @@ { "ccr.pause_auto_follow_pattern": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html", - "description": "Pauses an auto-follow pattern" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern", + "description": "Pause an auto-follow pattern" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.pause_follow.json b/specification/_json_spec/ccr.pause_follow.json index 613219e85f..083a95dcfb 100644 --- a/specification/_json_spec/ccr.pause_follow.json +++ b/specification/_json_spec/ccr.pause_follow.json @@ -1,8 +1,8 @@ { "ccr.pause_follow": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html", - "description": "Pauses a follower index. The follower index will not fetch any additional operations from the leader index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow", + "description": "Pause a follower" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.put_auto_follow_pattern.json b/specification/_json_spec/ccr.put_auto_follow_pattern.json index d631b1b576..e5b74db6ca 100644 --- a/specification/_json_spec/ccr.put_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.put_auto_follow_pattern.json @@ -1,8 +1,8 @@ { "ccr.put_auto_follow_pattern": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html", - "description": "Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern", + "description": "Create or update auto-follow patterns" }, "stability": "stable", "visibility": "public", @@ -27,6 +27,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } }, diff --git a/specification/_json_spec/ccr.resume_auto_follow_pattern.json b/specification/_json_spec/ccr.resume_auto_follow_pattern.json index 90a259b45d..1ad685ae45 100644 --- a/specification/_json_spec/ccr.resume_auto_follow_pattern.json +++ b/specification/_json_spec/ccr.resume_auto_follow_pattern.json @@ -1,8 +1,8 @@ { "ccr.resume_auto_follow_pattern": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html", - "description": "Resumes an auto-follow pattern that has been paused" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern", + "description": "Resume an auto-follow pattern" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.resume_follow.json b/specification/_json_spec/ccr.resume_follow.json index aa2b955970..5562d25e70 100644 --- a/specification/_json_spec/ccr.resume_follow.json +++ b/specification/_json_spec/ccr.resume_follow.json @@ -1,8 +1,8 @@ { "ccr.resume_follow": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html", - "description": "Resumes a follower index that has been paused" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow", + "description": "Resume a follower" }, "stability": "stable", "visibility": "public", @@ -27,6 +27,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } }, diff --git a/specification/_json_spec/ccr.stats.json b/specification/_json_spec/ccr.stats.json index cdaef7c4b4..70993a4f5d 100644 --- a/specification/_json_spec/ccr.stats.json +++ b/specification/_json_spec/ccr.stats.json @@ -1,8 +1,8 @@ { "ccr.stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html", - "description": "Gets all stats related to cross-cluster replication." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats", + "description": "Get cross-cluster replication stats" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ccr.unfollow.json b/specification/_json_spec/ccr.unfollow.json index 61d7a287c1..11d2907e55 100644 --- a/specification/_json_spec/ccr.unfollow.json +++ b/specification/_json_spec/ccr.unfollow.json @@ -1,8 +1,8 @@ { "ccr.unfollow": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html", - "description": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow", + "description": "Unfollow an index" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/clear_scroll.json b/specification/_json_spec/clear_scroll.json index a32a6cd867..72cf6c59df 100644 --- a/specification/_json_spec/clear_scroll.json +++ b/specification/_json_spec/clear_scroll.json @@ -1,8 +1,8 @@ { "clear_scroll": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html", - "description": "Explicitly clears the search context for a scroll." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll", + "description": "Clear a scrolling search" }, "stability": "stable", "visibility": "public", @@ -33,9 +33,9 @@ } ] }, - "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 } } } diff --git a/specification/_json_spec/close_point_in_time.json b/specification/_json_spec/close_point_in_time.json index 8d1676913c..828030f72c 100644 --- a/specification/_json_spec/close_point_in_time.json +++ b/specification/_json_spec/close_point_in_time.json @@ -1,7 +1,7 @@ { "close_point_in_time": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", "description": "Close a point in time" }, "stability": "stable", @@ -18,9 +18,9 @@ } ] }, - "params": {}, "body": { - "description": "a point-in-time id to close" + "description": "a point-in-time id to close", + "required": true } } } diff --git a/specification/_json_spec/cluster.allocation_explain.json b/specification/_json_spec/cluster.allocation_explain.json index 5845751b8c..47056bfda4 100644 --- a/specification/_json_spec/cluster.allocation_explain.json +++ b/specification/_json_spec/cluster.allocation_explain.json @@ -1,8 +1,8 @@ { "cluster.allocation_explain": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html", - "description": "Provides explanations for shard allocations in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain", + "description": "Explain the shard allocations" }, "stability": "stable", "visibility": "public", @@ -19,21 +19,41 @@ ] }, "params": { + "index": { + "type": "string", + "description": "Specifies the name of the index that you would like an explanation for" + }, + "shard": { + "type": "int", + "description": "Specifies the ID of the shard that you would like an explanation for" + }, + "primary": { + "type": "boolean", + "description": "If true, returns explanation for the primary shard for the given shard ID" + }, + "current_node": { + "type": "string", + "description": "Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node" + }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master node" }, "include_yes_decisions": { "type": "boolean", + "default": false, "description": "Return 'YES' decisions in explanation (default: false)" }, "include_disk_info": { "type": "boolean", + "default": false, "description": "Return information about disk usage and shard sizes (default: false)" } }, "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 } } } diff --git a/specification/_json_spec/cluster.delete_component_template.json b/specification/_json_spec/cluster.delete_component_template.json index 83249431ff..19c84afb0c 100644 --- a/specification/_json_spec/cluster.delete_component_template.json +++ b/specification/_json_spec/cluster.delete_component_template.json @@ -1,8 +1,8 @@ { "cluster.delete_component_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", - "description": "Deletes a component template" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "description": "Delete component templates" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/cluster.delete_voting_config_exclusions.json b/specification/_json_spec/cluster.delete_voting_config_exclusions.json index 07f568e2d7..582f16658a 100644 --- a/specification/_json_spec/cluster.delete_voting_config_exclusions.json +++ b/specification/_json_spec/cluster.delete_voting_config_exclusions.json @@ -1,8 +1,8 @@ { "cluster.delete_voting_config_exclusions": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", - "description": "Clears cluster voting config exclusions." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", + "description": "Clear cluster voting config exclusions" }, "stability": "stable", "visibility": "public", @@ -25,8 +25,8 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for submitting request to master", - "default": "30s" + "default": "30s", + "description": "Timeout for submitting request to master" } } } diff --git a/specification/_json_spec/cluster.exists_component_template.json b/specification/_json_spec/cluster.exists_component_template.json index 6151dab26c..0ce28f607f 100644 --- a/specification/_json_spec/cluster.exists_component_template.json +++ b/specification/_json_spec/cluster.exists_component_template.json @@ -1,8 +1,8 @@ { "cluster.exists_component_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", - "description": "Returns information about whether a particular component template exist" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "description": "Check component templates" }, "stability": "stable", "visibility": "public", @@ -26,11 +26,13 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "local": { "deprecated": true, "type": "boolean", + "default": false, "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 index d2d243120d..8c18bfc80f 100644 --- a/specification/_json_spec/cluster.get_component_template.json +++ b/specification/_json_spec/cluster.get_component_template.json @@ -1,8 +1,8 @@ { "cluster.get_component_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", - "description": "Returns one or more component templates" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "description": "Get component templates" }, "stability": "stable", "visibility": "public", @@ -30,16 +30,28 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all default configurations for the component template (default: false)" + }, + "flat_settings": { + "type": "boolean", + "default": false, + "description": "Return settings in flat format (default: false)" + }, + "settings_filter": { + "type": "string", + "description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys" } } } diff --git a/specification/_json_spec/cluster.get_settings.json b/specification/_json_spec/cluster.get_settings.json index 527bbc1bf7..363a0780ff 100644 --- a/specification/_json_spec/cluster.get_settings.json +++ b/specification/_json_spec/cluster.get_settings.json @@ -1,8 +1,8 @@ { "cluster.get_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-settings.html", - "description": "Returns cluster settings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings", + "description": "Get cluster-wide settings" }, "stability": "stable", "visibility": "public", @@ -20,14 +20,17 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "include_defaults": { diff --git a/specification/_json_spec/cluster.health.json b/specification/_json_spec/cluster.health.json index 9190b9a51f..55c9036715 100644 --- a/specification/_json_spec/cluster.health.json +++ b/specification/_json_spec/cluster.health.json @@ -1,8 +1,8 @@ { "cluster.health": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html", - "description": "Returns basic information about the health of the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health", + "description": "Get the cluster health status" }, "stability": "stable", "visibility": "public", @@ -42,18 +42,22 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "wait_for_active_shards": { "type": "string", + "default": "0", "description": "Wait until the specified number of shards is active" }, "wait_for_nodes": { @@ -67,10 +71,12 @@ }, "wait_for_no_relocating_shards": { "type": "boolean", + "default": false, "description": "Whether to wait until there are no relocating shards in the cluster" }, "wait_for_no_initializing_shards": { "type": "boolean", + "default": false, "description": "Whether to wait until there are no initializing shards in the cluster" }, "wait_for_status": { diff --git a/specification/_json_spec/cluster.info.json b/specification/_json_spec/cluster.info.json index ca6ad6d8e2..ace02dab4c 100644 --- a/specification/_json_spec/cluster.info.json +++ b/specification/_json_spec/cluster.info.json @@ -1,8 +1,8 @@ { "cluster.info": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-info.html", - "description": "Returns different information about the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info", + "description": "Get cluster info" }, "stability": "stable", "visibility": "public", @@ -23,7 +23,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/cluster.pending_tasks.json b/specification/_json_spec/cluster.pending_tasks.json index dc6ca75d6d..27b20916cc 100644 --- a/specification/_json_spec/cluster.pending_tasks.json +++ b/specification/_json_spec/cluster.pending_tasks.json @@ -1,8 +1,8 @@ { "cluster.pending_tasks": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html", - "description": "Returns a list of any cluster-level changes (e.g. create index, update mapping,\nallocate or fail shard) which have not yet been executed." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks", + "description": "Get the pending cluster tasks" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/cluster.post_voting_config_exclusions.json b/specification/_json_spec/cluster.post_voting_config_exclusions.json index 5145d3d685..971a326cfd 100644 --- a/specification/_json_spec/cluster.post_voting_config_exclusions.json +++ b/specification/_json_spec/cluster.post_voting_config_exclusions.json @@ -1,8 +1,8 @@ { "cluster.post_voting_config_exclusions": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html", - "description": "Updates the cluster voting config exclusions by node ids or node names." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", + "description": "Update voting configuration exclusions" }, "stability": "stable", "visibility": "public", @@ -33,8 +33,8 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for submitting request to master", - "default": "30s" + "default": "30s", + "description": "Timeout for submitting request to master" } } } diff --git a/specification/_json_spec/cluster.put_component_template.json b/specification/_json_spec/cluster.put_component_template.json index eed8da7344..18b6b39d26 100644 --- a/specification/_json_spec/cluster.put_component_template.json +++ b/specification/_json_spec/cluster.put_component_template.json @@ -1,8 +1,8 @@ { "cluster.put_component_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html", - "description": "Creates or updates a component template" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "description": "Create or update a component template" }, "stability": "stable", "visibility": "public", @@ -30,12 +30,14 @@ "description": "Whether the index template should only be added if new or can also replace an existing one", "default": false }, - "timeout": { - "type": "time", - "description": "Explicit operation timeout" + "cause": { + "type": "string", + "description": "User defined reason for create the component template", + "default": "api" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/cluster.put_settings.json b/specification/_json_spec/cluster.put_settings.json index d09caabd63..69246ee29c 100644 --- a/specification/_json_spec/cluster.put_settings.json +++ b/specification/_json_spec/cluster.put_settings.json @@ -1,8 +1,8 @@ { "cluster.put_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html", - "description": "Updates the cluster settings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings", + "description": "Update the cluster settings" }, "stability": "stable", "visibility": "public", @@ -25,10 +25,12 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/cluster.remote_info.json b/specification/_json_spec/cluster.remote_info.json index 5917722ffc..4a9f5e4469 100644 --- a/specification/_json_spec/cluster.remote_info.json +++ b/specification/_json_spec/cluster.remote_info.json @@ -1,8 +1,8 @@ { "cluster.remote_info": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html", - "description": "Returns the information about configured remote clusters." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info", + "description": "Get remote cluster information" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/cluster.reroute.json b/specification/_json_spec/cluster.reroute.json index 7278643698..41f86859c0 100644 --- a/specification/_json_spec/cluster.reroute.json +++ b/specification/_json_spec/cluster.reroute.json @@ -1,8 +1,8 @@ { "cluster.reroute": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html", - "description": "Allows to manually change the allocation of individual shards in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute", + "description": "Reroute the cluster" }, "stability": "stable", "visibility": "public", @@ -21,14 +21,17 @@ "params": { "dry_run": { "type": "boolean", + "default": false, "description": "Simulate the operation only and return the resulting state" }, "explain": { "type": "boolean", + "default": false, "description": "Return an explanation of why the commands can or cannot be executed" }, "retry_failed": { "type": "boolean", + "default": false, "description": "Retries allocation of shards that are blocked due to too many subsequent allocation failures" }, "metric": { @@ -43,19 +46,23 @@ "master_node", "version" ], + "default": "all", "description": "Limit the information returned to the specified metrics. Defaults to all but metadata" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)" + "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)", + "required": false } } } diff --git a/specification/_json_spec/cluster.state.json b/specification/_json_spec/cluster.state.json index 09482481f9..265ba6c010 100644 --- a/specification/_json_spec/cluster.state.json +++ b/specification/_json_spec/cluster.state.json @@ -1,8 +1,8 @@ { "cluster.state": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html", - "description": "Returns a comprehensive information about the state of the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state", + "description": "Get the cluster state" }, "stability": "stable", "visibility": "public", @@ -63,19 +63,23 @@ }, "params": { "local": { + "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "master_timeout": { "type": "time", - "description": "Specify timeout for connection to master" + "default": "30s", + "description": "Timeout for waiting for new cluster state in case it is blocked" }, "flat_settings": { "type": "boolean", + "default": false, "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": { @@ -84,10 +88,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/cluster.stats.json b/specification/_json_spec/cluster.stats.json index 993cc16d20..0b51fc9340 100644 --- a/specification/_json_spec/cluster.stats.json +++ b/specification/_json_spec/cluster.stats.json @@ -1,8 +1,8 @@ { "cluster.stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html", - "description": "Returns high-level overview of cluster statistics." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats", + "description": "Get cluster statistics" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "include_remotes": { "type": "boolean", + "default": false, "description": "Include remote cluster data into the response (default: false)" }, "timeout": { diff --git a/specification/_json_spec/connector.check_in.json b/specification/_json_spec/connector.check_in.json index eb81cad389..d2f479125a 100644 --- a/specification/_json_spec/connector.check_in.json +++ b/specification/_json_spec/connector.check_in.json @@ -1,8 +1,8 @@ { "connector.check_in": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-api.html", - "description": "Updates the last_seen timestamp in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in", + "description": "Check in a connector" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.delete.json b/specification/_json_spec/connector.delete.json index 443b7c6d23..760b35b556 100644 --- a/specification/_json_spec/connector.delete.json +++ b/specification/_json_spec/connector.delete.json @@ -1,10 +1,10 @@ { "connector.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-api.html", - "description": "Deletes a connector." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete", + "description": "Delete a connector" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/connector.get.json b/specification/_json_spec/connector.get.json index d8533147ef..cce924c586 100644 --- a/specification/_json_spec/connector.get.json +++ b/specification/_json_spec/connector.get.json @@ -1,10 +1,10 @@ { "connector.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-api.html", - "description": "Returns the details about a connector." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get", + "description": "Get a connector" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/connector.last_sync.json b/specification/_json_spec/connector.last_sync.json index 0ef4e37e5d..7724bbf865 100644 --- a/specification/_json_spec/connector.last_sync.json +++ b/specification/_json_spec/connector.last_sync.json @@ -1,11 +1,11 @@ { "connector.last_sync": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-last-sync-api.html", - "description": "Updates the stats of last sync in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-last-sync", + "description": "Update the connector last sync stats" }, "stability": "experimental", - "visibility": "public", + "visibility": "private", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/connector.list.json b/specification/_json_spec/connector.list.json index fbdeb6e7b2..bb187d0eae 100644 --- a/specification/_json_spec/connector.list.json +++ b/specification/_json_spec/connector.list.json @@ -1,10 +1,10 @@ { "connector.list": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-api.html", - "description": "Lists all connectors." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list", + "description": "Get all connectors" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/connector.post.json b/specification/_json_spec/connector.post.json index db1aeafdd4..6a9faa32fd 100644 --- a/specification/_json_spec/connector.post.json +++ b/specification/_json_spec/connector.post.json @@ -1,10 +1,10 @@ { "connector.post": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html", - "description": "Creates a connector." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put", + "description": "Create a connector" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.put.json b/specification/_json_spec/connector.put.json index 9b584ecbd4..262840f8bd 100644 --- a/specification/_json_spec/connector.put.json +++ b/specification/_json_spec/connector.put.json @@ -1,10 +1,10 @@ { "connector.put": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html", - "description": "Creates or updates a connector." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put", + "description": "Create or update a connector" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.secret_delete.json b/specification/_json_spec/connector.secret_delete.json index e8dd530535..47cb2c5660 100644 --- a/specification/_json_spec/connector.secret_delete.json +++ b/specification/_json_spec/connector.secret_delete.json @@ -2,7 +2,7 @@ "connector.secret_delete": { "documentation": { "url": null, - "description": "Deletes a connector secret." + "description": "Deletes a connector secret" }, "stability": "experimental", "visibility": "private", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/connector.secret_get.json b/specification/_json_spec/connector.secret_get.json index f3240968ce..b1f3f7315c 100644 --- a/specification/_json_spec/connector.secret_get.json +++ b/specification/_json_spec/connector.secret_get.json @@ -2,7 +2,7 @@ "connector.secret_get": { "documentation": { "url": null, - "description": "Retrieves a secret stored by Connectors." + "description": "Retrieves a secret stored by Connectors" }, "stability": "experimental", "visibility": "private", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/connector.secret_post.json b/specification/_json_spec/connector.secret_post.json index 938dc278b2..078d0d2bb3 100644 --- a/specification/_json_spec/connector.secret_post.json +++ b/specification/_json_spec/connector.secret_post.json @@ -2,7 +2,7 @@ "connector.secret_post": { "documentation": { "url": null, - "description": "Creates a secret for a Connector." + "description": "Creates a secret for a Connector" }, "stability": "experimental", "visibility": "private", @@ -17,7 +17,6 @@ } ] }, - "params": {}, "body": { "description": "The secret value to store", "required": true diff --git a/specification/_json_spec/connector.secret_put.json b/specification/_json_spec/connector.secret_put.json index 458713e404..0f1a134071 100644 --- a/specification/_json_spec/connector.secret_put.json +++ b/specification/_json_spec/connector.secret_put.json @@ -2,7 +2,7 @@ "connector.secret_put": { "documentation": { "url": null, - "description": "Creates or updates a secret for a Connector." + "description": "Creates or updates a secret for a Connector" }, "stability": "experimental", "visibility": "private", @@ -23,7 +23,6 @@ } ] }, - "params": {}, "body": { "description": "The secret value to store", "required": true diff --git a/specification/_json_spec/connector.sync_job_cancel.json b/specification/_json_spec/connector.sync_job_cancel.json index 443ba76d0c..436fec4ace 100644 --- a/specification/_json_spec/connector.sync_job_cancel.json +++ b/specification/_json_spec/connector.sync_job_cancel.json @@ -1,10 +1,10 @@ { "connector.sync_job_cancel": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cancel-connector-sync-job-api.html", - "description": "Cancels a connector sync job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel", + "description": "Cancel a connector sync job" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/connector.sync_job_check_in.json b/specification/_json_spec/connector.sync_job_check_in.json index 6f85303bc8..d91f5314e1 100644 --- a/specification/_json_spec/connector.sync_job_check_in.json +++ b/specification/_json_spec/connector.sync_job_check_in.json @@ -1,8 +1,8 @@ { "connector.sync_job_check_in": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html", - "description": "Checks in a connector sync job (refreshes 'last_seen')." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in", + "description": "Check in a connector sync job" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.sync_job_claim.json b/specification/_json_spec/connector.sync_job_claim.json index 29f7f8123c..129569caea 100644 --- a/specification/_json_spec/connector.sync_job_claim.json +++ b/specification/_json_spec/connector.sync_job_claim.json @@ -1,8 +1,8 @@ { "connector.sync_job_claim": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/claim-connector-sync-job-api.html", - "description": "Claims a connector sync job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim", + "description": "Claim a connector sync job" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.sync_job_delete.json b/specification/_json_spec/connector.sync_job_delete.json index 32de4b18a1..38e210555b 100644 --- a/specification/_json_spec/connector.sync_job_delete.json +++ b/specification/_json_spec/connector.sync_job_delete.json @@ -1,10 +1,10 @@ { "connector.sync_job_delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-sync-job-api.html", - "description": "Deletes a connector sync job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete", + "description": "Delete a connector sync job" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/connector.sync_job_error.json b/specification/_json_spec/connector.sync_job_error.json index c4b55aff03..f73e83dfd9 100644 --- a/specification/_json_spec/connector.sync_job_error.json +++ b/specification/_json_spec/connector.sync_job_error.json @@ -1,8 +1,8 @@ { "connector.sync_job_error": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-error-api.html", - "description": "Sets an error for a connector sync job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error", + "description": "Set a connector sync job error" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.sync_job_get.json b/specification/_json_spec/connector.sync_job_get.json index 52c2285cd0..31c49cfee7 100644 --- a/specification/_json_spec/connector.sync_job_get.json +++ b/specification/_json_spec/connector.sync_job_get.json @@ -1,10 +1,10 @@ { "connector.sync_job_get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-sync-job-api.html", - "description": "Returns the details about a connector sync job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get", + "description": "Get a connector sync job" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/connector.sync_job_list.json b/specification/_json_spec/connector.sync_job_list.json index 7a58ea257d..0b74d27d55 100644 --- a/specification/_json_spec/connector.sync_job_list.json +++ b/specification/_json_spec/connector.sync_job_list.json @@ -1,10 +1,10 @@ { "connector.sync_job_list": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-sync-jobs-api.html", - "description": "Lists all connector sync jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list", + "description": "Get all connector sync jobs" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/connector.sync_job_post.json b/specification/_json_spec/connector.sync_job_post.json index 2fd0eb5577..7c801f26e4 100644 --- a/specification/_json_spec/connector.sync_job_post.json +++ b/specification/_json_spec/connector.sync_job_post.json @@ -1,10 +1,10 @@ { "connector.sync_job_post": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-sync-job-api.html", - "description": "Creates a connector sync job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post", + "description": "Create a connector sync job" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.sync_job_update_stats.json b/specification/_json_spec/connector.sync_job_update_stats.json index ce4e5a87a7..7a04a0a669 100644 --- a/specification/_json_spec/connector.sync_job_update_stats.json +++ b/specification/_json_spec/connector.sync_job_update_stats.json @@ -1,8 +1,8 @@ { "connector.sync_job_update_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-stats-api.html", - "description": "Updates the stats fields in the connector sync job document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats", + "description": "Set the connector sync job stats" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.update_active_filtering.json b/specification/_json_spec/connector.update_active_filtering.json index 3886e3359a..80a9f2bccd 100644 --- a/specification/_json_spec/connector.update_active_filtering.json +++ b/specification/_json_spec/connector.update_active_filtering.json @@ -1,8 +1,8 @@ { "connector.update_active_filtering": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html", - "description": "Activates the draft filtering rules if they are in a validated state." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering", + "description": "Activate the connector draft filter" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.update_api_key_id.json b/specification/_json_spec/connector.update_api_key_id.json index b065cc6aad..427fe77da8 100644 --- a/specification/_json_spec/connector.update_api_key_id.json +++ b/specification/_json_spec/connector.update_api_key_id.json @@ -1,10 +1,10 @@ { "connector.update_api_key_id": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-api-key-id-api.html", - "description": "Updates the API key id and/or API key secret id fields in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id", + "description": "Update the connector API key ID" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_configuration.json b/specification/_json_spec/connector.update_configuration.json index 07f3dd4eb4..d7d825aa0c 100644 --- a/specification/_json_spec/connector.update_configuration.json +++ b/specification/_json_spec/connector.update_configuration.json @@ -1,10 +1,10 @@ { "connector.update_configuration": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-configuration-api.html", - "description": "Updates the connector configuration." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration", + "description": "Update the connector configuration" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_error.json b/specification/_json_spec/connector.update_error.json index 5b095850bd..f21f1a4a5a 100644 --- a/specification/_json_spec/connector.update_error.json +++ b/specification/_json_spec/connector.update_error.json @@ -1,8 +1,8 @@ { "connector.update_error": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-error-api.html", - "description": "Updates the error field in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error", + "description": "Update the connector error field" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.update_features.json b/specification/_json_spec/connector.update_features.json index 5bd934ce02..3c352fe2e4 100644 --- a/specification/_json_spec/connector.update_features.json +++ b/specification/_json_spec/connector.update_features.json @@ -1,8 +1,8 @@ { "connector.update_features": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-features-api.html", - "description": "Updates the connector features in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features", + "description": "Update the connector features" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.update_filtering.json b/specification/_json_spec/connector.update_filtering.json index 8779403b22..f96838877f 100644 --- a/specification/_json_spec/connector.update_filtering.json +++ b/specification/_json_spec/connector.update_filtering.json @@ -1,10 +1,10 @@ { "connector.update_filtering": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html", - "description": "Updates the filtering field in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering", + "description": "Update the connector filtering" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_filtering_validation.json b/specification/_json_spec/connector.update_filtering_validation.json index ac58c71d99..4489acfbc7 100644 --- a/specification/_json_spec/connector.update_filtering_validation.json +++ b/specification/_json_spec/connector.update_filtering_validation.json @@ -1,8 +1,8 @@ { "connector.update_filtering_validation": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html", - "description": "Updates the validation info of the draft filtering rules." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering-validation", + "description": "Update the connector draft filtering validation" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/connector.update_index_name.json b/specification/_json_spec/connector.update_index_name.json index 36de276177..b1884abcd7 100644 --- a/specification/_json_spec/connector.update_index_name.json +++ b/specification/_json_spec/connector.update_index_name.json @@ -1,10 +1,10 @@ { "connector.update_index_name": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-index-name-api.html", - "description": "Updates the index name of the connector." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name", + "description": "Update the connector index name" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_name.json b/specification/_json_spec/connector.update_name.json index f68f7ae0a8..57aec4a20e 100644 --- a/specification/_json_spec/connector.update_name.json +++ b/specification/_json_spec/connector.update_name.json @@ -1,10 +1,10 @@ { "connector.update_name": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-name-description-api.html", - "description": "Updates the name and/or description fields in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name", + "description": "Update the connector name and description" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_native.json b/specification/_json_spec/connector.update_native.json index 94296a7f46..d5207d878e 100644 --- a/specification/_json_spec/connector.update_native.json +++ b/specification/_json_spec/connector.update_native.json @@ -1,10 +1,10 @@ { "connector.update_native": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/connector-apis.html", - "description": "Updates the is_native flag of the connector." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-native", + "description": "Update the connector is_native flag" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_pipeline.json b/specification/_json_spec/connector.update_pipeline.json index f9049f6821..6ebb178f31 100644 --- a/specification/_json_spec/connector.update_pipeline.json +++ b/specification/_json_spec/connector.update_pipeline.json @@ -1,10 +1,10 @@ { "connector.update_pipeline": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-pipeline-api.html", - "description": "Updates the pipeline field in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline", + "description": "Update the connector pipeline" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_scheduling.json b/specification/_json_spec/connector.update_scheduling.json index ee8b2544ab..5a4171b229 100644 --- a/specification/_json_spec/connector.update_scheduling.json +++ b/specification/_json_spec/connector.update_scheduling.json @@ -1,10 +1,10 @@ { "connector.update_scheduling": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-scheduling-api.html", - "description": "Updates the scheduling field in the connector document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling", + "description": "Update the connector scheduling" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_service_type.json b/specification/_json_spec/connector.update_service_type.json index 93a2eb1f9c..ba2f6f850a 100644 --- a/specification/_json_spec/connector.update_service_type.json +++ b/specification/_json_spec/connector.update_service_type.json @@ -1,10 +1,10 @@ { "connector.update_service_type": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-service-type-api.html", - "description": "Updates the service type of the connector." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type", + "description": "Update the connector service type" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/connector.update_status.json b/specification/_json_spec/connector.update_status.json index d97db87c60..77e44ad248 100644 --- a/specification/_json_spec/connector.update_status.json +++ b/specification/_json_spec/connector.update_status.json @@ -1,8 +1,8 @@ { "connector.update_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-status-api.html", - "description": "Updates the status of the connector." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status", + "description": "Update the connector status" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/count.json b/specification/_json_spec/count.json index 91ca3e8f79..8581ac3ef2 100644 --- a/specification/_json_spec/count.json +++ b/specification/_json_spec/count.json @@ -1,8 +1,8 @@ { "count": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", - "description": "Returns number of documents matching a query." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count", + "description": "Count search results" }, "stability": "stable", "visibility": "public", @@ -31,14 +31,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -48,13 +51,17 @@ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." }, "min_score": { - "type": "number", + "type": "double", "description": "Include only documents with a specific `_score` value in the result" }, "preference": { "type": "string", "description": "Specify the node or shard the operation should be performed on (default: random)" }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." + }, "routing": { "type": "list", "description": "A comma-separated list of specific routing values" @@ -69,12 +76,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -83,15 +91,17 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "terminate_after": { - "type": "number", + "type": "long", "description": "The maximum count for each shard, upon reaching which the query execution will terminate early" } }, "body": { - "description": "A query to restrict the results specified with the Query DSL (optional)" + "description": "A query to restrict the results specified with the Query DSL (optional)", + "required": false } } } diff --git a/specification/_json_spec/create.json b/specification/_json_spec/create.json index ffa5e0f26e..e472328289 100644 --- a/specification/_json_spec/create.json +++ b/specification/_json_spec/create.json @@ -1,8 +1,8 @@ { "create": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", - "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", + "description": "Create a new document in the index" }, "stability": "stable", "visibility": "public", @@ -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 index 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,10 +46,11 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { @@ -61,7 +64,18 @@ }, "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." + }, + "require_alias": { + "type": "boolean", + "default": false, + "description": "When true, requires destination to be an alias. Default is false" + }, + "require_data_stream": { + "type": "boolean", + "default": false, + "description": "When true, requires destination to be a data stream (existing or to be created). Default is false" } }, "body": { diff --git a/specification/_json_spec/dangling_indices.delete_dangling_index.json b/specification/_json_spec/dangling_indices.delete_dangling_index.json index 052ce3f2dc..7613cd4906 100644 --- a/specification/_json_spec/dangling_indices.delete_dangling_index.json +++ b/specification/_json_spec/dangling_indices.delete_dangling_index.json @@ -1,8 +1,8 @@ { "dangling_indices.delete_dangling_index": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", - "description": "Deletes the specified dangling index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index", + "description": "Delete a dangling index" }, "stability": "stable", "visibility": "public", @@ -34,6 +34,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/dangling_indices.import_dangling_index.json b/specification/_json_spec/dangling_indices.import_dangling_index.json index 69a34fe190..dbc5e0e4df 100644 --- a/specification/_json_spec/dangling_indices.import_dangling_index.json +++ b/specification/_json_spec/dangling_indices.import_dangling_index.json @@ -1,8 +1,8 @@ { "dangling_indices.import_dangling_index": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", - "description": "Imports the specified dangling index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index", + "description": "Import a dangling index" }, "stability": "stable", "visibility": "public", @@ -34,6 +34,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/dangling_indices.list_dangling_indices.json b/specification/_json_spec/dangling_indices.list_dangling_indices.json index 8253b45c3d..879b5eb51f 100644 --- a/specification/_json_spec/dangling_indices.list_dangling_indices.json +++ b/specification/_json_spec/dangling_indices.list_dangling_indices.json @@ -1,8 +1,8 @@ { "dangling_indices.list_dangling_indices": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", - "description": "Returns all dangling indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices", + "description": "Get the dangling indices" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/delete.json b/specification/_json_spec/delete.json index 78d6dee29e..d59aad041b 100644 --- a/specification/_json_spec/delete.json +++ b/specification/_json_spec/delete.json @@ -1,8 +1,8 @@ { "delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", - "description": "Removes a document from the index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete", + "description": "Delete a document" }, "stability": "stable", "visibility": "public", @@ -30,11 +30,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 delete 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": { @@ -43,18 +45,19 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the delete operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the delete operation if the last operation that has changed the document has the specified primary term" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/delete_by_query.json b/specification/_json_spec/delete_by_query.json index c7a1c934c6..d77e88bcab 100644 --- a/specification/_json_spec/delete_by_query.json +++ b/specification/_json_spec/delete_by_query.json @@ -1,8 +1,8 @@ { "delete_by_query": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", - "description": "Deletes documents matching the provided query." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query", + "description": "Delete documents" }, "stability": "stable", "visibility": "public", @@ -31,12 +31,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -44,15 +45,18 @@ "description": "The field to use as default where no field prefix is given in the query string" }, "from": { - "type": "number", + "type": "long", + "default": 0, "description": "Starting offset (default: 0)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "conflicts": { @@ -69,6 +73,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "preference": { @@ -97,7 +102,7 @@ "description": "Explicit timeout for each search request. Defaults to no timeout." }, "max_docs": { - "type": "number", + "type": "long", "description": "Maximum number of documents to process (default: all documents)" }, "sort": { @@ -105,7 +110,7 @@ "description": "A comma-separated list of : pairs" }, "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": { @@ -122,6 +127,7 @@ }, "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -131,11 +137,12 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the delete by query 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)" }, "scroll_size": { - "type": "number", - "default": 100, + "type": "long", + "default": 1000, "description": "Size on the scroll request powering the delete by query" }, "wait_for_completion": { @@ -145,7 +152,7 @@ }, "requests_per_second": { "type": "number", - "default": 0, + "default": -1, "description": "The throttle for this request in sub-requests per second. -1 means no throttle." }, "slices": { diff --git a/specification/_json_spec/delete_by_query_rethrottle.json b/specification/_json_spec/delete_by_query_rethrottle.json index 1c18389c65..fcd0f10fdb 100644 --- a/specification/_json_spec/delete_by_query_rethrottle.json +++ b/specification/_json_spec/delete_by_query_rethrottle.json @@ -1,8 +1,8 @@ { "delete_by_query_rethrottle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", - "description": "Changes the number of requests per second for a particular Delete By Query operation." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query-rethrottle", + "description": "Throttle a delete by query operation" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/delete_script.json b/specification/_json_spec/delete_script.json index 8f67910d1d..e0fb1095c5 100644 --- a/specification/_json_spec/delete_script.json +++ b/specification/_json_spec/delete_script.json @@ -1,8 +1,8 @@ { "delete_script": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", - "description": "Deletes a script." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script", + "description": "Delete a script or search template" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/enrich.delete_policy.json b/specification/_json_spec/enrich.delete_policy.json index 610bc0bac0..f83178ac7a 100644 --- a/specification/_json_spec/enrich.delete_policy.json +++ b/specification/_json_spec/enrich.delete_policy.json @@ -1,8 +1,8 @@ { "enrich.delete_policy": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", - "description": "Deletes an existing enrich policy and its enrich index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy", + "description": "Delete an enrich policy" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/enrich.execute_policy.json b/specification/_json_spec/enrich.execute_policy.json index 31bc3d2e50..3c8689d819 100644 --- a/specification/_json_spec/enrich.execute_policy.json +++ b/specification/_json_spec/enrich.execute_policy.json @@ -1,8 +1,8 @@ { "enrich.execute_policy": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html", - "description": "Creates the enrich index for an existing enrich policy." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy", + "description": "Run an enrich policy" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/enrich.get_policy.json b/specification/_json_spec/enrich.get_policy.json index 9bd3fbcbce..eb32a1b774 100644 --- a/specification/_json_spec/enrich.get_policy.json +++ b/specification/_json_spec/enrich.get_policy.json @@ -1,8 +1,8 @@ { "enrich.get_policy": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", - "description": "Gets information about an enrich policy." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy", + "description": "Get an enrich policy" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" } } diff --git a/specification/_json_spec/enrich.put_policy.json b/specification/_json_spec/enrich.put_policy.json index 8a21aae358..b87c6968e5 100644 --- a/specification/_json_spec/enrich.put_policy.json +++ b/specification/_json_spec/enrich.put_policy.json @@ -1,8 +1,8 @@ { "enrich.put_policy": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html", - "description": "Creates a new enrich policy." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy", + "description": "Create an enrich policy" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/enrich.stats.json b/specification/_json_spec/enrich.stats.json index 9fd95419df..d3dc7c68cc 100644 --- a/specification/_json_spec/enrich.stats.json +++ b/specification/_json_spec/enrich.stats.json @@ -1,8 +1,8 @@ { "enrich.stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", - "description": "Gets enrich coordinator statistics and information about enrich policies that are currently executing." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats", + "description": "Get enrich stats" }, "stability": "stable", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" } } diff --git a/specification/_json_spec/eql.delete.json b/specification/_json_spec/eql.delete.json index d840b9be2c..50c735f5ad 100644 --- a/specification/_json_spec/eql.delete.json +++ b/specification/_json_spec/eql.delete.json @@ -1,8 +1,8 @@ { "eql.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", - "description": "Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete", + "description": "Delete an async EQL search" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/eql.get.json b/specification/_json_spec/eql.get.json index 301867e3e6..e9468abb5d 100644 --- a/specification/_json_spec/eql.get.json +++ b/specification/_json_spec/eql.get.json @@ -1,8 +1,8 @@ { "eql.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", - "description": "Returns async results from previously executed Event Query Language (EQL) search" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get", + "description": "Get async EQL search results" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/eql.get_status.json b/specification/_json_spec/eql.get_status.json index ea54812f73..7da62ff0cc 100644 --- a/specification/_json_spec/eql.get_status.json +++ b/specification/_json_spec/eql.get_status.json @@ -1,8 +1,8 @@ { "eql.get_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", - "description": "Returns the status of a previously submitted async or stored Event Query Language (EQL) search" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status", + "description": "Get the async EQL status" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/eql.search.json b/specification/_json_spec/eql.search.json index 1d9831a6e8..c25c9cf35e 100644 --- a/specification/_json_spec/eql.search.json +++ b/specification/_json_spec/eql.search.json @@ -1,8 +1,8 @@ { "eql.search": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", - "description": "Returns results matching a query expressed in Event Query Language (EQL)" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search", + "description": "Get EQL search results" }, "stability": "stable", "visibility": "public", @@ -48,6 +48,31 @@ "type": "boolean", "description": "Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true.", "default": false + }, + "ccs_minimize_roundtrips": { + "type": "boolean", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", + "default": true + }, + "ignore_unavailable": { + "type": "boolean", + "default": true, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" + }, + "allow_no_indices": { + "type": "boolean", + "default": true, + "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)" + }, + "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." + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." } }, "body": { diff --git a/specification/_json_spec/esql.async_query.json b/specification/_json_spec/esql.async_query.json index 4a61cfe896..737b54a72b 100644 --- a/specification/_json_spec/esql.async_query.json +++ b/specification/_json_spec/esql.async_query.json @@ -1,8 +1,8 @@ { "esql.async_query": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-api.html", - "description": "Executes an ESQL request asynchronously" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query", + "description": "Run an async ES|QL query" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,7 @@ "delimiter": { "type": "string", "description": "The character to use between values within a CSV row. Only valid for the csv format.", - "default": false + "default": "," }, "drop_null_columns": { "type": "boolean", diff --git a/specification/_json_spec/esql.async_query_delete.json b/specification/_json_spec/esql.async_query_delete.json index a6339559af..802c0ae31a 100644 --- a/specification/_json_spec/esql.async_query_delete.json +++ b/specification/_json_spec/esql.async_query_delete.json @@ -1,8 +1,8 @@ { "esql.async_query_delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-delete-api.html", - "description": "Delete an async query request given its ID." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-delete", + "description": "Delete an async ES|QL query" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/esql.async_query_get.json b/specification/_json_spec/esql.async_query_get.json index b2b4b17ccc..9b3e99ad40 100644 --- a/specification/_json_spec/esql.async_query_get.json +++ b/specification/_json_spec/esql.async_query_get.json @@ -1,8 +1,8 @@ { "esql.async_query_get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-get-api.html", - "description": "Retrieves the results of a previously submitted async query request given its ID." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-get", + "description": "Get async ES|QL query results" }, "stability": "stable", "visibility": "public", @@ -24,6 +24,10 @@ ] }, "params": { + "format": { + "type": "string", + "description": "a short version of the Accept header, e.g. json, yaml" + }, "wait_for_completion_timeout": { "type": "time", "description": "Specify the time that the request should block waiting for the final response" diff --git a/specification/_json_spec/esql.async_query_stop.json b/specification/_json_spec/esql.async_query_stop.json index 9d62408c13..28aa4c9d44 100644 --- a/specification/_json_spec/esql.async_query_stop.json +++ b/specification/_json_spec/esql.async_query_stop.json @@ -1,8 +1,8 @@ { "esql.async_query_stop": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-stop-api.html", - "description": "Stops a previously submitted async query request given its ID and collects the results." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-stop", + "description": "Stop async ES|QL query" }, "stability": "stable", "visibility": "public", @@ -22,6 +22,13 @@ } } ] + }, + "params": { + "drop_null_columns": { + "type": "boolean", + "default": false, + "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results." + } } } } diff --git a/specification/_json_spec/esql.get_query.json b/specification/_json_spec/esql.get_query.json index f0a2085495..25588314e3 100644 --- a/specification/_json_spec/esql.get_query.json +++ b/specification/_json_spec/esql.get_query.json @@ -2,12 +2,12 @@ "esql.get_query": { "documentation": { "url": null, - "description": "Executes a get ESQL query request" + "description": "Get a specific running ES|QL query information" }, "stability": "experimental", "visibility": "public", "headers": { - "accept": [], + "accept": ["application/json"], "content_type": ["application/json"] }, "url": { diff --git a/specification/_json_spec/esql.list_queries.json b/specification/_json_spec/esql.list_queries.json index 72c0cbc102..0eddd509ba 100644 --- a/specification/_json_spec/esql.list_queries.json +++ b/specification/_json_spec/esql.list_queries.json @@ -2,7 +2,7 @@ "esql.list_queries": { "documentation": { "url": null, - "description": "Executes a list ESQL queries request" + "description": "Get running ES|QL queries information" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/esql.query.json b/specification/_json_spec/esql.query.json index 65591cfaaa..739c4652bd 100644 --- a/specification/_json_spec/esql.query.json +++ b/specification/_json_spec/esql.query.json @@ -1,8 +1,8 @@ { "esql.query": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html", - "description": "Executes an ESQL request" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest", + "description": "Run an ES|QL query" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,7 @@ "delimiter": { "type": "string", "description": "The character to use between values within a CSV row. Only valid for the csv format.", - "default": false + "default": "," }, "drop_null_columns": { "type": "boolean", diff --git a/specification/_json_spec/exists.json b/specification/_json_spec/exists.json index ef4f0f1a7c..93b53476fd 100644 --- a/specification/_json_spec/exists.json +++ b/specification/_json_spec/exists.json @@ -1,8 +1,8 @@ { "exists": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", - "description": "Returns information about whether a document exists in an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "description": "Check a document" }, "stability": "stable", "visibility": "public", @@ -38,10 +38,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { @@ -61,7 +63,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/exists_source.json b/specification/_json_spec/exists_source.json index 27e5fd8595..574a433543 100644 --- a/specification/_json_spec/exists_source.json +++ b/specification/_json_spec/exists_source.json @@ -1,8 +1,8 @@ { "exists_source": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", - "description": "Returns information about whether a document source exists in an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "description": "Check for a document source" }, "stability": "stable", "visibility": "public", @@ -34,10 +34,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { @@ -57,7 +59,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/explain.json b/specification/_json_spec/explain.json index 5a8a3d08d7..53630185d1 100644 --- a/specification/_json_spec/explain.json +++ b/specification/_json_spec/explain.json @@ -1,8 +1,8 @@ { "explain": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", - "description": "Returns information about why a specific matches (or doesn't match) a query." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain", + "description": "Explain a document match result" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)" }, "analyzer": { @@ -39,8 +40,8 @@ }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -53,6 +54,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "preference": { @@ -81,7 +83,8 @@ } }, "body": { - "description": "The query definition using the Query DSL" + "description": "The query definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/features.get_features.json b/specification/_json_spec/features.get_features.json index e1dfe3a216..7cf84a910d 100644 --- a/specification/_json_spec/features.get_features.json +++ b/specification/_json_spec/features.get_features.json @@ -1,8 +1,8 @@ { "features.get_features": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", - "description": "Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-get-features", + "description": "Get the features" }, "stability": "stable", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/features.reset_features.json b/specification/_json_spec/features.reset_features.json index 7aad720b18..d48ce9da7c 100644 --- a/specification/_json_spec/features.reset_features.json +++ b/specification/_json_spec/features.reset_features.json @@ -1,8 +1,8 @@ { "features.reset_features": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Resets the internal state of features, usually by deleting system indices" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-reset-features", + "description": "Reset the features" }, "stability": "experimental", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/field_caps.json b/specification/_json_spec/field_caps.json index bac569a746..1ae6d2794f 100644 --- a/specification/_json_spec/field_caps.json +++ b/specification/_json_spec/field_caps.json @@ -1,8 +1,8 @@ { "field_caps": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", - "description": "Returns the information about the capabilities of fields among multiple indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps", + "description": "Get the field capabilities" }, "stability": "stable", "visibility": "public", @@ -35,10 +35,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -64,10 +66,15 @@ "type": "boolean", "default": true, "description": "Include empty fields in result" + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." } }, "body": { - "description": "An index filter specified with the Query DSL" + "description": "An index filter specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/fleet.delete_secret.json b/specification/_json_spec/fleet.delete_secret.json index 6b597747bc..db80476d55 100644 --- a/specification/_json_spec/fleet.delete_secret.json +++ b/specification/_json_spec/fleet.delete_secret.json @@ -2,7 +2,7 @@ "fleet.delete_secret": { "documentation": { "url": null, - "description": "Deletes a secret stored by Fleet." + "description": "Deletes a secret stored by Fleet" }, "stability": "experimental", "visibility": "private", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/fleet.get_secret.json b/specification/_json_spec/fleet.get_secret.json index 14d8d9ef5b..5eb05e8ea0 100644 --- a/specification/_json_spec/fleet.get_secret.json +++ b/specification/_json_spec/fleet.get_secret.json @@ -2,7 +2,7 @@ "fleet.get_secret": { "documentation": { "url": null, - "description": "Retrieves a secret stored by Fleet." + "description": "Retrieves a secret stored by Fleet" }, "stability": "experimental", "visibility": "private", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/fleet.global_checkpoints.json b/specification/_json_spec/fleet.global_checkpoints.json index 1b48e57c8e..c69f51d6d7 100644 --- a/specification/_json_spec/fleet.global_checkpoints.json +++ b/specification/_json_spec/fleet.global_checkpoints.json @@ -1,8 +1,8 @@ { "fleet.global_checkpoints": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", - "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-fleet", + "description": "Get global checkpoints" }, "stability": "stable", "visibility": "public", @@ -28,12 +28,12 @@ "wait_for_advance": { "type": "boolean", "description": "Whether to wait for the global checkpoint to advance past the specified current checkpoints", - "default": "false" + "default": false }, "wait_for_index": { "type": "boolean", "description": "Whether to wait for the target index to exist and all primary shards be active", - "default": "false" + "default": false }, "checkpoints": { "type": "list", diff --git a/specification/_json_spec/fleet.msearch.json b/specification/_json_spec/fleet.msearch.json index bc3fcafb8c..d6e1ed8f32 100644 --- a/specification/_json_spec/fleet.msearch.json +++ b/specification/_json_spec/fleet.msearch.json @@ -2,7 +2,7 @@ "fleet.msearch": { "documentation": { "url": null, - "description": "Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project." + "description": "Run multiple Fleet searches" }, "stability": "experimental", "visibility": "public", @@ -28,7 +28,6 @@ } ] }, - "params": {}, "body": { "description": "The request definitions (metadata-fleet search request definition pairs), separated by newlines", "required": true, diff --git a/specification/_json_spec/fleet.post_secret.json b/specification/_json_spec/fleet.post_secret.json index a317196f2f..898a245003 100644 --- a/specification/_json_spec/fleet.post_secret.json +++ b/specification/_json_spec/fleet.post_secret.json @@ -2,7 +2,7 @@ "fleet.post_secret": { "documentation": { "url": null, - "description": "Creates a secret stored by Fleet." + "description": "Creates a secret stored by Fleet" }, "stability": "experimental", "visibility": "private", @@ -17,7 +17,6 @@ } ] }, - "params": {}, "body": { "description": "The secret value to store", "required": true diff --git a/specification/_json_spec/fleet.search.json b/specification/_json_spec/fleet.search.json index b865853c9d..80d62ef84c 100644 --- a/specification/_json_spec/fleet.search.json +++ b/specification/_json_spec/fleet.search.json @@ -2,7 +2,7 @@ "fleet.search": { "documentation": { "url": null, - "description": "Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project." + "description": "Run a Fleet search" }, "stability": "experimental", "visibility": "public", @@ -41,7 +41,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": true } } } diff --git a/specification/_json_spec/get.json b/specification/_json_spec/get.json index a31a57efa4..776455f993 100644 --- a/specification/_json_spec/get.json +++ b/specification/_json_spec/get.json @@ -1,8 +1,8 @@ { "get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", - "description": "Returns a document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "description": "Get a document by its ID" }, "stability": "stable", "visibility": "public", @@ -44,10 +44,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { @@ -66,8 +68,13 @@ "type": "list", "description": "A list of fields to extract and return from the _source field" }, + "_source_exclude_vectors": { + "type": "boolean", + "default": false, + "description": "Whether vectors should be excluded from _source" + }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/get_script.json b/specification/_json_spec/get_script.json index e7cf41e4b7..5eeb5eb50c 100644 --- a/specification/_json_spec/get_script.json +++ b/specification/_json_spec/get_script.json @@ -1,8 +1,8 @@ { "get_script": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", - "description": "Returns a script." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script", + "description": "Get a script or search template" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/get_script_context.json b/specification/_json_spec/get_script_context.json index dcc641af7a..0852f9cc10 100644 --- a/specification/_json_spec/get_script_context.json +++ b/specification/_json_spec/get_script_context.json @@ -1,8 +1,8 @@ { "get_script_context": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", - "description": "Returns all script contexts." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-context", + "description": "Get script contexts" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/get_script_languages.json b/specification/_json_spec/get_script_languages.json index 9af189bee1..11c7f539e6 100644 --- a/specification/_json_spec/get_script_languages.json +++ b/specification/_json_spec/get_script_languages.json @@ -1,8 +1,8 @@ { "get_script_languages": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", - "description": "Returns available script types, languages and contexts" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-languages", + "description": "Get script languages" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/get_source.json b/specification/_json_spec/get_source.json index ac5c97f0dd..6f784c0f55 100644 --- a/specification/_json_spec/get_source.json +++ b/specification/_json_spec/get_source.json @@ -1,8 +1,8 @@ { "get_source": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", - "description": "Returns the source of a document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "description": "Get a document's source" }, "stability": "stable", "visibility": "public", @@ -34,10 +34,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { @@ -57,7 +59,7 @@ "description": "A list of fields to extract and return from the _source field" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/graph.explore.json b/specification/_json_spec/graph.explore.json index a37aa9cd4b..f68a153c7e 100644 --- a/specification/_json_spec/graph.explore.json +++ b/specification/_json_spec/graph.explore.json @@ -1,8 +1,8 @@ { "graph.explore": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html", - "description": "Explore extracted and summarized information about the documents and terms in an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph", + "description": "Explore graph analytics" }, "stability": "stable", "visibility": "public", @@ -35,7 +35,8 @@ } }, "body": { - "description": "Graph Query DSL" + "description": "Graph Query DSL", + "required": true } } } diff --git a/specification/_json_spec/health_report.json b/specification/_json_spec/health_report.json index eed06d006b..c7011d6b8e 100644 --- a/specification/_json_spec/health_report.json +++ b/specification/_json_spec/health_report.json @@ -1,8 +1,8 @@ { "health_report": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html", - "description": "Returns the health of the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report", + "description": "Get the cluster health" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ilm.delete_lifecycle.json b/specification/_json_spec/ilm.delete_lifecycle.json index 32f55522b0..6dd11a2665 100644 --- a/specification/_json_spec/ilm.delete_lifecycle.json +++ b/specification/_json_spec/ilm.delete_lifecycle.json @@ -1,8 +1,8 @@ { "ilm.delete_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", - "description": "Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-delete-lifecycle", + "description": "Delete a lifecycle policy" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.explain_lifecycle.json b/specification/_json_spec/ilm.explain_lifecycle.json index 76a815e79b..51b434ff98 100644 --- a/specification/_json_spec/ilm.explain_lifecycle.json +++ b/specification/_json_spec/ilm.explain_lifecycle.json @@ -1,8 +1,8 @@ { "ilm.explain_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", - "description": "Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-explain-lifecycle", + "description": "Explain the lifecycle state" }, "stability": "stable", "visibility": "public", @@ -34,6 +34,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ilm.get_lifecycle.json b/specification/_json_spec/ilm.get_lifecycle.json index 44c3ea878c..fdb4775d85 100644 --- a/specification/_json_spec/ilm.get_lifecycle.json +++ b/specification/_json_spec/ilm.get_lifecycle.json @@ -1,8 +1,8 @@ { "ilm.get_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", - "description": "Returns the specified policy definition. Includes the policy version and last modified date." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-lifecycle", + "description": "Get lifecycle policies" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.get_status.json b/specification/_json_spec/ilm.get_status.json index b358601271..cd4b2d5c5b 100644 --- a/specification/_json_spec/ilm.get_status.json +++ b/specification/_json_spec/ilm.get_status.json @@ -1,8 +1,8 @@ { "ilm.get_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", - "description": "Retrieves the current index lifecycle management (ILM) status." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status", + "description": "Get the ILM status" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ilm.migrate_to_data_tiers.json b/specification/_json_spec/ilm.migrate_to_data_tiers.json index fdf525a5aa..beb0dcb9a0 100644 --- a/specification/_json_spec/ilm.migrate_to_data_tiers.json +++ b/specification/_json_spec/ilm.migrate_to_data_tiers.json @@ -1,8 +1,8 @@ { "ilm.migrate_to_data_tiers": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", - "description": "Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-migrate-to-data-tiers", + "description": "Migrate to data tiers routing" }, "stability": "stable", "visibility": "public", @@ -21,10 +21,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "dry_run": { "type": "boolean", + "default": false, "description": "If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false" } }, diff --git a/specification/_json_spec/ilm.move_to_step.json b/specification/_json_spec/ilm.move_to_step.json index 3c6c773cc7..a8ce667e77 100644 --- a/specification/_json_spec/ilm.move_to_step.json +++ b/specification/_json_spec/ilm.move_to_step.json @@ -1,8 +1,8 @@ { "ilm.move_to_step": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", - "description": "Manually moves an index into the specified step and executes that step." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-move-to-step", + "description": "Move to a lifecycle step" }, "stability": "stable", "visibility": "public", @@ -24,9 +24,9 @@ } ] }, - "params": {}, "body": { - "description": "The new lifecycle step to move to" + "description": "The new lifecycle step to move to", + "required": true } } } diff --git a/specification/_json_spec/ilm.put_lifecycle.json b/specification/_json_spec/ilm.put_lifecycle.json index 381956a35c..6bdae191ca 100644 --- a/specification/_json_spec/ilm.put_lifecycle.json +++ b/specification/_json_spec/ilm.put_lifecycle.json @@ -1,8 +1,8 @@ { "ilm.put_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", - "description": "Creates a lifecycle policy" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle", + "description": "Create or update a lifecycle policy" }, "stability": "stable", "visibility": "public", @@ -27,15 +27,18 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The lifecycle policy definition to register" + "description": "The lifecycle policy definition to register", + "required": true } } } diff --git a/specification/_json_spec/ilm.remove_policy.json b/specification/_json_spec/ilm.remove_policy.json index 6900754813..2adf8277ed 100644 --- a/specification/_json_spec/ilm.remove_policy.json +++ b/specification/_json_spec/ilm.remove_policy.json @@ -1,8 +1,8 @@ { "ilm.remove_policy": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", - "description": "Removes the assigned lifecycle policy and stops managing the specified index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-remove-policy", + "description": "Remove policies from an index" }, "stability": "stable", "visibility": "public", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ilm.retry.json b/specification/_json_spec/ilm.retry.json index 4cf0a0853a..59d88557f2 100644 --- a/specification/_json_spec/ilm.retry.json +++ b/specification/_json_spec/ilm.retry.json @@ -1,8 +1,8 @@ { "ilm.retry": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", - "description": "Retries executing the policy for an index that is in the ERROR step." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-retry", + "description": "Retry a policy" }, "stability": "stable", "visibility": "public", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ilm.start.json b/specification/_json_spec/ilm.start.json index 893c8c98ba..4c28c02ca8 100644 --- a/specification/_json_spec/ilm.start.json +++ b/specification/_json_spec/ilm.start.json @@ -1,8 +1,8 @@ { "ilm.start": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", - "description": "Start the index lifecycle management (ILM) plugin." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-start", + "description": "Start the ILM plugin" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ilm.stop.json b/specification/_json_spec/ilm.stop.json index b60cd2223d..289c3d12b6 100644 --- a/specification/_json_spec/ilm.stop.json +++ b/specification/_json_spec/ilm.stop.json @@ -1,8 +1,8 @@ { "ilm.stop": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", - "description": "Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop", + "description": "Stop the ILM plugin" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/index.json b/specification/_json_spec/index.json index 3c3df4f67a..f8fd38cd40 100644 --- a/specification/_json_spec/index.json +++ b/specification/_json_spec/index.json @@ -1,8 +1,8 @@ { "index": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", - "description": "Creates or updates a document in an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", + "description": "Create or update a document in an index" }, "stability": "stable", "visibility": "public", @@ -41,6 +41,7 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the index 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)" }, "op_type": { @@ -51,6 +52,7 @@ "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": { @@ -59,10 +61,11 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { @@ -71,11 +74,11 @@ "description": "Specific version type" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the index operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the index operation if the last operation that has changed the document has the specified primary term" }, "pipeline": { @@ -84,14 +87,17 @@ }, "require_alias": { "type": "boolean", + "default": false, "description": "When true, requires destination to be an alias. Default is false" }, "require_data_stream": { "type": "boolean", + "default": false, "description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is 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." } }, diff --git a/specification/_json_spec/indices.add_block.json b/specification/_json_spec/indices.add_block.json index 39009acd56..36cedbc06d 100644 --- a/specification/_json_spec/indices.add_block.json +++ b/specification/_json_spec/indices.add_block.json @@ -1,8 +1,8 @@ { "indices.add_block": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", - "description": "Adds a block to an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block", + "description": "Add an index block" }, "stability": "stable", "visibility": "public", @@ -30,18 +30,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.analyze.json b/specification/_json_spec/indices.analyze.json index 64d7b4c265..7f4d7b6818 100644 --- a/specification/_json_spec/indices.analyze.json +++ b/specification/_json_spec/indices.analyze.json @@ -1,8 +1,8 @@ { "indices.analyze": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html", - "description": "Performs the analysis process on a text and return the tokens breakdown of the text." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze", + "description": "Get tokens from text analysis" }, "stability": "stable", "visibility": "public", @@ -35,7 +35,8 @@ } }, "body": { - "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed" + "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed", + "required": true } } } diff --git a/specification/_json_spec/indices.cancel_migrate_reindex.json b/specification/_json_spec/indices.cancel_migrate_reindex.json index 26d8881201..1def4916f5 100644 --- a/specification/_json_spec/indices.cancel_migrate_reindex.json +++ b/specification/_json_spec/indices.cancel_migrate_reindex.json @@ -1,11 +1,11 @@ { "indices.cancel_migrate_reindex": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-cancel-api.html", - "description": "This API returns the status of a migration reindex attempt for a data stream or index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-cancel-migrate-reindex", + "description": "Cancel a migration reindex operation" }, - "stability": "experimental", - "visibility": "private", + "stability": "stable", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/indices.clear_cache.json b/specification/_json_spec/indices.clear_cache.json index 23b0368491..62ea4b5255 100644 --- a/specification/_json_spec/indices.clear_cache.json +++ b/specification/_json_spec/indices.clear_cache.json @@ -1,8 +1,8 @@ { "indices.clear_cache": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", - "description": "Clears all or specific caches for one or more indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache", + "description": "Clear the cache" }, "stability": "stable", "visibility": "public", @@ -42,10 +42,12 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.clone.json b/specification/_json_spec/indices.clone.json index 6262372409..85e90bd633 100644 --- a/specification/_json_spec/indices.clone.json +++ b/specification/_json_spec/indices.clone.json @@ -1,8 +1,8 @@ { "indices.clone": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", - "description": "Clones an index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone", + "description": "Clone an index" }, "stability": "stable", "visibility": "public", @@ -31,19 +31,23 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the cloned index before the operation returns." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false } } } diff --git a/specification/_json_spec/indices.close.json b/specification/_json_spec/indices.close.json index f8277c18c1..ed9ec0f28b 100644 --- a/specification/_json_spec/indices.close.json +++ b/specification/_json_spec/indices.close.json @@ -1,8 +1,8 @@ { "indices.close": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", - "description": "Closes an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close", + "description": "Close an index" }, "stability": "stable", "visibility": "public", @@ -26,18 +26,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -48,6 +52,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of active shards to wait for before the operation returns." } } diff --git a/specification/_json_spec/indices.create.json b/specification/_json_spec/indices.create.json index e6f41fc992..ca213e498c 100644 --- a/specification/_json_spec/indices.create.json +++ b/specification/_json_spec/indices.create.json @@ -1,8 +1,8 @@ { "indices.create": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html", - "description": "Creates an index with optional settings and mappings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create", + "description": "Create an index" }, "stability": "stable", "visibility": "public", @@ -27,19 +27,23 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for before the operation returns." }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, "body": { - "description": "The configuration for the index (`settings` and `mappings`)" + "description": "The configuration for the index (`settings` and `mappings`)", + "required": false } } } diff --git a/specification/_json_spec/indices.create_data_stream.json b/specification/_json_spec/indices.create_data_stream.json index e3d6b706e8..592e30dcb4 100644 --- a/specification/_json_spec/indices.create_data_stream.json +++ b/specification/_json_spec/indices.create_data_stream.json @@ -1,8 +1,8 @@ { "indices.create_data_stream": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Creates a data stream" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream", + "description": "Create a data stream" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.create_from.json b/specification/_json_spec/indices.create_from.json index 342f560d1c..09048a2813 100644 --- a/specification/_json_spec/indices.create_from.json +++ b/specification/_json_spec/indices.create_from.json @@ -1,11 +1,11 @@ { "indices.create_from": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index-from-source.html", - "description": "This API creates a destination from a source index. It copies the mappings and settings from the source index while allowing request settings and mappings to override the source values." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-from", + "description": "Create an index from a source index" }, - "stability": "experimental", - "visibility": "private", + "stability": "stable", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/indices.data_streams_stats.json b/specification/_json_spec/indices.data_streams_stats.json index 4467d72470..e313ca3374 100644 --- a/specification/_json_spec/indices.data_streams_stats.json +++ b/specification/_json_spec/indices.data_streams_stats.json @@ -1,8 +1,8 @@ { "indices.data_streams_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Provides statistics on operations happening in a data stream." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1", + "description": "Get data stream stats" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/indices.delete.json b/specification/_json_spec/indices.delete.json index 8e49e457f6..f63ca2ad35 100644 --- a/specification/_json_spec/indices.delete.json +++ b/specification/_json_spec/indices.delete.json @@ -1,8 +1,8 @@ { "indices.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", - "description": "Deletes an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete", + "description": "Delete indices" }, "stability": "stable", "visibility": "public", @@ -26,18 +26,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.delete_alias.json b/specification/_json_spec/indices.delete_alias.json index ed15d9d061..82d875f4ac 100644 --- a/specification/_json_spec/indices.delete_alias.json +++ b/specification/_json_spec/indices.delete_alias.json @@ -1,8 +1,8 @@ { "indices.delete_alias": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "description": "Deletes an alias." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias", + "description": "Delete an alias" }, "stability": "stable", "visibility": "public", @@ -44,10 +44,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_data_lifecycle.json b/specification/_json_spec/indices.delete_data_lifecycle.json index 94affa5502..3cc331f44a 100644 --- a/specification/_json_spec/indices.delete_data_lifecycle.json +++ b/specification/_json_spec/indices.delete_data_lifecycle.json @@ -1,8 +1,8 @@ { "indices.delete_data_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", - "description": "Deletes the data stream lifecycle of the selected data streams." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle", + "description": "Delete data stream lifecycles" }, "stability": "stable", "visibility": "public", @@ -36,6 +36,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_data_stream.json b/specification/_json_spec/indices.delete_data_stream.json index 163de3ecbd..84e95876ec 100644 --- a/specification/_json_spec/indices.delete_data_stream.json +++ b/specification/_json_spec/indices.delete_data_stream.json @@ -1,8 +1,8 @@ { "indices.delete_data_stream": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Deletes a data stream." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream", + "description": "Delete data streams" }, "stability": "stable", "visibility": "public", @@ -32,6 +32,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_data_stream_options.json b/specification/_json_spec/indices.delete_data_stream_options.json index be9f102ec4..3ec19540d1 100644 --- a/specification/_json_spec/indices.delete_data_stream_options.json +++ b/specification/_json_spec/indices.delete_data_stream_options.json @@ -1,8 +1,8 @@ { "indices.delete_data_stream_options": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", - "description": "Deletes the data stream options of the selected data streams." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream-options", + "description": "Delete data stream options" }, "stability": "stable", "visibility": "public", @@ -36,6 +36,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_index_template.json b/specification/_json_spec/indices.delete_index_template.json index 664917491f..c8d8ced179 100644 --- a/specification/_json_spec/indices.delete_index_template.json +++ b/specification/_json_spec/indices.delete_index_template.json @@ -1,8 +1,8 @@ { "indices.delete_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", - "description": "Deletes an index template." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template", + "description": "Delete an index template" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.delete_sample_configuration.json b/specification/_json_spec/indices.delete_sample_configuration.json new file mode 100644 index 0000000000..d3bba82a0f --- /dev/null +++ b/specification/_json_spec/indices.delete_sample_configuration.json @@ -0,0 +1,38 @@ +{ + "indices.delete_sample_configuration": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration", + "description": "Delete sampling configuration for an index or data stream" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_sample/config", + "methods": ["DELETE"], + "parts": { + "index": { + "type": "string", + "description": "The name of a data stream or index" + } + } + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Timeout for the request" + } + } + } +} diff --git a/specification/_json_spec/indices.delete_template.json b/specification/_json_spec/indices.delete_template.json index 897cd5b0ac..d047052d89 100644 --- a/specification/_json_spec/indices.delete_template.json +++ b/specification/_json_spec/indices.delete_template.json @@ -1,8 +1,8 @@ { "indices.delete_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html", - "description": "Deletes an index template." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template", + "description": "Delete a legacy index template" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.disk_usage.json b/specification/_json_spec/indices.disk_usage.json index d85c0a3bb1..18319b4801 100644 --- a/specification/_json_spec/indices.disk_usage.json +++ b/specification/_json_spec/indices.disk_usage.json @@ -1,8 +1,8 @@ { "indices.disk_usage": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-disk-usage.html", - "description": "Analyzes the disk usage of each field of an index or data stream" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage", + "description": "Analyze the index disk usage" }, "stability": "experimental", "visibility": "public", @@ -26,18 +26,22 @@ "params": { "run_expensive_tasks": { "type": "boolean", + "default": false, "description": "Must be set to [true] in order for the task to be performed. Defaults to false." }, "flush": { "type": "boolean", + "default": true, "description": "Whether flush or not before analyzing the index disk usage. Defaults to true" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.downsample.json b/specification/_json_spec/indices.downsample.json index 5ed77fdac6..c5de52f532 100644 --- a/specification/_json_spec/indices.downsample.json +++ b/specification/_json_spec/indices.downsample.json @@ -1,7 +1,7 @@ { "indices.downsample": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample", "description": "Downsample an index" }, "stability": "experimental", @@ -30,7 +30,6 @@ } ] }, - "params": {}, "body": { "description": "The downsampling configuration", "required": true diff --git a/specification/_json_spec/indices.exists.json b/specification/_json_spec/indices.exists.json index 9ddf942587..0cbadffe70 100644 --- a/specification/_json_spec/indices.exists.json +++ b/specification/_json_spec/indices.exists.json @@ -1,8 +1,8 @@ { "indices.exists": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", - "description": "Returns information about whether a particular index exists." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists", + "description": "Check indices" }, "stability": "stable", "visibility": "public", @@ -26,14 +26,17 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)" }, "expand_wildcards": { @@ -44,6 +47,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "include_defaults": { diff --git a/specification/_json_spec/indices.exists_alias.json b/specification/_json_spec/indices.exists_alias.json index 9ad4a93551..a5e14aabaf 100644 --- a/specification/_json_spec/indices.exists_alias.json +++ b/specification/_json_spec/indices.exists_alias.json @@ -1,8 +1,8 @@ { "indices.exists_alias": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "description": "Returns information about whether a particular alias exists." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias", + "description": "Check aliases" }, "stability": "stable", "visibility": "public", @@ -40,10 +40,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -54,8 +56,8 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for waiting for new cluster state in case it is blocked", - "default": "30s" + "default": "30s", + "description": "Timeout for waiting for new cluster state in case it is blocked" } } } diff --git a/specification/_json_spec/indices.exists_index_template.json b/specification/_json_spec/indices.exists_index_template.json index 20819f7130..177943b923 100644 --- a/specification/_json_spec/indices.exists_index_template.json +++ b/specification/_json_spec/indices.exists_index_template.json @@ -1,8 +1,8 @@ { "indices.exists_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", - "description": "Returns information about whether a particular index template exists." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template", + "description": "Check index templates" }, "stability": "stable", "visibility": "public", @@ -26,14 +26,17 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.exists_template.json b/specification/_json_spec/indices.exists_template.json index 0689581043..f4a859c8ab 100644 --- a/specification/_json_spec/indices.exists_template.json +++ b/specification/_json_spec/indices.exists_template.json @@ -1,8 +1,8 @@ { "indices.exists_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", - "description": "Returns information about whether a particular index template exists." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template", + "description": "Check existence of index templates" }, "stability": "stable", "visibility": "public", @@ -26,15 +26,18 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.explain_data_lifecycle.json b/specification/_json_spec/indices.explain_data_lifecycle.json index e61a497806..cf0aa2a2a5 100644 --- a/specification/_json_spec/indices.explain_data_lifecycle.json +++ b/specification/_json_spec/indices.explain_data_lifecycle.json @@ -1,8 +1,8 @@ { "indices.explain_data_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", - "description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle", + "description": "Get the status for a data stream lifecycle" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.field_usage_stats.json b/specification/_json_spec/indices.field_usage_stats.json index 6a61fcfe5d..e56d4b2672 100644 --- a/specification/_json_spec/indices.field_usage_stats.json +++ b/specification/_json_spec/indices.field_usage_stats.json @@ -1,8 +1,8 @@ { "indices.field_usage_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html", - "description": "Returns the field usage stats for each field of an index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats", + "description": "Get field usage stats" }, "stability": "experimental", "visibility": "public", @@ -30,6 +30,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { diff --git a/specification/_json_spec/indices.flush.json b/specification/_json_spec/indices.flush.json index 4839587d4c..e7be5a2abc 100644 --- a/specification/_json_spec/indices.flush.json +++ b/specification/_json_spec/indices.flush.json @@ -1,8 +1,8 @@ { "indices.flush": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html", - "description": "Performs the flush operation on one or more indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush", + "description": "Flush data streams or indices" }, "stability": "stable", "visibility": "public", @@ -30,18 +30,22 @@ "params": { "force": { "type": "boolean", + "default": true, "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)" }, "wait_if_ongoing": { "type": "boolean", + "default": true, "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running." }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.forcemerge.json b/specification/_json_spec/indices.forcemerge.json index ae68a1af99..fb5bc29308 100644 --- a/specification/_json_spec/indices.forcemerge.json +++ b/specification/_json_spec/indices.forcemerge.json @@ -1,8 +1,8 @@ { "indices.forcemerge": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", - "description": "Performs the force merge operation on one or more indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge", + "description": "Force a merge" }, "stability": "stable", "visibility": "public", @@ -47,7 +47,7 @@ "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." }, "max_num_segments": { - "type": "number", + "type": "long", "description": "The number of segments the index should be merged into (default: dynamic)" }, "only_expunge_deletes": { diff --git a/specification/_json_spec/indices.get.json b/specification/_json_spec/indices.get.json index 653dc12b8c..96c81c6a68 100644 --- a/specification/_json_spec/indices.get.json +++ b/specification/_json_spec/indices.get.json @@ -1,8 +1,8 @@ { "indices.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", - "description": "Returns information about one or more indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get", + "description": "Get index information" }, "stability": "stable", "visibility": "public", @@ -26,14 +26,17 @@ "params": { "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if a wildcard expression resolves to no concrete indices (default: false)" }, "expand_wildcards": { @@ -50,6 +53,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "include_defaults": { @@ -59,6 +63,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.get_alias.json b/specification/_json_spec/indices.get_alias.json index 98b37607ea..947eace028 100644 --- a/specification/_json_spec/indices.get_alias.json +++ b/specification/_json_spec/indices.get_alias.json @@ -1,8 +1,8 @@ { "indices.get_alias": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "description": "Returns an alias." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias", + "description": "Get aliases" }, "stability": "stable", "visibility": "public", @@ -54,10 +54,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -68,8 +70,8 @@ }, "master_timeout": { "type": "time", - "description": "Timeout for waiting for new cluster state in case it is blocked", - "default": "30s" + "default": "30s", + "description": "Timeout for waiting for new cluster state in case it is blocked" } } } diff --git a/specification/_json_spec/indices.get_all_sample_configuration.json b/specification/_json_spec/indices.get_all_sample_configuration.json new file mode 100644 index 0000000000..1d113b7304 --- /dev/null +++ b/specification/_json_spec/indices.get_all_sample_configuration.json @@ -0,0 +1,27 @@ +{ + "indices.get_all_sample_configuration": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-all-sample-configuration", + "description": "Get sampling configurations for all indices and data streams" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_sample/config", + "methods": ["GET"] + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master node" + } + } + } +} diff --git a/specification/_json_spec/indices.get_data_lifecycle.json b/specification/_json_spec/indices.get_data_lifecycle.json index 0aa050cb43..fb8d4fb73c 100644 --- a/specification/_json_spec/indices.get_data_lifecycle.json +++ b/specification/_json_spec/indices.get_data_lifecycle.json @@ -1,8 +1,8 @@ { "indices.get_data_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", - "description": "Returns the data stream lifecycle of the selected data streams." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle", + "description": "Get data stream lifecycles" }, "stability": "stable", "visibility": "public", @@ -32,10 +32,12 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.get_data_lifecycle_stats.json b/specification/_json_spec/indices.get_data_lifecycle_stats.json index 8c9e947903..d8d83f2b7d 100644 --- a/specification/_json_spec/indices.get_data_lifecycle_stats.json +++ b/specification/_json_spec/indices.get_data_lifecycle_stats.json @@ -1,8 +1,8 @@ { "indices.get_data_lifecycle_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle-stats.html", - "description": "Get data stream lifecycle statistics." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats", + "description": "Get data stream lifecycle stats" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/indices.get_data_stream.json b/specification/_json_spec/indices.get_data_stream.json index 94fc4aac36..646e5844ef 100644 --- a/specification/_json_spec/indices.get_data_stream.json +++ b/specification/_json_spec/indices.get_data_stream.json @@ -1,8 +1,8 @@ { "indices.get_data_stream": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Returns data streams." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream", + "description": "Get data streams" }, "stability": "stable", "visibility": "public", @@ -36,14 +36,17 @@ }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the data stream (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "verbose": { "type": "boolean", + "default": false, "description": "Whether the maximum timestamp for each data stream should be calculated and returned (default: false)" } } diff --git a/specification/_json_spec/indices.get_data_stream_mappings.json b/specification/_json_spec/indices.get_data_stream_mappings.json new file mode 100644 index 0000000000..a2ab036013 --- /dev/null +++ b/specification/_json_spec/indices.get_data_stream_mappings.json @@ -0,0 +1,34 @@ +{ + "indices.get_data_stream_mappings": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-mappings", + "description": "Get data stream mappings" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_data_stream/{name}/_mappings", + "methods": ["GET"], + "parts": { + "name": { + "type": "string", + "description": "Comma-separated list of data streams or data stream patterns" + } + } + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "default": "30s", + "description": "Period to wait for a connection to the master node" + } + } + } +} diff --git a/specification/_json_spec/indices.get_data_stream_options.json b/specification/_json_spec/indices.get_data_stream_options.json index 6145b9c11f..a94c7e6e3d 100644 --- a/specification/_json_spec/indices.get_data_stream_options.json +++ b/specification/_json_spec/indices.get_data_stream_options.json @@ -1,8 +1,8 @@ { "indices.get_data_stream_options": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", - "description": "Returns the data stream options of the selected data streams." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-options", + "description": "Get data stream options" }, "stability": "stable", "visibility": "public", @@ -32,6 +32,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.get_data_stream_settings.json b/specification/_json_spec/indices.get_data_stream_settings.json index d9590196ff..7a1c25fe7e 100644 --- a/specification/_json_spec/indices.get_data_stream_settings.json +++ b/specification/_json_spec/indices.get_data_stream_settings.json @@ -1,8 +1,8 @@ { "indices.get_data_stream_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Gets a data stream's settings" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-settings", + "description": "Get data stream settings" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a connection to the master node" } } diff --git a/specification/_json_spec/indices.get_field_mapping.json b/specification/_json_spec/indices.get_field_mapping.json index a31821134f..51955706f7 100644 --- a/specification/_json_spec/indices.get_field_mapping.json +++ b/specification/_json_spec/indices.get_field_mapping.json @@ -1,8 +1,8 @@ { "indices.get_field_mapping": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", - "description": "Returns mapping for one or more fields." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping", + "description": "Get mapping definitions" }, "stability": "stable", "visibility": "public", @@ -40,14 +40,17 @@ "params": { "include_defaults": { "type": "boolean", + "default": false, "description": "Whether the default mapping values should be returned as well" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.get_index_template.json b/specification/_json_spec/indices.get_index_template.json index c6d1a5cf36..1c7b97c2ed 100644 --- a/specification/_json_spec/indices.get_index_template.json +++ b/specification/_json_spec/indices.get_index_template.json @@ -1,8 +1,8 @@ { "indices.get_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", - "description": "Returns an index template." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template", + "description": "Get index templates" }, "stability": "stable", "visibility": "public", @@ -30,19 +30,23 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for the index template (default: false)" } } diff --git a/specification/_json_spec/indices.get_mapping.json b/specification/_json_spec/indices.get_mapping.json index 29f07b2774..7f3d930470 100644 --- a/specification/_json_spec/indices.get_mapping.json +++ b/specification/_json_spec/indices.get_mapping.json @@ -1,8 +1,8 @@ { "indices.get_mapping": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", - "description": "Returns mappings for one or more indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping", + "description": "Get mapping definitions" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -44,12 +46,14 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "local": { "type": "boolean", - "description": "Return local information, do not retrieve the state from master node (default: false)", - "deprecated": true + "deprecated": true, + "default": false, + "description": "Return local information, do not retrieve the state from master node (default: false)" } } } diff --git a/specification/_json_spec/indices.get_migrate_reindex_status.json b/specification/_json_spec/indices.get_migrate_reindex_status.json index 7e027dec38..0df7b14fb9 100644 --- a/specification/_json_spec/indices.get_migrate_reindex_status.json +++ b/specification/_json_spec/indices.get_migrate_reindex_status.json @@ -1,11 +1,11 @@ { "indices.get_migrate_reindex_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-status-api.html", - "description": "This API returns the status of a migration reindex attempt for a data stream or index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-migration", + "description": "Get the migration reindexing status" }, - "stability": "experimental", - "visibility": "private", + "stability": "stable", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/indices.get_sample.json b/specification/_json_spec/indices.get_sample.json new file mode 100644 index 0000000000..51e783e1ea --- /dev/null +++ b/specification/_json_spec/indices.get_sample.json @@ -0,0 +1,27 @@ +{ + "indices.get_sample": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample", + "description": "Get random sample of ingested data" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_sample", + "methods": ["GET"], + "parts": { + "index": { + "type": "string", + "description": "The name of a data stream or index" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/indices.get_sample_configuration.json b/specification/_json_spec/indices.get_sample_configuration.json new file mode 100644 index 0000000000..7b14e1e8db --- /dev/null +++ b/specification/_json_spec/indices.get_sample_configuration.json @@ -0,0 +1,33 @@ +{ + "indices.get_sample_configuration": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample-configuration", + "description": "Get sampling configuration for an index or data stream" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_sample/config", + "methods": ["GET"], + "parts": { + "index": { + "type": "string", + "description": "The name of a data stream or index" + } + } + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master node" + } + } + } +} diff --git a/specification/_json_spec/indices.get_sample_stats.json b/specification/_json_spec/indices.get_sample_stats.json new file mode 100644 index 0000000000..04ace3b2ae --- /dev/null +++ b/specification/_json_spec/indices.get_sample_stats.json @@ -0,0 +1,27 @@ +{ + "indices.get_sample_stats": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample", + "description": "Get stats about a random sample of ingested data" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_sample/stats", + "methods": ["GET"], + "parts": { + "index": { + "type": "string", + "description": "The name of a data stream or index" + } + } + } + ] + } + } +} diff --git a/specification/_json_spec/indices.get_settings.json b/specification/_json_spec/indices.get_settings.json index 0755591501..22d07c3521 100644 --- a/specification/_json_spec/indices.get_settings.json +++ b/specification/_json_spec/indices.get_settings.json @@ -1,8 +1,8 @@ { "indices.get_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", - "description": "Returns settings for one or more indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings", + "description": "Get index settings" }, "stability": "stable", "visibility": "public", @@ -54,14 +54,17 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -72,11 +75,13 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "include_defaults": { diff --git a/specification/_json_spec/indices.get_template.json b/specification/_json_spec/indices.get_template.json index d5222f94bf..d30a3be0ab 100644 --- a/specification/_json_spec/indices.get_template.json +++ b/specification/_json_spec/indices.get_template.json @@ -1,8 +1,8 @@ { "indices.get_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", - "description": "Returns an index template." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template", + "description": "Get legacy index templates" }, "stability": "stable", "visibility": "public", @@ -30,15 +30,18 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for waiting for new cluster state in case it is blocked" }, "local": { "deprecated": true, "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/indices.migrate_reindex.json b/specification/_json_spec/indices.migrate_reindex.json index d1689f7eb9..2e6266c5f9 100644 --- a/specification/_json_spec/indices.migrate_reindex.json +++ b/specification/_json_spec/indices.migrate_reindex.json @@ -1,11 +1,11 @@ { "indices.migrate_reindex": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex-api.html", - "description": "This API reindexes all legacy backing indices for a data stream. It does this in a persistent task. The persistent task id is returned immediately, and the reindexing work is completed in that task" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-reindex", + "description": "Reindex legacy backing indices" }, - "stability": "experimental", - "visibility": "private", + "stability": "stable", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/indices.migrate_to_data_stream.json b/specification/_json_spec/indices.migrate_to_data_stream.json index 9453dbed0f..1bc53824a0 100644 --- a/specification/_json_spec/indices.migrate_to_data_stream.json +++ b/specification/_json_spec/indices.migrate_to_data_stream.json @@ -1,8 +1,8 @@ { "indices.migrate_to_data_stream": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Migrates an alias to a data stream" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-to-data-stream", + "description": "Convert an index alias to a data stream" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for acknowledging the cluster state update" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.modify_data_stream.json b/specification/_json_spec/indices.modify_data_stream.json index c279a51304..185cf9ce6b 100644 --- a/specification/_json_spec/indices.modify_data_stream.json +++ b/specification/_json_spec/indices.modify_data_stream.json @@ -1,8 +1,8 @@ { "indices.modify_data_stream": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Modifies a data stream" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream", + "description": "Update data streams" }, "stability": "stable", "visibility": "public", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The data stream modifications", "required": true diff --git a/specification/_json_spec/indices.open.json b/specification/_json_spec/indices.open.json index 2303875c91..5c27090e05 100644 --- a/specification/_json_spec/indices.open.json +++ b/specification/_json_spec/indices.open.json @@ -1,8 +1,8 @@ { "indices.open": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", - "description": "Opens an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open", + "description": "Open a closed index" }, "stability": "stable", "visibility": "public", @@ -26,18 +26,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -48,6 +52,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of active shards to wait for before the operation returns." } } diff --git a/specification/_json_spec/indices.promote_data_stream.json b/specification/_json_spec/indices.promote_data_stream.json index 9088d03dc3..48b4a1d397 100644 --- a/specification/_json_spec/indices.promote_data_stream.json +++ b/specification/_json_spec/indices.promote_data_stream.json @@ -1,8 +1,8 @@ { "indices.promote_data_stream": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Promotes a data stream from a replicated data stream managed by CCR to a regular data stream" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-promote-data-stream", + "description": "Promote a data stream" }, "stability": "stable", "visibility": "public", @@ -26,6 +26,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/indices.put_alias.json b/specification/_json_spec/indices.put_alias.json index cfbdfba74a..6c0f3b73e2 100644 --- a/specification/_json_spec/indices.put_alias.json +++ b/specification/_json_spec/indices.put_alias.json @@ -1,8 +1,8 @@ { "indices.put_alias": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "description": "Creates or updates an alias." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias", + "description": "Create or update an alias" }, "stability": "stable", "visibility": "public", @@ -45,10 +45,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.put_data_lifecycle.json b/specification/_json_spec/indices.put_data_lifecycle.json index b92c9cc9ca..362fa41a71 100644 --- a/specification/_json_spec/indices.put_data_lifecycle.json +++ b/specification/_json_spec/indices.put_data_lifecycle.json @@ -1,8 +1,8 @@ { "indices.put_data_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", - "description": "Updates the data stream lifecycle of the selected data streams." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle", + "description": "Update data stream lifecycles" }, "stability": "stable", "visibility": "public", @@ -33,15 +33,18 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, "body": { - "description": "The data stream lifecycle configuration that consist of the data retention" + "description": "The data stream lifecycle configuration that consist of the data retention", + "required": true } } } diff --git a/specification/_json_spec/indices.put_data_stream_mappings.json b/specification/_json_spec/indices.put_data_stream_mappings.json new file mode 100644 index 0000000000..a5c33f3aac --- /dev/null +++ b/specification/_json_spec/indices.put_data_stream_mappings.json @@ -0,0 +1,48 @@ +{ + "indices.put_data_stream_mappings": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-mappings", + "description": "Update data stream mappings" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_data_stream/{name}/_mappings", + "methods": ["PUT"], + "parts": { + "name": { + "type": "string", + "description": "Comma-separated list of data streams or data stream patterns" + } + } + } + ] + }, + "params": { + "dry_run": { + "type": "boolean", + "description": "Whether this request should only be a dry run rather than actually applying mappings", + "default": false + }, + "timeout": { + "type": "time", + "default": "30s", + "description": "Period to wait for a response" + }, + "master_timeout": { + "type": "time", + "default": "30s", + "description": "Period to wait for a connection to the master node" + } + }, + "body": { + "description": "The data stream mappings to be updated", + "required": true + } + } +} diff --git a/specification/_json_spec/indices.put_data_stream_options.json b/specification/_json_spec/indices.put_data_stream_options.json index 596af454d7..5f087ca80b 100644 --- a/specification/_json_spec/indices.put_data_stream_options.json +++ b/specification/_json_spec/indices.put_data_stream_options.json @@ -1,8 +1,8 @@ { "indices.put_data_stream_options": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", - "description": "Updates the data stream options of the selected data streams." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-options", + "description": "Update data stream options" }, "stability": "stable", "visibility": "public", @@ -33,15 +33,18 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit timestamp for the document" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, "body": { - "description": "The data stream options configuration that consist of the failure store configuration" + "description": "The data stream options configuration that consist of the failure store configuration", + "required": true } } } diff --git a/specification/_json_spec/indices.put_data_stream_settings.json b/specification/_json_spec/indices.put_data_stream_settings.json index 2bc0c435b5..5ef9932506 100644 --- a/specification/_json_spec/indices.put_data_stream_settings.json +++ b/specification/_json_spec/indices.put_data_stream_settings.json @@ -1,8 +1,8 @@ { "indices.put_data_stream_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", - "description": "Updates a data stream's settings" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-settings", + "description": "Update data stream settings" }, "stability": "stable", "visibility": "public", @@ -31,10 +31,12 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a response" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Period to wait for a connection to the master node" } }, diff --git a/specification/_json_spec/indices.put_index_template.json b/specification/_json_spec/indices.put_index_template.json index 540773ae30..810ad7b02b 100644 --- a/specification/_json_spec/indices.put_index_template.json +++ b/specification/_json_spec/indices.put_index_template.json @@ -1,8 +1,8 @@ { "indices.put_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", - "description": "Creates or updates an index template." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template", + "description": "Create or update an index template" }, "stability": "stable", "visibility": "public", @@ -33,10 +33,11 @@ "cause": { "type": "string", "description": "User defined reason for creating/updating the index template", - "default": false + "default": "api" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.put_mapping.json b/specification/_json_spec/indices.put_mapping.json index e11dd1c236..3ce04268d8 100644 --- a/specification/_json_spec/indices.put_mapping.json +++ b/specification/_json_spec/indices.put_mapping.json @@ -1,8 +1,8 @@ { "indices.put_mapping": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", - "description": "Updates the index mappings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping", + "description": "Update field mappings" }, "stability": "stable", "visibility": "public", @@ -27,18 +27,22 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.put_sample_configuration.json b/specification/_json_spec/indices.put_sample_configuration.json new file mode 100644 index 0000000000..143156c5a9 --- /dev/null +++ b/specification/_json_spec/indices.put_sample_configuration.json @@ -0,0 +1,42 @@ +{ + "indices.put_sample_configuration": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-sample-configuration", + "description": "Configure sampling for an index or data stream" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_sample/config", + "methods": ["PUT"], + "parts": { + "index": { + "type": "string", + "description": "The name of a data stream or index" + } + } + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master node" + }, + "timeout": { + "type": "time", + "description": "Timeout for the request" + } + }, + "body": { + "description": "The sampling configuration", + "required": true + } + } +} diff --git a/specification/_json_spec/indices.put_settings.json b/specification/_json_spec/indices.put_settings.json index fb8cbbc167..60b1e83f76 100644 --- a/specification/_json_spec/indices.put_settings.json +++ b/specification/_json_spec/indices.put_settings.json @@ -1,8 +1,8 @@ { "indices.put_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", - "description": "Updates the index settings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings", + "description": "Update index settings" }, "stability": "stable", "visibility": "public", @@ -31,26 +31,32 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "preserve_existing": { "type": "boolean", + "default": false, "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`" }, "reopen": { "type": "boolean", + "default": false, "description": "Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false`" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": false, "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)" }, "expand_wildcards": { @@ -61,6 +67,7 @@ }, "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" } }, diff --git a/specification/_json_spec/indices.put_template.json b/specification/_json_spec/indices.put_template.json index afc06749f8..9d7f96094d 100644 --- a/specification/_json_spec/indices.put_template.json +++ b/specification/_json_spec/indices.put_template.json @@ -1,8 +1,8 @@ { "indices.put_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", - "description": "Creates or updates an index template." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template", + "description": "Create or update a legacy index template" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,7 @@ }, "params": { "order": { - "type": "number", + "type": "int", "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)" }, "create": { @@ -41,6 +41,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.recovery.json b/specification/_json_spec/indices.recovery.json index ada2fcb075..da35b02ae6 100644 --- a/specification/_json_spec/indices.recovery.json +++ b/specification/_json_spec/indices.recovery.json @@ -1,8 +1,8 @@ { "indices.recovery": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", - "description": "Returns information about ongoing index shard recoveries." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery", + "description": "Get index recovery information" }, "stability": "stable", "visibility": "public", @@ -37,6 +37,22 @@ "type": "boolean", "description": "Display only those recoveries that are currently on-going", "default": false + }, + "ignore_unavailable": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "default": false + }, + "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)", + "default": true + }, + "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." } } } diff --git a/specification/_json_spec/indices.refresh.json b/specification/_json_spec/indices.refresh.json index 280f895dca..dac659538d 100644 --- a/specification/_json_spec/indices.refresh.json +++ b/specification/_json_spec/indices.refresh.json @@ -1,8 +1,8 @@ { "indices.refresh": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", - "description": "Performs the refresh operation in one or more indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh", + "description": "Refresh an index" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.reload_search_analyzers.json b/specification/_json_spec/indices.reload_search_analyzers.json index af78bfc238..b67b5a0771 100644 --- a/specification/_json_spec/indices.reload_search_analyzers.json +++ b/specification/_json_spec/indices.reload_search_analyzers.json @@ -1,8 +1,8 @@ { "indices.reload_search_analyzers": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", - "description": "Reloads an index's search analyzers and their resources." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers", + "description": "Reload search analyzers" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/indices.remove_block.json b/specification/_json_spec/indices.remove_block.json new file mode 100644 index 0000000000..39fc1f3181 --- /dev/null +++ b/specification/_json_spec/indices.remove_block.json @@ -0,0 +1,59 @@ +{ + "indices.remove_block": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block", + "description": "Remove an index block" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/{index}/_block/{block}", + "methods": ["DELETE"], + "parts": { + "index": { + "type": "list", + "description": "A comma separated list of indices to remove a block from" + }, + "block": { + "type": "string", + "description": "The block to remove (one of read, write, read_only or metadata)" + } + } + } + ] + }, + "params": { + "timeout": { + "type": "time", + "default": "30s", + "description": "Explicit operation timeout" + }, + "master_timeout": { + "type": "time", + "default": "30s", + "description": "Specify timeout for connection to master" + }, + "ignore_unavailable": { + "type": "boolean", + "default": false, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" + }, + "allow_no_indices": { + "type": "boolean", + "default": true, + "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)" + }, + "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." + } + } + } +} diff --git a/specification/_json_spec/indices.resolve_cluster.json b/specification/_json_spec/indices.resolve_cluster.json index 0469c903fa..2164811a2b 100644 --- a/specification/_json_spec/indices.resolve_cluster.json +++ b/specification/_json_spec/indices.resolve_cluster.json @@ -1,8 +1,8 @@ { "indices.resolve_cluster": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html", - "description": "Resolves the specified index expressions to return information about each cluster. If no index expression is provided, this endpoint will return information about all the remote clusters that are configured on the local cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster", + "description": "Resolve the cluster" }, "stability": "stable", "visibility": "public", @@ -30,14 +30,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression." }, "ignore_throttled": { "type": "boolean", + "default": false, "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", + "default": true, "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": { diff --git a/specification/_json_spec/indices.resolve_index.json b/specification/_json_spec/indices.resolve_index.json index 9286a50ff6..1f1c2ae8ee 100644 --- a/specification/_json_spec/indices.resolve_index.json +++ b/specification/_json_spec/indices.resolve_index.json @@ -1,8 +1,8 @@ { "indices.resolve_index": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", - "description": "Returns information about any matching indices, aliases, and data streams" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index", + "description": "Resolve indices" }, "stability": "stable", "visibility": "public", @@ -39,6 +39,16 @@ "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)", "default": true + }, + "mode": { + "type": "enum", + "options": ["standard", "time_series", "logsdb", "lookup"], + "default": "", + "description": "Filter indices by index mode. Comma-separated list of IndexMode. Empty means no filter." + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." } } } diff --git a/specification/_json_spec/indices.rollover.json b/specification/_json_spec/indices.rollover.json index 58d14ad627..079cc26a17 100644 --- a/specification/_json_spec/indices.rollover.json +++ b/specification/_json_spec/indices.rollover.json @@ -1,8 +1,8 @@ { "indices.rollover": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html", - "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover", + "description": "Roll over to a new index" }, "stability": "stable", "visibility": "public", @@ -41,28 +41,33 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "dry_run": { "type": "boolean", + "default": false, "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." }, "lazy": { "type": "boolean", - "default": "false", + "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." } }, "body": { - "description": "The conditions that needs to be met for executing rollover" + "description": "The conditions that needs to be met for executing rollover", + "required": false } } } diff --git a/specification/_json_spec/indices.segments.json b/specification/_json_spec/indices.segments.json index 46970d7e74..e4e02ffcc3 100644 --- a/specification/_json_spec/indices.segments.json +++ b/specification/_json_spec/indices.segments.json @@ -1,8 +1,8 @@ { "indices.segments": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", - "description": "Provides low-level information about segments in a Lucene index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments", + "description": "Get index segments" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/indices.shard_stores.json b/specification/_json_spec/indices.shard_stores.json index 70e7a1146d..dd0f8d3449 100644 --- a/specification/_json_spec/indices.shard_stores.json +++ b/specification/_json_spec/indices.shard_stores.json @@ -1,8 +1,8 @@ { "indices.shard_stores": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", - "description": "Provides store information for shard copies of indices." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores", + "description": "Get index shard stores" }, "stability": "stable", "visibility": "public", @@ -35,6 +35,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { diff --git a/specification/_json_spec/indices.shrink.json b/specification/_json_spec/indices.shrink.json index 99a0a3bee7..e1a7a39dee 100644 --- a/specification/_json_spec/indices.shrink.json +++ b/specification/_json_spec/indices.shrink.json @@ -1,8 +1,8 @@ { "indices.shrink": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html", - "description": "Allow to shrink an existing index into a new index with fewer primary shards." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink", + "description": "Shrink an index" }, "stability": "stable", "visibility": "public", @@ -31,19 +31,23 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": true } } } diff --git a/specification/_json_spec/indices.simulate_index_template.json b/specification/_json_spec/indices.simulate_index_template.json index 294030fff1..30860558e1 100644 --- a/specification/_json_spec/indices.simulate_index_template.json +++ b/specification/_json_spec/indices.simulate_index_template.json @@ -1,8 +1,8 @@ { "indices.simulate_index_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", - "description": "Simulate matching the given index name against the index templates in the system" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template", + "description": "Simulate an index" }, "stability": "stable", "visibility": "public", @@ -33,14 +33,16 @@ "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", - "default": false + "default": "false" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for this index template simulation (default: false)" } }, diff --git a/specification/_json_spec/indices.simulate_template.json b/specification/_json_spec/indices.simulate_template.json index a34c69d21b..ef163a3694 100644 --- a/specification/_json_spec/indices.simulate_template.json +++ b/specification/_json_spec/indices.simulate_template.json @@ -1,8 +1,8 @@ { "indices.simulate_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", - "description": "Simulate resolving the given template name or body" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template", + "description": "Simulate an index template" }, "stability": "stable", "visibility": "public", @@ -37,14 +37,16 @@ "cause": { "type": "string", "description": "User defined reason for dry-run creating the new template for simulation purposes", - "default": false + "default": "false" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "include_defaults": { "type": "boolean", + "default": false, "description": "Return all relevant default configurations for this template simulation (default: false)" } }, diff --git a/specification/_json_spec/indices.split.json b/specification/_json_spec/indices.split.json index 2b86f8ec33..c14e5ce38b 100644 --- a/specification/_json_spec/indices.split.json +++ b/specification/_json_spec/indices.split.json @@ -1,8 +1,8 @@ { "indices.split": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html", - "description": "Allows you to split an existing index into a new index with more primary shards." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split", + "description": "Split an index" }, "stability": "stable", "visibility": "public", @@ -31,19 +31,23 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } }, "body": { - "description": "The configuration for the target index (`settings` and `aliases`)" + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": true } } } diff --git a/specification/_json_spec/indices.stats.json b/specification/_json_spec/indices.stats.json index 33df085695..87c04f1b5c 100644 --- a/specification/_json_spec/indices.stats.json +++ b/specification/_json_spec/indices.stats.json @@ -1,8 +1,8 @@ { "indices.stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", - "description": "Provides statistics on operations happening in an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats", + "description": "Get index statistics" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/indices.update_aliases.json b/specification/_json_spec/indices.update_aliases.json index c5db4b7225..5e810b1a3b 100644 --- a/specification/_json_spec/indices.update_aliases.json +++ b/specification/_json_spec/indices.update_aliases.json @@ -1,8 +1,8 @@ { "indices.update_aliases": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", - "description": "Updates index aliases." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases", + "description": "Create or update an alias" }, "stability": "stable", "visibility": "public", @@ -21,10 +21,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Request timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/indices.validate_query.json b/specification/_json_spec/indices.validate_query.json index b30e176750..33eda568f8 100644 --- a/specification/_json_spec/indices.validate_query.json +++ b/specification/_json_spec/indices.validate_query.json @@ -1,8 +1,8 @@ { "indices.validate_query": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", - "description": "Allows a user to validate a potentially expensive query without executing it." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query", + "description": "Validate a query" }, "stability": "stable", "visibility": "public", @@ -31,14 +31,17 @@ "params": { "explain": { "type": "boolean", + "default": false, "description": "Return detailed information about the error" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -57,12 +60,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -71,19 +75,23 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "rewrite": { "type": "boolean", + "default": false, "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." }, "all_shards": { "type": "boolean", + "default": false, "description": "Execute validation on all shards instead of one random shard per index" } }, "body": { - "description": "The query definition specified with the Query DSL" + "description": "The query definition specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/inference.chat_completion_unified.json b/specification/_json_spec/inference.chat_completion_unified.json index 3fb9338dc5..d3971b4bab 100644 --- a/specification/_json_spec/inference.chat_completion_unified.json +++ b/specification/_json_spec/inference.chat_completion_unified.json @@ -1,7 +1,7 @@ { "inference.chat_completion_unified": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/chat-completion-inference.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-unified-inference", "description": "Perform chat completion inference" }, "stability": "stable", @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.completion.json b/specification/_json_spec/inference.completion.json index 1a1ebdcb32..d561dcbb41 100644 --- a/specification/_json_spec/inference.completion.json +++ b/specification/_json_spec/inference.completion.json @@ -1,8 +1,8 @@ { "inference.completion": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", - "description": "Perform completion inference" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "description": "Perform completion inference on the service" }, "stability": "stable", "visibility": "public", @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.delete.json b/specification/_json_spec/inference.delete.json index bfd25b611d..bb9f8e9405 100644 --- a/specification/_json_spec/inference.delete.json +++ b/specification/_json_spec/inference.delete.json @@ -1,7 +1,7 @@ { "inference.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete", "description": "Delete an inference endpoint" }, "stability": "stable", @@ -40,13 +40,13 @@ "params": { "dry_run": { "type": "boolean", - "description": "If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned.", - "required": false + "default": false, + "description": "If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned." }, "force": { "type": "boolean", - "description": "If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields).", - "required": false + "default": false, + "description": "If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields)." } } } diff --git a/specification/_json_spec/inference.get.json b/specification/_json_spec/inference.get.json index 7f14d8babb..8f1aac3482 100644 --- a/specification/_json_spec/inference.get.json +++ b/specification/_json_spec/inference.get.json @@ -1,7 +1,7 @@ { "inference.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get", "description": "Get an inference endpoint" }, "stability": "stable", diff --git a/specification/_json_spec/inference.inference.json b/specification/_json_spec/inference.inference.json index bf1282dfaa..c3091a90c5 100644 --- a/specification/_json_spec/inference.inference.json +++ b/specification/_json_spec/inference.inference.json @@ -1,8 +1,8 @@ { "inference.inference": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", - "description": "Perform inference" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "description": "Perform inference on the service" }, "stability": "stable", "visibility": "public", @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.put.json b/specification/_json_spec/inference.put.json index d48b65cba6..0c7b0c8180 100644 --- a/specification/_json_spec/inference.put.json +++ b/specification/_json_spec/inference.put.json @@ -1,8 +1,8 @@ { "inference.put": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", - "description": "Configure an inference endpoint for use in the Inference API" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put", + "description": "Create an inference endpoint" }, "stability": "stable", "visibility": "public", @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_ai21.json b/specification/_json_spec/inference.put_ai21.json new file mode 100644 index 0000000000..eb3bdcc85b --- /dev/null +++ b/specification/_json_spec/inference.put_ai21.json @@ -0,0 +1,36 @@ +{ + "inference.put_ai21": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-ai21", + "description": "Create a AI21 inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{ai21_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "ai21_inference_id": { + "type": "string", + "description": "The inference ID" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings", + "required": true + } + } +} diff --git a/specification/_json_spec/inference.put_alibabacloud.json b/specification/_json_spec/inference.put_alibabacloud.json index b39d5abe97..9bcd55823a 100644 --- a/specification/_json_spec/inference.put_alibabacloud.json +++ b/specification/_json_spec/inference.put_alibabacloud.json @@ -1,8 +1,8 @@ { "inference.put_alibabacloud": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html", - "description": "Configure an AlibabaCloud AI Search inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-alibabacloud", + "description": "Create an AlibabaCloud AI Search inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_amazonbedrock.json b/specification/_json_spec/inference.put_amazonbedrock.json index 266a1800a3..4bfe9c25d1 100644 --- a/specification/_json_spec/inference.put_amazonbedrock.json +++ b/specification/_json_spec/inference.put_amazonbedrock.json @@ -1,8 +1,8 @@ { "inference.put_amazonbedrock": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-amazon-bedrock.html", - "description": "Configure an Amazon Bedrock inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonbedrock", + "description": "Create an Amazon Bedrock inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_amazonsagemaker.json b/specification/_json_spec/inference.put_amazonsagemaker.json new file mode 100644 index 0000000000..c310b2733c --- /dev/null +++ b/specification/_json_spec/inference.put_amazonsagemaker.json @@ -0,0 +1,36 @@ +{ + "inference.put_amazonsagemaker": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonsagemaker", + "description": "Create an Amazon SageMaker inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{amazonsagemaker_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "amazonsagemaker_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings", + "required": true + } + } +} diff --git a/specification/_json_spec/inference.put_anthropic.json b/specification/_json_spec/inference.put_anthropic.json index dce56157c7..36b1e7155d 100644 --- a/specification/_json_spec/inference.put_anthropic.json +++ b/specification/_json_spec/inference.put_anthropic.json @@ -1,8 +1,8 @@ { "inference.put_anthropic": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-anthropic.html", - "description": "Configure an Anthropic inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-anthropic", + "description": "Create an Anthropic inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_azureaistudio.json b/specification/_json_spec/inference.put_azureaistudio.json index 00de83eca7..0ea47bedf6 100644 --- a/specification/_json_spec/inference.put_azureaistudio.json +++ b/specification/_json_spec/inference.put_azureaistudio.json @@ -1,8 +1,8 @@ { "inference.put_azureaistudio": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-ai-studio.html", - "description": "Configure an Azure AI Studio inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureaistudio", + "description": "Create an Azure AI studio inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_azureopenai.json b/specification/_json_spec/inference.put_azureopenai.json index 8739adb1f5..6ad290a351 100644 --- a/specification/_json_spec/inference.put_azureopenai.json +++ b/specification/_json_spec/inference.put_azureopenai.json @@ -1,8 +1,8 @@ { "inference.put_azureopenai": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-openai.html", - "description": "Configure an Azure OpenAI inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureopenai", + "description": "Create an Azure OpenAI inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_cohere.json b/specification/_json_spec/inference.put_cohere.json index a00518f2c5..4165723a84 100644 --- a/specification/_json_spec/inference.put_cohere.json +++ b/specification/_json_spec/inference.put_cohere.json @@ -1,8 +1,8 @@ { "inference.put_cohere": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-cohere.html", - "description": "Configure a Cohere inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-cohere", + "description": "Create a Cohere inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_contextualai.json b/specification/_json_spec/inference.put_contextualai.json new file mode 100644 index 0000000000..fe58b762db --- /dev/null +++ b/specification/_json_spec/inference.put_contextualai.json @@ -0,0 +1,36 @@ +{ + "inference.put_contextualai": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-contextualai", + "description": "Create an Contextual AI inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{contextualai_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "contextualai_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings", + "required": true + } + } +} diff --git a/specification/_json_spec/inference.put_custom.json b/specification/_json_spec/inference.put_custom.json new file mode 100644 index 0000000000..e39884796a --- /dev/null +++ b/specification/_json_spec/inference.put_custom.json @@ -0,0 +1,36 @@ +{ + "inference.put_custom": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-custom", + "description": "Create a custom inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{custom_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "custom_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings", + "required": true + } + } +} diff --git a/specification/_json_spec/inference.put_deepseek.json b/specification/_json_spec/inference.put_deepseek.json new file mode 100644 index 0000000000..675dff0cca --- /dev/null +++ b/specification/_json_spec/inference.put_deepseek.json @@ -0,0 +1,36 @@ +{ + "inference.put_deepseek": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-deepseek", + "description": "Create a DeepSeek inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{deepseek_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "deepseek_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings", + "required": true + } + } +} diff --git a/specification/_json_spec/inference.put_elasticsearch.json b/specification/_json_spec/inference.put_elasticsearch.json index 0c326b79e9..5c9e37858c 100644 --- a/specification/_json_spec/inference.put_elasticsearch.json +++ b/specification/_json_spec/inference.put_elasticsearch.json @@ -1,8 +1,8 @@ { "inference.put_elasticsearch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html", - "description": "Configure an Elasticsearch inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elasticsearch", + "description": "Create an Elasticsearch inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_elser.json b/specification/_json_spec/inference.put_elser.json index b943b31a7d..d4c912f2ba 100644 --- a/specification/_json_spec/inference.put_elser.json +++ b/specification/_json_spec/inference.put_elser.json @@ -5,8 +5,8 @@ "description": "The elser service is deprecated. Use the Elasticsearch inference integration instead, with model_id included in the service_settings." }, "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elser.html", - "description": "Configure an ELSER inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elser", + "description": "Create an ELSER inference endpoint" }, "stability": "stable", "visibility": "public", @@ -33,7 +33,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_googleaistudio.json b/specification/_json_spec/inference.put_googleaistudio.json index 4574626b61..279ff013b5 100644 --- a/specification/_json_spec/inference.put_googleaistudio.json +++ b/specification/_json_spec/inference.put_googleaistudio.json @@ -1,8 +1,8 @@ { "inference.put_googleaistudio": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-ai-studio.html", - "description": "Configure a Google AI Studio inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googleaistudio", + "description": "Create an Google AI Studio inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_googlevertexai.json b/specification/_json_spec/inference.put_googlevertexai.json index 6068d4cbc9..264e8d89a8 100644 --- a/specification/_json_spec/inference.put_googlevertexai.json +++ b/specification/_json_spec/inference.put_googlevertexai.json @@ -1,8 +1,8 @@ { "inference.put_googlevertexai": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-vertex-ai.html", - "description": "Configure a Google Vertex AI inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googlevertexai", + "description": "Create a Google Vertex AI inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_hugging_face.json b/specification/_json_spec/inference.put_hugging_face.json index 76965d61ba..b22c98b329 100644 --- a/specification/_json_spec/inference.put_hugging_face.json +++ b/specification/_json_spec/inference.put_hugging_face.json @@ -1,8 +1,8 @@ { "inference.put_hugging_face": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-hugging-face.html", - "description": "Configure a HuggingFace inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-hugging-face", + "description": "Create a Hugging Face inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_jinaai.json b/specification/_json_spec/inference.put_jinaai.json index 80af2a69c9..5b54c3d5ba 100644 --- a/specification/_json_spec/inference.put_jinaai.json +++ b/specification/_json_spec/inference.put_jinaai.json @@ -1,8 +1,8 @@ { "inference.put_jinaai": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-jinaai.html", - "description": "Configure a JinaAI inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-jinaai", + "description": "Create an JinaAI inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_llama.json b/specification/_json_spec/inference.put_llama.json new file mode 100644 index 0000000000..690df60098 --- /dev/null +++ b/specification/_json_spec/inference.put_llama.json @@ -0,0 +1,36 @@ +{ + "inference.put_llama": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-llama", + "description": "Create a Llama inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{llama_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "llama_inference_id": { + "type": "string", + "description": "The inference ID" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings", + "required": true + } + } +} diff --git a/specification/_json_spec/inference.put_mistral.json b/specification/_json_spec/inference.put_mistral.json index 97633b233c..0596d6bc03 100644 --- a/specification/_json_spec/inference.put_mistral.json +++ b/specification/_json_spec/inference.put_mistral.json @@ -1,8 +1,8 @@ { "inference.put_mistral": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-mistral.html", - "description": "Configure a Mistral inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-mistral", + "description": "Create a Mistral inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_openai.json b/specification/_json_spec/inference.put_openai.json index 5405206c8c..3861f82710 100644 --- a/specification/_json_spec/inference.put_openai.json +++ b/specification/_json_spec/inference.put_openai.json @@ -1,8 +1,8 @@ { "inference.put_openai": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-openai.html", - "description": "Configure an OpenAI inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-openai", + "description": "Create an OpenAI inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_voyageai.json b/specification/_json_spec/inference.put_voyageai.json index 3ebb51b432..d556fa8d7d 100644 --- a/specification/_json_spec/inference.put_voyageai.json +++ b/specification/_json_spec/inference.put_voyageai.json @@ -1,8 +1,8 @@ { "inference.put_voyageai": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html", - "description": "Configure a VoyageAI inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-voyageai", + "description": "Create a VoyageAI inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.put_watsonx.json b/specification/_json_spec/inference.put_watsonx.json index db5a42d504..9e70688706 100644 --- a/specification/_json_spec/inference.put_watsonx.json +++ b/specification/_json_spec/inference.put_watsonx.json @@ -1,8 +1,8 @@ { "inference.put_watsonx": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-watsonx-ai.html", - "description": "Configure a Watsonx inference endpoint" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-watsonx", + "description": "Create a Watsonx inference endpoint" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/inference.rerank.json b/specification/_json_spec/inference.rerank.json index ac9601852a..b5d09ca773 100644 --- a/specification/_json_spec/inference.rerank.json +++ b/specification/_json_spec/inference.rerank.json @@ -1,8 +1,8 @@ { "inference.rerank": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", - "description": "Perform reranking inference" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "description": "Perform reranking inference on the service" }, "stability": "stable", "visibility": "public", @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.sparse_embedding.json b/specification/_json_spec/inference.sparse_embedding.json index 48e9748cf0..c7e1d526df 100644 --- a/specification/_json_spec/inference.sparse_embedding.json +++ b/specification/_json_spec/inference.sparse_embedding.json @@ -1,8 +1,8 @@ { "inference.sparse_embedding": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", - "description": "Perform sparse embedding inference" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "description": "Perform sparse embedding inference on the service" }, "stability": "stable", "visibility": "public", @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.stream_completion.json b/specification/_json_spec/inference.stream_completion.json index 9df9f4a17c..5771390829 100644 --- a/specification/_json_spec/inference.stream_completion.json +++ b/specification/_json_spec/inference.stream_completion.json @@ -1,8 +1,8 @@ { "inference.stream_completion": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-stream-inference-api.html", - "description": "Perform streaming completion inference" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-stream-inference", + "description": "Perform streaming inference" }, "stability": "stable", "visibility": "public", @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.text_embedding.json b/specification/_json_spec/inference.text_embedding.json index 2f7c43c38a..5f4c4d8e5f 100644 --- a/specification/_json_spec/inference.text_embedding.json +++ b/specification/_json_spec/inference.text_embedding.json @@ -1,8 +1,8 @@ { "inference.text_embedding": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", - "description": "Perform text embedding inference" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "description": "Perform text embedding inference on the service" }, "stability": "stable", "visibility": "public", @@ -25,7 +25,8 @@ ] }, "body": { - "description": "The inference payload" + "description": "The inference payload", + "required": true } } } diff --git a/specification/_json_spec/inference.update.json b/specification/_json_spec/inference.update.json index 133354e3ec..be8280491e 100644 --- a/specification/_json_spec/inference.update.json +++ b/specification/_json_spec/inference.update.json @@ -1,8 +1,8 @@ { "inference.update": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-inference-api.html", - "description": "Update inference" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-update", + "description": "Update an inference endpoint" }, "stability": "stable", "visibility": "public", @@ -39,7 +39,8 @@ ] }, "body": { - "description": "The inference endpoint's task and service settings" + "description": "The inference endpoint's task and service settings", + "required": true } } } diff --git a/specification/_json_spec/info.json b/specification/_json_spec/info.json index 323d772200..7da080467f 100644 --- a/specification/_json_spec/info.json +++ b/specification/_json_spec/info.json @@ -1,8 +1,8 @@ { "info": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", - "description": "Returns basic information about the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info", + "description": "Get cluster info" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ingest.delete_geoip_database.json b/specification/_json_spec/ingest.delete_geoip_database.json index d56019cf4f..de18d8dd5b 100644 --- a/specification/_json_spec/ingest.delete_geoip_database.json +++ b/specification/_json_spec/ingest.delete_geoip_database.json @@ -1,8 +1,8 @@ { "ingest.delete_geoip_database": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-geoip-database-api.html", - "description": "Deletes a geoip database configuration" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-geoip-database", + "description": "Delete GeoIP database configurations" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.delete_ip_location_database.json b/specification/_json_spec/ingest.delete_ip_location_database.json index 427cbe9817..61b7d2cc16 100644 --- a/specification/_json_spec/ingest.delete_ip_location_database.json +++ b/specification/_json_spec/ingest.delete_ip_location_database.json @@ -1,8 +1,8 @@ { "ingest.delete_ip_location_database": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-ip-location-database-api.html", - "description": "Deletes an ip location database configuration" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-ip-location-database", + "description": "Delete IP geolocation database configurations" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.delete_pipeline.json b/specification/_json_spec/ingest.delete_pipeline.json index ec7259cb80..0f9a3e99bb 100644 --- a/specification/_json_spec/ingest.delete_pipeline.json +++ b/specification/_json_spec/ingest.delete_pipeline.json @@ -1,8 +1,8 @@ { "ingest.delete_pipeline": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", - "description": "Deletes a pipeline." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-pipeline", + "description": "Delete pipelines" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ingest.geo_ip_stats.json b/specification/_json_spec/ingest.geo_ip_stats.json index 9915bd0f14..c8f7e38c0f 100644 --- a/specification/_json_spec/ingest.geo_ip_stats.json +++ b/specification/_json_spec/ingest.geo_ip_stats.json @@ -1,8 +1,8 @@ { "ingest.geo_ip_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html", - "description": "Returns statistical information about geoip databases" + "url": "https://www.elastic.co/docs/reference/enrich-processor/geoip-processor", + "description": "Get GeoIP statistics" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ingest.get_geoip_database.json b/specification/_json_spec/ingest.get_geoip_database.json index db2e48a040..569c2d0633 100644 --- a/specification/_json_spec/ingest.get_geoip_database.json +++ b/specification/_json_spec/ingest.get_geoip_database.json @@ -1,8 +1,8 @@ { "ingest.get_geoip_database": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-geoip-database-api.html", - "description": "Returns geoip database configuration." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-geoip-database", + "description": "Get GeoIP database configurations" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ingest.get_ip_location_database.json b/specification/_json_spec/ingest.get_ip_location_database.json index d6dda6573b..86019c6406 100644 --- a/specification/_json_spec/ingest.get_ip_location_database.json +++ b/specification/_json_spec/ingest.get_ip_location_database.json @@ -1,8 +1,8 @@ { "ingest.get_ip_location_database": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-ip-location-database-api.html", - "description": "Returns the specified ip location database configuration" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-ip-location-database", + "description": "Get IP geolocation database configurations" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ingest.get_pipeline.json b/specification/_json_spec/ingest.get_pipeline.json index 11b0234f99..52867860c2 100644 --- a/specification/_json_spec/ingest.get_pipeline.json +++ b/specification/_json_spec/ingest.get_pipeline.json @@ -1,8 +1,8 @@ { "ingest.get_pipeline": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", - "description": "Returns a pipeline." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-pipeline", + "description": "Get pipelines" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "summary": { "type": "boolean", + "default": false, "description": "Return pipelines without their definitions (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/ingest.processor_grok.json b/specification/_json_spec/ingest.processor_grok.json index cc35eadba7..3162c2621b 100644 --- a/specification/_json_spec/ingest.processor_grok.json +++ b/specification/_json_spec/ingest.processor_grok.json @@ -1,8 +1,8 @@ { "ingest.processor_grok": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get", - "description": "Returns a list of the built-in patterns." + "url": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor", + "description": "Run a grok processor" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ingest.put_geoip_database.json b/specification/_json_spec/ingest.put_geoip_database.json index c732652c34..62a3d322f7 100644 --- a/specification/_json_spec/ingest.put_geoip_database.json +++ b/specification/_json_spec/ingest.put_geoip_database.json @@ -1,8 +1,8 @@ { "ingest.put_geoip_database": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-geoip-database-api.html", - "description": "Puts the configuration for a geoip database to be downloaded" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-geoip-database", + "description": "Create or update a GeoIP database configuration" }, "stability": "stable", "visibility": "public", @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ingest.put_ip_location_database.json b/specification/_json_spec/ingest.put_ip_location_database.json index 87a2adab72..dde223dcac 100644 --- a/specification/_json_spec/ingest.put_ip_location_database.json +++ b/specification/_json_spec/ingest.put_ip_location_database.json @@ -1,8 +1,8 @@ { "ingest.put_ip_location_database": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-ip-location-database-api.html", - "description": "Puts the configuration for a ip location database to be downloaded" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-ip-location-database", + "description": "Create or update an IP geolocation database configuration" }, "stability": "stable", "visibility": "public", @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ingest.put_pipeline.json b/specification/_json_spec/ingest.put_pipeline.json index f0ccd500c8..ef9143971b 100644 --- a/specification/_json_spec/ingest.put_pipeline.json +++ b/specification/_json_spec/ingest.put_pipeline.json @@ -1,8 +1,8 @@ { "ingest.put_pipeline": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html", - "description": "Creates or updates a pipeline." + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", + "description": "Create or update a pipeline" }, "stability": "stable", "visibility": "public", @@ -31,10 +31,12 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/ingest.simulate.json b/specification/_json_spec/ingest.simulate.json index cb1a6fdbf5..792de12c08 100644 --- a/specification/_json_spec/ingest.simulate.json +++ b/specification/_json_spec/ingest.simulate.json @@ -1,8 +1,8 @@ { "ingest.simulate": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", - "description": "Allows to simulate a pipeline with example documents." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-simulate", + "description": "Simulate a pipeline" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/knn_search.json b/specification/_json_spec/knn_search.json index b0d075d85b..7c2cb30773 100644 --- a/specification/_json_spec/knn_search.json +++ b/specification/_json_spec/knn_search.json @@ -1,8 +1,8 @@ { "knn_search": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", - "description": "Performs a kNN search." + "url": null, + "description": "Performs a kNN search" }, "stability": "experimental", "deprecated": { @@ -35,7 +35,8 @@ } }, "body": { - "description": "The search definition" + "description": "The search definition", + "required": true } } } diff --git a/specification/_json_spec/license.delete.json b/specification/_json_spec/license.delete.json index 146cd9c7e8..71d2804016 100644 --- a/specification/_json_spec/license.delete.json +++ b/specification/_json_spec/license.delete.json @@ -1,8 +1,8 @@ { "license.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", - "description": "Deletes licensing information for the cluster" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-delete", + "description": "Delete the license" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/license.get.json b/specification/_json_spec/license.get.json index 0b53e3f3d9..b34d5548ed 100644 --- a/specification/_json_spec/license.get.json +++ b/specification/_json_spec/license.get.json @@ -1,8 +1,8 @@ { "license.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", - "description": "Retrieves licensing information for the cluster" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get", + "description": "Get license information" }, "stability": "stable", "visibility": "public", @@ -20,12 +20,14 @@ "params": { "local": { "type": "boolean", + "default": true, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "accept_enterprise": { "type": "boolean", - "description": "Supported for backwards compatibility with 7.x. If this param is used it must be set to true", - "deprecated": true + "deprecated": true, + "default": true, + "description": "Supported for backwards compatibility with 7.x. If this param is used it must be set to true" } } } diff --git a/specification/_json_spec/license.get_basic_status.json b/specification/_json_spec/license.get_basic_status.json index 26beb66900..6b01af0f56 100644 --- a/specification/_json_spec/license.get_basic_status.json +++ b/specification/_json_spec/license.get_basic_status.json @@ -1,8 +1,8 @@ { "license.get_basic_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", - "description": "Retrieves information about the status of the basic license." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-basic-status", + "description": "Get the basic license status" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/license.get_trial_status.json b/specification/_json_spec/license.get_trial_status.json index 97afb87e0f..1034f0fd2e 100644 --- a/specification/_json_spec/license.get_trial_status.json +++ b/specification/_json_spec/license.get_trial_status.json @@ -1,8 +1,8 @@ { "license.get_trial_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", - "description": "Retrieves information about the status of the trial license." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-trial-status", + "description": "Get the trial status" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/license.post.json b/specification/_json_spec/license.post.json index 54e8c3762a..9f98571e92 100644 --- a/specification/_json_spec/license.post.json +++ b/specification/_json_spec/license.post.json @@ -1,8 +1,8 @@ { "license.post": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", - "description": "Updates the license for the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post", + "description": "Update the license" }, "stability": "stable", "visibility": "public", @@ -21,19 +21,23 @@ "params": { "acknowledge": { "type": "boolean", + "default": false, "description": "whether the user has acknowledged acknowledge messages (default: false)" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } }, "body": { - "description": "licenses to be installed" + "description": "licenses to be installed", + "required": false } } } diff --git a/specification/_json_spec/license.post_start_basic.json b/specification/_json_spec/license.post_start_basic.json index 3459d61df1..6e7bc37e01 100644 --- a/specification/_json_spec/license.post_start_basic.json +++ b/specification/_json_spec/license.post_start_basic.json @@ -1,8 +1,8 @@ { "license.post_start_basic": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", - "description": "Starts an indefinite basic license." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-basic", + "description": "Start a basic license" }, "stability": "stable", "visibility": "public", @@ -24,10 +24,12 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/license.post_start_trial.json b/specification/_json_spec/license.post_start_trial.json index b256612b33..91bb6e1b80 100644 --- a/specification/_json_spec/license.post_start_trial.json +++ b/specification/_json_spec/license.post_start_trial.json @@ -1,8 +1,8 @@ { "license.post_start_trial": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", - "description": "starts a limited time trial license." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-trial", + "description": "Start a trial" }, "stability": "stable", "visibility": "public", @@ -28,6 +28,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/logstash.delete_pipeline.json b/specification/_json_spec/logstash.delete_pipeline.json index 14cf1f0e50..6a550e4c8c 100644 --- a/specification/_json_spec/logstash.delete_pipeline.json +++ b/specification/_json_spec/logstash.delete_pipeline.json @@ -1,8 +1,8 @@ { "logstash.delete_pipeline": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", - "description": "Deletes Logstash Pipelines used by Central Management" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-delete-pipeline", + "description": "Delete a Logstash pipeline" }, "stability": "stable", "visibility": "public", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/logstash.get_pipeline.json b/specification/_json_spec/logstash.get_pipeline.json index fb8ad9a6f7..b109c37ecd 100644 --- a/specification/_json_spec/logstash.get_pipeline.json +++ b/specification/_json_spec/logstash.get_pipeline.json @@ -1,8 +1,8 @@ { "logstash.get_pipeline": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", - "description": "Retrieves Logstash Pipelines used by Central Management" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-get-pipeline", + "description": "Get Logstash pipelines" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/logstash.put_pipeline.json b/specification/_json_spec/logstash.put_pipeline.json index 8b2a0b580c..933a2544c2 100644 --- a/specification/_json_spec/logstash.put_pipeline.json +++ b/specification/_json_spec/logstash.put_pipeline.json @@ -1,8 +1,8 @@ { "logstash.put_pipeline": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", - "description": "Adds and updates Logstash Pipelines used for Central Management" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline", + "description": "Create or update a Logstash pipeline" }, "stability": "stable", "visibility": "public", @@ -24,7 +24,6 @@ } ] }, - "params": {}, "body": { "description": "The Pipeline to add or update", "required": true diff --git a/specification/_json_spec/mget.json b/specification/_json_spec/mget.json index 2d004dafab..d7dd2b0e9a 100644 --- a/specification/_json_spec/mget.json +++ b/specification/_json_spec/mget.json @@ -1,8 +1,8 @@ { "mget": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", - "description": "Allows to get multiple documents in one request." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget", + "description": "Get multiple documents" }, "stability": "stable", "visibility": "public", @@ -37,6 +37,7 @@ }, "stored_fields": { "type": "list", + "default": "false", "description": "A comma-separated list of stored fields to return in the response" }, "preference": { @@ -45,10 +46,12 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specify whether to perform the operation in realtime or search mode" }, "refresh": { "type": "boolean", + "default": false, "description": "Refresh the shard containing the document before performing the operation" }, "routing": { diff --git a/specification/_json_spec/migration.deprecations.json b/specification/_json_spec/migration.deprecations.json index 592079b140..8ef857188a 100644 --- a/specification/_json_spec/migration.deprecations.json +++ b/specification/_json_spec/migration.deprecations.json @@ -1,8 +1,8 @@ { "migration.deprecations": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", - "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-deprecations", + "description": "Get deprecation information" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/migration.get_feature_upgrade_status.json b/specification/_json_spec/migration.get_feature_upgrade_status.json index 5a508adf4b..24c338de86 100644 --- a/specification/_json_spec/migration.get_feature_upgrade_status.json +++ b/specification/_json_spec/migration.get_feature_upgrade_status.json @@ -1,8 +1,8 @@ { "migration.get_feature_upgrade_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", - "description": "Find out whether system features need to be upgraded or not" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status", + "description": "Get feature migration information" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/migration.post_feature_upgrade.json b/specification/_json_spec/migration.post_feature_upgrade.json index cfd99f0992..68b0477d46 100644 --- a/specification/_json_spec/migration.post_feature_upgrade.json +++ b/specification/_json_spec/migration.post_feature_upgrade.json @@ -1,8 +1,8 @@ { "migration.post_feature_upgrade": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", - "description": "Begin upgrades for system features" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status", + "description": "Start the feature migration" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["POST"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/ml.clear_trained_model_deployment_cache.json b/specification/_json_spec/ml.clear_trained_model_deployment_cache.json index 8fd5cdaf0a..4eb31dcb74 100644 --- a/specification/_json_spec/ml.clear_trained_model_deployment_cache.json +++ b/specification/_json_spec/ml.clear_trained_model_deployment_cache.json @@ -1,8 +1,8 @@ { "ml.clear_trained_model_deployment_cache": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html", - "description": "Clear the cached results from a trained model deployment" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache", + "description": "Clear trained model deployment cache" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.close_job.json b/specification/_json_spec/ml.close_job.json index 77e5e5653a..821b1e54e1 100644 --- a/specification/_json_spec/ml.close_job.json +++ b/specification/_json_spec/ml.close_job.json @@ -1,8 +1,8 @@ { "ml.close_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html", - "description": "Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job", + "description": "Close anomaly detection jobs" }, "stability": "stable", "visibility": "public", @@ -27,16 +27,17 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" }, "force": { "type": "boolean", - "required": false, + "default": false, "description": "True if the job should be forcefully closed" }, "timeout": { "type": "time", + "default": "30m", "description": "Controls the time to wait until a job has closed. Default to 30 minutes" } }, diff --git a/specification/_json_spec/ml.delete_calendar.json b/specification/_json_spec/ml.delete_calendar.json index 1cbcd934b1..6df4a889c0 100644 --- a/specification/_json_spec/ml.delete_calendar.json +++ b/specification/_json_spec/ml.delete_calendar.json @@ -1,8 +1,8 @@ { "ml.delete_calendar": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html", - "description": "Deletes a calendar." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar", + "description": "Delete a calendar" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.delete_calendar_event.json b/specification/_json_spec/ml.delete_calendar_event.json index ab425e545f..6c4e21e1fa 100644 --- a/specification/_json_spec/ml.delete_calendar_event.json +++ b/specification/_json_spec/ml.delete_calendar_event.json @@ -1,8 +1,8 @@ { "ml.delete_calendar_event": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html", - "description": "Deletes scheduled events from a calendar." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event", + "description": "Delete events from a calendar" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.delete_calendar_job.json b/specification/_json_spec/ml.delete_calendar_job.json index 3af8e86f31..ec00031677 100644 --- a/specification/_json_spec/ml.delete_calendar_job.json +++ b/specification/_json_spec/ml.delete_calendar_job.json @@ -1,8 +1,8 @@ { "ml.delete_calendar_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html", - "description": "Deletes anomaly detection jobs from a calendar." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job", + "description": "Delete anomaly jobs from a calendar" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.delete_data_frame_analytics.json b/specification/_json_spec/ml.delete_data_frame_analytics.json index 418438778f..af205b1065 100644 --- a/specification/_json_spec/ml.delete_data_frame_analytics.json +++ b/specification/_json_spec/ml.delete_data_frame_analytics.json @@ -1,8 +1,8 @@ { "ml.delete_data_frame_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html", - "description": "Deletes an existing data frame analytics job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-data-frame-analytics", + "description": "Delete a data frame analytics job" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Controls the time to wait until a job is deleted. Defaults to 1 minute" } } diff --git a/specification/_json_spec/ml.delete_datafeed.json b/specification/_json_spec/ml.delete_datafeed.json index 4a0350220f..1cac823610 100644 --- a/specification/_json_spec/ml.delete_datafeed.json +++ b/specification/_json_spec/ml.delete_datafeed.json @@ -1,8 +1,8 @@ { "ml.delete_datafeed": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html", - "description": "Deletes an existing datafeed." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed", + "description": "Delete a datafeed" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,6 @@ "params": { "force": { "type": "boolean", - "required": false, "description": "True if the datafeed should be forcefully deleted" } } diff --git a/specification/_json_spec/ml.delete_expired_data.json b/specification/_json_spec/ml.delete_expired_data.json index 73932205ec..14f9893849 100644 --- a/specification/_json_spec/ml.delete_expired_data.json +++ b/specification/_json_spec/ml.delete_expired_data.json @@ -1,8 +1,8 @@ { "ml.delete_expired_data": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", - "description": "Deletes expired and unused machine learning data." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-expired-data", + "description": "Delete expired ML data" }, "stability": "stable", "visibility": "public", @@ -31,17 +31,17 @@ "params": { "requests_per_second": { "type": "number", - "required": false, "description": "The desired requests per second for the deletion processes." }, "timeout": { "type": "time", - "required": false, + "default": "8h", "description": "How long can the underlying delete processes run until they are canceled" } }, "body": { - "description": "deleting expired data parameters" + "description": "deleting expired data parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.delete_filter.json b/specification/_json_spec/ml.delete_filter.json index 5b1359f6db..00eaac4e38 100644 --- a/specification/_json_spec/ml.delete_filter.json +++ b/specification/_json_spec/ml.delete_filter.json @@ -1,8 +1,8 @@ { "ml.delete_filter": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", - "description": "Deletes a filter." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-filter", + "description": "Delete a filter" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.delete_forecast.json b/specification/_json_spec/ml.delete_forecast.json index 363ed91e07..4f4d03e7f7 100644 --- a/specification/_json_spec/ml.delete_forecast.json +++ b/specification/_json_spec/ml.delete_forecast.json @@ -1,8 +1,8 @@ { "ml.delete_forecast": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", - "description": "Deletes forecasts from a machine learning job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-forecast", + "description": "Delete forecasts from a job" }, "stability": "stable", "visibility": "public", @@ -40,12 +40,12 @@ "params": { "allow_no_forecasts": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if `_all` matches no forecasts" }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds" } } diff --git a/specification/_json_spec/ml.delete_job.json b/specification/_json_spec/ml.delete_job.json index 1a48acbf2d..a7341a8a76 100644 --- a/specification/_json_spec/ml.delete_job.json +++ b/specification/_json_spec/ml.delete_job.json @@ -1,8 +1,8 @@ { "ml.delete_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", - "description": "Deletes an existing anomaly detection job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job", + "description": "Delete an anomaly detection job" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.delete_model_snapshot.json b/specification/_json_spec/ml.delete_model_snapshot.json index 77d76976fc..215cf0ecc7 100644 --- a/specification/_json_spec/ml.delete_model_snapshot.json +++ b/specification/_json_spec/ml.delete_model_snapshot.json @@ -1,8 +1,8 @@ { "ml.delete_model_snapshot": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", - "description": "Deletes an existing model snapshot." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-model-snapshot", + "description": "Delete a model snapshot" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.delete_trained_model.json b/specification/_json_spec/ml.delete_trained_model.json index 83920bc59c..daf0b83ee7 100644 --- a/specification/_json_spec/ml.delete_trained_model.json +++ b/specification/_json_spec/ml.delete_trained_model.json @@ -1,8 +1,8 @@ { "ml.delete_trained_model": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", - "description": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model", + "description": "Delete an unreferenced trained model" }, "stability": "stable", "visibility": "public", @@ -26,13 +26,11 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the amount of time to wait for the model to be deleted.", "default": "30s" }, "force": { "type": "boolean", - "required": false, "description": "True if the model should be forcefully deleted" } } diff --git a/specification/_json_spec/ml.delete_trained_model_alias.json b/specification/_json_spec/ml.delete_trained_model_alias.json index b7ed6b8ec5..6e3c11ff76 100644 --- a/specification/_json_spec/ml.delete_trained_model_alias.json +++ b/specification/_json_spec/ml.delete_trained_model_alias.json @@ -1,8 +1,8 @@ { "ml.delete_trained_model_alias": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", - "description": "Deletes a model alias that refers to the trained model" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias", + "description": "Delete a trained model alias" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.estimate_model_memory.json b/specification/_json_spec/ml.estimate_model_memory.json index c9706e9dab..5aa2ab6022 100644 --- a/specification/_json_spec/ml.estimate_model_memory.json +++ b/specification/_json_spec/ml.estimate_model_memory.json @@ -1,8 +1,8 @@ { "ml.estimate_model_memory": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", - "description": "Estimates the model memory" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory", + "description": "Estimate job model memory usage" }, "stability": "stable", "visibility": "public", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The analysis config, plus cardinality estimates for fields it references", "required": true diff --git a/specification/_json_spec/ml.evaluate_data_frame.json b/specification/_json_spec/ml.evaluate_data_frame.json index ce4cd6024a..f19597b443 100644 --- a/specification/_json_spec/ml.evaluate_data_frame.json +++ b/specification/_json_spec/ml.evaluate_data_frame.json @@ -1,8 +1,8 @@ { "ml.evaluate_data_frame": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", - "description": "Evaluates the data frame analytics for an annotated index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame", + "description": "Evaluate data frame analytics" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.explain_data_frame_analytics.json b/specification/_json_spec/ml.explain_data_frame_analytics.json index 3550158884..8912c4b543 100644 --- a/specification/_json_spec/ml.explain_data_frame_analytics.json +++ b/specification/_json_spec/ml.explain_data_frame_analytics.json @@ -1,8 +1,8 @@ { "ml.explain_data_frame_analytics": { "documentation": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", - "description": "Explains a data frame analytics config." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-explain-data-frame-analytics", + "description": "Explain data frame analytics config" }, "stability": "stable", "visibility": "public", @@ -14,8 +14,7 @@ "paths": [ { "path": "/_ml/data_frame/analytics/_explain", - "methods": ["GET", "POST"], - "parts": {} + "methods": ["GET", "POST"] }, { "path": "/_ml/data_frame/analytics/{id}/_explain", diff --git a/specification/_json_spec/ml.flush_job.json b/specification/_json_spec/ml.flush_job.json index 917c00e019..61be07dd82 100644 --- a/specification/_json_spec/ml.flush_job.json +++ b/specification/_json_spec/ml.flush_job.json @@ -1,8 +1,8 @@ { "ml.flush_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", - "description": "Forces any buffered data to be processed by the job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job", + "description": "Force buffered data to be processed" }, "stability": "stable", "visibility": "public", @@ -47,7 +47,8 @@ } }, "body": { - "description": "Flush parameters" + "description": "Flush parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.forecast.json b/specification/_json_spec/ml.forecast.json index f54cd04b51..dc99c2956a 100644 --- a/specification/_json_spec/ml.forecast.json +++ b/specification/_json_spec/ml.forecast.json @@ -1,8 +1,8 @@ { "ml.forecast": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", - "description": "Predicts the future behavior of a time series by using its historical behavior." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-forecast", + "description": "Predict future behavior of a time series" }, "stability": "stable", "visibility": "public", @@ -27,17 +27,17 @@ "params": { "duration": { "type": "time", - "required": false, + "default": "1d", "description": "The duration of the forecast" }, "expires_in": { "type": "time", - "required": false, + "default": "14d", "description": "The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity." }, "max_model_memory": { "type": "string", - "required": false, + "default": "20mb", "description": "The max memory able to be used by the forecast. Default is 20mb." } }, diff --git a/specification/_json_spec/ml.get_buckets.json b/specification/_json_spec/ml.get_buckets.json index d0137f21f9..68e4655b41 100644 --- a/specification/_json_spec/ml.get_buckets.json +++ b/specification/_json_spec/ml.get_buckets.json @@ -1,8 +1,8 @@ { "ml.get_buckets": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", - "description": "Retrieves anomaly detection job results for one or more buckets." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-buckets", + "description": "Get anomaly detection job results for buckets" }, "stability": "stable", "visibility": "public", @@ -41,43 +41,53 @@ "params": { "expand": { "type": "boolean", + "default": false, "description": "Include anomaly records" }, "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of buckets" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of buckets to get" }, "start": { "type": "string", + "default": "-1", "description": "Start time filter for buckets" }, "end": { "type": "string", + "default": "-1", "description": "End time filter for buckets" }, "anomaly_score": { "type": "double", + "default": 0, "description": "Filter for the most anomalous buckets" }, "sort": { "type": "string", + "default": "timestamp", "description": "Sort buckets by a particular field" }, "desc": { "type": "boolean", + "default": false, "description": "Set the sort direction" } }, "body": { - "description": "Bucket selection details if not provided in URI" + "description": "Bucket selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_calendar_events.json b/specification/_json_spec/ml.get_calendar_events.json index c72c28af33..2757b7653d 100644 --- a/specification/_json_spec/ml.get_calendar_events.json +++ b/specification/_json_spec/ml.get_calendar_events.json @@ -1,8 +1,8 @@ { "ml.get_calendar_events": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", - "description": "Retrieves information about the scheduled events in calendars." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events", + "description": "Get info about events in calendars" }, "stability": "stable", "visibility": "public", @@ -38,10 +38,12 @@ }, "from": { "type": "int", + "default": 0, "description": "Skips a number of events" }, "size": { "type": "int", + "default": 100, "description": "Specifies a max number of events to get" } } diff --git a/specification/_json_spec/ml.get_calendars.json b/specification/_json_spec/ml.get_calendars.json index 81b6667a6b..50afc723b0 100644 --- a/specification/_json_spec/ml.get_calendars.json +++ b/specification/_json_spec/ml.get_calendars.json @@ -1,8 +1,8 @@ { "ml.get_calendars": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", - "description": "Retrieves configuration information for calendars." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars", + "description": "Get calendar configuration info" }, "stability": "stable", "visibility": "public", @@ -31,15 +31,18 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of calendars" }, "size": { "type": "int", + "default": 10000, "description": "specifies a max number of calendars to get" } }, "body": { - "description": "The from and size parameters optionally sent in the body" + "description": "The from and size parameters optionally sent in the body", + "required": false } } } diff --git a/specification/_json_spec/ml.get_categories.json b/specification/_json_spec/ml.get_categories.json index d90733e887..169f133a40 100644 --- a/specification/_json_spec/ml.get_categories.json +++ b/specification/_json_spec/ml.get_categories.json @@ -1,8 +1,8 @@ { "ml.get_categories": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", - "description": "Retrieves anomaly detection job results for one or more categories." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-categories", + "description": "Get anomaly detection job results for categories" }, "stability": "stable", "visibility": "public", @@ -41,10 +41,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of categories" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of categories to get" }, "partition_field_value": { @@ -53,7 +55,8 @@ } }, "body": { - "description": "Category selection details if not provided in URI" + "description": "Category selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_data_frame_analytics.json b/specification/_json_spec/ml.get_data_frame_analytics.json index 6fc5ad18fb..56a2544fac 100644 --- a/specification/_json_spec/ml.get_data_frame_analytics.json +++ b/specification/_json_spec/ml.get_data_frame_analytics.json @@ -1,8 +1,8 @@ { "ml.get_data_frame_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", - "description": "Retrieves configuration information for data frame analytics jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics", + "description": "Get data frame analytics job configuration info" }, "stability": "stable", "visibility": "public", @@ -30,7 +30,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)", "default": true }, @@ -45,7 +44,6 @@ "default": 100 }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on data frame analytics PUT" diff --git a/specification/_json_spec/ml.get_data_frame_analytics_stats.json b/specification/_json_spec/ml.get_data_frame_analytics_stats.json index 2872b798d0..06f1eca928 100644 --- a/specification/_json_spec/ml.get_data_frame_analytics_stats.json +++ b/specification/_json_spec/ml.get_data_frame_analytics_stats.json @@ -1,8 +1,8 @@ { "ml.get_data_frame_analytics_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", - "description": "Retrieves usage information for data frame analytics jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats", + "description": "Get data frame analytics job stats" }, "stability": "stable", "visibility": "public", @@ -30,7 +30,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)", "default": true }, @@ -46,7 +45,6 @@ }, "verbose": { "type": "boolean", - "required": false, "description": "whether the stats response should be verbose", "default": false } diff --git a/specification/_json_spec/ml.get_datafeed_stats.json b/specification/_json_spec/ml.get_datafeed_stats.json index 1ac61896cb..f89efe2200 100644 --- a/specification/_json_spec/ml.get_datafeed_stats.json +++ b/specification/_json_spec/ml.get_datafeed_stats.json @@ -1,8 +1,8 @@ { "ml.get_datafeed_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", - "description": "Retrieves usage information for datafeeds." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats", + "description": "Get datafeed stats" }, "stability": "stable", "visibility": "public", @@ -30,7 +30,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)" } } diff --git a/specification/_json_spec/ml.get_datafeeds.json b/specification/_json_spec/ml.get_datafeeds.json index 3aa9eac4e3..dc33d432ff 100644 --- a/specification/_json_spec/ml.get_datafeeds.json +++ b/specification/_json_spec/ml.get_datafeeds.json @@ -1,8 +1,8 @@ { "ml.get_datafeeds": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", - "description": "Retrieves configuration information for datafeeds." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds", + "description": "Get datafeeds configuration info" }, "stability": "stable", "visibility": "public", @@ -30,11 +30,9 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)" }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on datafeed PUT" diff --git a/specification/_json_spec/ml.get_filters.json b/specification/_json_spec/ml.get_filters.json index ee19686cc9..089026f476 100644 --- a/specification/_json_spec/ml.get_filters.json +++ b/specification/_json_spec/ml.get_filters.json @@ -1,8 +1,8 @@ { "ml.get_filters": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", - "description": "Retrieves filters." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-filters", + "description": "Get filters" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "skips a number of filters" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of filters to get" } } diff --git a/specification/_json_spec/ml.get_influencers.json b/specification/_json_spec/ml.get_influencers.json index 4cedbf4882..d794aae6d9 100644 --- a/specification/_json_spec/ml.get_influencers.json +++ b/specification/_json_spec/ml.get_influencers.json @@ -1,8 +1,8 @@ { "ml.get_influencers": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", - "description": "Retrieves anomaly detection job results for one or more influencers." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-influencers", + "description": "Get anomaly detection job results for influencers" }, "stability": "stable", "visibility": "public", @@ -27,26 +27,32 @@ "params": { "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of influencers" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of influencers to get" }, "start": { "type": "string", + "default": "-1", "description": "start timestamp for the requested influencers" }, "end": { "type": "string", + "default": "-1", "description": "end timestamp for the requested influencers" }, "influencer_score": { "type": "double", + "default": 0, "description": "influencer score threshold for the requested influencers" }, "sort": { @@ -55,11 +61,13 @@ }, "desc": { "type": "boolean", + "default": false, "description": "whether the results should be sorted in decending order" } }, "body": { - "description": "Influencer selection criteria" + "description": "Influencer selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_job_stats.json b/specification/_json_spec/ml.get_job_stats.json index 2714e60470..22c6f04db8 100644 --- a/specification/_json_spec/ml.get_job_stats.json +++ b/specification/_json_spec/ml.get_job_stats.json @@ -1,8 +1,8 @@ { "ml.get_job_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", - "description": "Retrieves usage information for anomaly detection jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats", + "description": "Get anomaly detection job stats" }, "stability": "stable", "visibility": "public", @@ -30,7 +30,7 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" } } diff --git a/specification/_json_spec/ml.get_jobs.json b/specification/_json_spec/ml.get_jobs.json index 32bbe3bb14..0b2528684a 100644 --- a/specification/_json_spec/ml.get_jobs.json +++ b/specification/_json_spec/ml.get_jobs.json @@ -1,8 +1,8 @@ { "ml.get_jobs": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", - "description": "Retrieves configuration information for anomaly detection jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-jobs", + "description": "Get anomaly detection jobs configuration info" }, "stability": "stable", "visibility": "public", @@ -30,11 +30,10 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)" }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on job PUT" diff --git a/specification/_json_spec/ml.get_memory_stats.json b/specification/_json_spec/ml.get_memory_stats.json index de0a268f89..835d9a9bf3 100644 --- a/specification/_json_spec/ml.get_memory_stats.json +++ b/specification/_json_spec/ml.get_memory_stats.json @@ -1,8 +1,8 @@ { "ml.get_memory_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html", - "description": "Returns information on how ML is using memory." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-memory-stats", + "description": "Get machine learning memory usage info" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json b/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json index cf610477e8..d868fa96e3 100644 --- a/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json +++ b/specification/_json_spec/ml.get_model_snapshot_upgrade_stats.json @@ -1,8 +1,8 @@ { "ml.get_model_snapshot_upgrade_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", - "description": "Gets stats for anomaly detection job model snapshot upgrades that are in progress." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshot-upgrade-stats", + "description": "Get anomaly detection job model snapshot upgrade usage info" }, "stability": "stable", "visibility": "public", @@ -30,7 +30,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.)" } } diff --git a/specification/_json_spec/ml.get_model_snapshots.json b/specification/_json_spec/ml.get_model_snapshots.json index 58d5065e49..be83c8ce84 100644 --- a/specification/_json_spec/ml.get_model_snapshots.json +++ b/specification/_json_spec/ml.get_model_snapshots.json @@ -1,8 +1,8 @@ { "ml.get_model_snapshots": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", - "description": "Retrieves information about model snapshots." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshots", + "description": "Get model snapshots info" }, "stability": "stable", "visibility": "public", @@ -41,10 +41,12 @@ "params": { "from": { "type": "int", + "default": 0, "description": "Skips a number of documents" }, "size": { "type": "int", + "default": 100, "description": "The default number of documents returned in queries as a string." }, "start": { @@ -61,11 +63,13 @@ }, "desc": { "type": "boolean", + "default": false, "description": "True if the results should be sorted in descending order" } }, "body": { - "description": "Model snapshot selection criteria" + "description": "Model snapshot selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_overall_buckets.json b/specification/_json_spec/ml.get_overall_buckets.json index 684e0eab42..79917afa60 100644 --- a/specification/_json_spec/ml.get_overall_buckets.json +++ b/specification/_json_spec/ml.get_overall_buckets.json @@ -1,8 +1,8 @@ { "ml.get_overall_buckets": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", - "description": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets", + "description": "Get overall bucket results" }, "stability": "stable", "visibility": "public", @@ -27,6 +27,7 @@ "params": { "top_n": { "type": "int", + "default": 1, "description": "The number of top job bucket scores to be used in the overall_score calculation" }, "bucket_span": { @@ -39,6 +40,7 @@ }, "exclude_interim": { "type": "boolean", + "default": false, "description": "If true overall buckets that include interim buckets will be excluded" }, "start": { @@ -51,11 +53,13 @@ }, "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)" } }, "body": { - "description": "Overall bucket selection details if not provided in URI" + "description": "Overall bucket selection details if not provided in URI", + "required": false } } } diff --git a/specification/_json_spec/ml.get_records.json b/specification/_json_spec/ml.get_records.json index 21a4dd64e9..9d4dde88ef 100644 --- a/specification/_json_spec/ml.get_records.json +++ b/specification/_json_spec/ml.get_records.json @@ -1,8 +1,8 @@ { "ml.get_records": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", - "description": "Retrieves anomaly records for an anomaly detection job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-records", + "description": "Get anomaly records for an anomaly detection job" }, "stability": "stable", "visibility": "public", @@ -27,39 +27,48 @@ "params": { "exclude_interim": { "type": "boolean", + "default": false, "description": "Exclude interim results" }, "from": { "type": "int", + "default": 0, "description": "skips a number of records" }, "size": { "type": "int", + "default": 100, "description": "specifies a max number of records to get" }, "start": { "type": "string", + "default": "-1", "description": "Start time filter for records" }, "end": { "type": "string", + "default": "-1", "description": "End time filter for records" }, "record_score": { "type": "double", + "default": 0, "description": "Returns records with anomaly scores greater or equal than this value" }, "sort": { "type": "string", + "default": "record_score", "description": "Sort records by a particular field" }, "desc": { "type": "boolean", + "default": false, "description": "Set the sort direction" } }, "body": { - "description": "Record selection criteria" + "description": "Record selection criteria", + "required": false } } } diff --git a/specification/_json_spec/ml.get_trained_models.json b/specification/_json_spec/ml.get_trained_models.json index 9f1fb051d5..d48c5054f5 100644 --- a/specification/_json_spec/ml.get_trained_models.json +++ b/specification/_json_spec/ml.get_trained_models.json @@ -1,8 +1,8 @@ { "ml.get_trained_models": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", - "description": "Retrieves configuration information for a trained inference model." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models", + "description": "Get trained model configuration info" }, "stability": "stable", "visibility": "public", @@ -30,40 +30,33 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default": true }, "include": { "type": "string", - "required": false, "description": "A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none." }, "decompress_definition": { "type": "boolean", - "required": false, "default": true, "description": "Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true." }, "from": { - "required": false, "type": "int", "description": "skips a number of trained models", "default": 0 }, "size": { - "required": false, "type": "int", "description": "specifies a max number of trained models to get", "default": 100 }, "tags": { - "required": false, "type": "list", "description": "A comma-separated list of tags that the model must have." }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on model PUT" diff --git a/specification/_json_spec/ml.get_trained_models_stats.json b/specification/_json_spec/ml.get_trained_models_stats.json index d9342dc81d..41f5f40180 100644 --- a/specification/_json_spec/ml.get_trained_models_stats.json +++ b/specification/_json_spec/ml.get_trained_models_stats.json @@ -1,8 +1,8 @@ { "ml.get_trained_models_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", - "description": "Retrieves usage information for trained inference models." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models-stats", + "description": "Get trained models usage info" }, "stability": "stable", "visibility": "public", @@ -30,7 +30,6 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, "description": "Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)", "default": true }, diff --git a/specification/_json_spec/ml.infer_trained_model.json b/specification/_json_spec/ml.infer_trained_model.json index 220f7c1fc4..b3461333c6 100644 --- a/specification/_json_spec/ml.infer_trained_model.json +++ b/specification/_json_spec/ml.infer_trained_model.json @@ -1,8 +1,8 @@ { "ml.infer_trained_model": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", - "description": "Evaluate a trained model." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model", + "description": "Evaluate a trained model" }, "stability": "stable", "visibility": "public", @@ -28,7 +28,6 @@ "params": { "timeout": { "type": "time", - "required": false, "description": "Controls the amount of time to wait for inference results.", "default": "10s" } diff --git a/specification/_json_spec/ml.info.json b/specification/_json_spec/ml.info.json index a061d5b05a..dc4f31ca49 100644 --- a/specification/_json_spec/ml.info.json +++ b/specification/_json_spec/ml.info.json @@ -1,8 +1,8 @@ { "ml.info": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", - "description": "Returns defaults and limits used by machine learning." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-info", + "description": "Get machine learning information" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.open_job.json b/specification/_json_spec/ml.open_job.json index 5e8bf45bad..e83bd81d77 100644 --- a/specification/_json_spec/ml.open_job.json +++ b/specification/_json_spec/ml.open_job.json @@ -1,8 +1,8 @@ { "ml.open_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", - "description": "Opens one or more anomaly detection jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job", + "description": "Open anomaly detection jobs" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.post_calendar_events.json b/specification/_json_spec/ml.post_calendar_events.json index 11fcf7266b..d595161f14 100644 --- a/specification/_json_spec/ml.post_calendar_events.json +++ b/specification/_json_spec/ml.post_calendar_events.json @@ -1,8 +1,8 @@ { "ml.post_calendar_events": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", - "description": "Posts scheduled events in a calendar." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events", + "description": "Add scheduled events to the calendar" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.post_data.json b/specification/_json_spec/ml.post_data.json index 809ecf8e25..9251b1d047 100644 --- a/specification/_json_spec/ml.post_data.json +++ b/specification/_json_spec/ml.post_data.json @@ -1,8 +1,8 @@ { "ml.post_data": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", - "description": "Sends data to an anomaly detection job for analysis." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-data", + "description": "Send data to an anomaly detection job for analysis" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.preview_data_frame_analytics.json b/specification/_json_spec/ml.preview_data_frame_analytics.json index dba25b88db..cac75e8c64 100644 --- a/specification/_json_spec/ml.preview_data_frame_analytics.json +++ b/specification/_json_spec/ml.preview_data_frame_analytics.json @@ -1,8 +1,8 @@ { "ml.preview_data_frame_analytics": { "documentation": { - "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", - "description": "Previews that will be analyzed given a data frame analytics config." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics", + "description": "Preview features used by data frame analytics" }, "stability": "stable", "visibility": "public", @@ -14,8 +14,7 @@ "paths": [ { "path": "/_ml/data_frame/analytics/_preview", - "methods": ["GET", "POST"], - "parts": {} + "methods": ["GET", "POST"] }, { "path": "/_ml/data_frame/analytics/{id}/_preview", diff --git a/specification/_json_spec/ml.preview_datafeed.json b/specification/_json_spec/ml.preview_datafeed.json index 1d6502fa4f..e6f29b9963 100644 --- a/specification/_json_spec/ml.preview_datafeed.json +++ b/specification/_json_spec/ml.preview_datafeed.json @@ -1,8 +1,8 @@ { "ml.preview_datafeed": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", - "description": "Previews a datafeed." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-datafeed", + "description": "Preview a datafeed" }, "stability": "stable", "visibility": "public", @@ -31,12 +31,10 @@ "params": { "start": { "type": "string", - "required": false, "description": "The start time from where the datafeed preview should begin" }, "end": { "type": "string", - "required": false, "description": "The end time when the datafeed preview should stop" } }, diff --git a/specification/_json_spec/ml.put_calendar.json b/specification/_json_spec/ml.put_calendar.json index f36f52a037..22933baecd 100644 --- a/specification/_json_spec/ml.put_calendar.json +++ b/specification/_json_spec/ml.put_calendar.json @@ -1,8 +1,8 @@ { "ml.put_calendar": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", - "description": "Instantiates a calendar." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar", + "description": "Create a calendar" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.put_calendar_job.json b/specification/_json_spec/ml.put_calendar_job.json index 5e70d24b3f..6854146dcf 100644 --- a/specification/_json_spec/ml.put_calendar_job.json +++ b/specification/_json_spec/ml.put_calendar_job.json @@ -1,8 +1,8 @@ { "ml.put_calendar_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", - "description": "Adds an anomaly detection job to a calendar." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar-job", + "description": "Add anomaly detection job to calendar" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.put_data_frame_analytics.json b/specification/_json_spec/ml.put_data_frame_analytics.json index 44df6ff29b..9d75f4739e 100644 --- a/specification/_json_spec/ml.put_data_frame_analytics.json +++ b/specification/_json_spec/ml.put_data_frame_analytics.json @@ -1,8 +1,8 @@ { "ml.put_data_frame_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html", - "description": "Instantiates a data frame analytics job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", + "description": "Create a data frame analytics job" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.put_datafeed.json b/specification/_json_spec/ml.put_datafeed.json index 4c0c2e4bcb..3446c9bf33 100644 --- a/specification/_json_spec/ml.put_datafeed.json +++ b/specification/_json_spec/ml.put_datafeed.json @@ -1,8 +1,8 @@ { "ml.put_datafeed": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", - "description": "Instantiates a datafeed." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed", + "description": "Create a datafeed" }, "stability": "stable", "visibility": "public", @@ -31,19 +31,23 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Ignore indices that are marked as throttled (default: true)" }, "expand_wildcards": { "type": "enum", "options": ["open", "closed", "hidden", "none", "all"], + "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open)" } } diff --git a/specification/_json_spec/ml.put_filter.json b/specification/_json_spec/ml.put_filter.json index 377d0615f1..7d928383ce 100644 --- a/specification/_json_spec/ml.put_filter.json +++ b/specification/_json_spec/ml.put_filter.json @@ -1,8 +1,8 @@ { "ml.put_filter": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", - "description": "Instantiates a filter." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter", + "description": "Create a filter" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.put_job.json b/specification/_json_spec/ml.put_job.json index a30b34207d..a8754e6fc4 100644 --- a/specification/_json_spec/ml.put_job.json +++ b/specification/_json_spec/ml.put_job.json @@ -1,8 +1,8 @@ { "ml.put_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", - "description": "Instantiates an anomaly detection job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job", + "description": "Create an anomaly detection job" }, "stability": "stable", "visibility": "public", @@ -27,19 +27,23 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false). Only set if datafeed_config is provided." }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided." }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided." }, "expand_wildcards": { "type": "enum", "options": ["open", "closed", "hidden", "none", "all"], + "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided." } }, diff --git a/specification/_json_spec/ml.put_trained_model.json b/specification/_json_spec/ml.put_trained_model.json index 5e34ae325c..da873e35ee 100644 --- a/specification/_json_spec/ml.put_trained_model.json +++ b/specification/_json_spec/ml.put_trained_model.json @@ -1,8 +1,8 @@ { "ml.put_trained_model": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", - "description": "Creates an inference trained model." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model", + "description": "Create a trained model" }, "stability": "stable", "visibility": "public", @@ -26,13 +26,11 @@ }, "params": { "defer_definition_decompression": { - "required": false, "type": "boolean", "description": "If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.", "default": false }, "wait_for_completion": { - "required": false, "type": "boolean", "description": "Whether to wait for all child operations(e.g. model download) to complete, before returning or not. Default to false", "default": false diff --git a/specification/_json_spec/ml.put_trained_model_alias.json b/specification/_json_spec/ml.put_trained_model_alias.json index 42b0ae23a2..dfeb1324aa 100644 --- a/specification/_json_spec/ml.put_trained_model_alias.json +++ b/specification/_json_spec/ml.put_trained_model_alias.json @@ -1,8 +1,8 @@ { "ml.put_trained_model_alias": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", - "description": "Creates a new model alias (or reassigns an existing one) to refer to the trained model" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias", + "description": "Create or update a trained model alias" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "reassign": { "type": "boolean", + "default": false, "description": "If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false." } } diff --git a/specification/_json_spec/ml.put_trained_model_definition_part.json b/specification/_json_spec/ml.put_trained_model_definition_part.json index 48caff5490..b73040c3c9 100644 --- a/specification/_json_spec/ml.put_trained_model_definition_part.json +++ b/specification/_json_spec/ml.put_trained_model_definition_part.json @@ -1,8 +1,8 @@ { "ml.put_trained_model_definition_part": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", - "description": "Creates part of a trained model definition" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-definition-part", + "description": "Create part of a trained model definition" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.put_trained_model_vocabulary.json b/specification/_json_spec/ml.put_trained_model_vocabulary.json index 79c885c8b0..5c4c61cdaa 100644 --- a/specification/_json_spec/ml.put_trained_model_vocabulary.json +++ b/specification/_json_spec/ml.put_trained_model_vocabulary.json @@ -1,8 +1,8 @@ { "ml.put_trained_model_vocabulary": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", - "description": "Creates a trained model vocabulary" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-vocabulary", + "description": "Create a trained model vocabulary" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.reset_job.json b/specification/_json_spec/ml.reset_job.json index 753ecf82bf..4ba8cdc13d 100644 --- a/specification/_json_spec/ml.reset_job.json +++ b/specification/_json_spec/ml.reset_job.json @@ -1,8 +1,8 @@ { "ml.reset_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", - "description": "Resets an existing anomaly detection job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job", + "description": "Reset an anomaly detection job" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.revert_model_snapshot.json b/specification/_json_spec/ml.revert_model_snapshot.json index cfe2d38564..9c3f75d54d 100644 --- a/specification/_json_spec/ml.revert_model_snapshot.json +++ b/specification/_json_spec/ml.revert_model_snapshot.json @@ -1,8 +1,8 @@ { "ml.revert_model_snapshot": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", - "description": "Reverts to a specific snapshot." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-revert-model-snapshot", + "description": "Revert to a snapshot" }, "stability": "stable", "visibility": "public", @@ -31,11 +31,13 @@ "params": { "delete_intervening_results": { "type": "boolean", + "default": false, "description": "Should we reset the results back to the time of the snapshot?" } }, "body": { - "description": "Reversion options" + "description": "Reversion options", + "required": false } } } diff --git a/specification/_json_spec/ml.set_upgrade_mode.json b/specification/_json_spec/ml.set_upgrade_mode.json index 27e99e1bbd..f6a57b744a 100644 --- a/specification/_json_spec/ml.set_upgrade_mode.json +++ b/specification/_json_spec/ml.set_upgrade_mode.json @@ -1,8 +1,8 @@ { "ml.set_upgrade_mode": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", - "description": "Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-set-upgrade-mode", + "description": "Set upgrade_mode for ML indices" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "enabled": { "type": "boolean", + "default": false, "description": "Whether to enable upgrade_mode ML setting or not. Defaults to false." }, "timeout": { "type": "time", + "default": "30s", "description": "Controls the time to wait before action times out. Defaults to 30 seconds" } } diff --git a/specification/_json_spec/ml.start_data_frame_analytics.json b/specification/_json_spec/ml.start_data_frame_analytics.json index f9e5549bc7..5f9b4a3fcf 100644 --- a/specification/_json_spec/ml.start_data_frame_analytics.json +++ b/specification/_json_spec/ml.start_data_frame_analytics.json @@ -1,8 +1,8 @@ { "ml.start_data_frame_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", - "description": "Starts a data frame analytics job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics", + "description": "Start a data frame analytics job" }, "stability": "stable", "visibility": "public", @@ -27,12 +27,13 @@ "params": { "timeout": { "type": "time", - "required": false, + "default": "20s", "description": "Controls the time to wait until the task has started. Defaults to 20 seconds" } }, "body": { - "description": "The start data frame analytics parameters" + "description": "The start data frame analytics parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.start_datafeed.json b/specification/_json_spec/ml.start_datafeed.json index cc7e2f5c5b..0dc8a49343 100644 --- a/specification/_json_spec/ml.start_datafeed.json +++ b/specification/_json_spec/ml.start_datafeed.json @@ -1,8 +1,8 @@ { "ml.start_datafeed": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", - "description": "Starts one or more datafeeds." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed", + "description": "Start datafeeds" }, "stability": "stable", "visibility": "public", @@ -27,22 +27,21 @@ "params": { "start": { "type": "string", - "required": false, "description": "The start time from where the datafeed should begin" }, "end": { "type": "string", - "required": false, "description": "The end time when the datafeed should stop. When not set, the datafeed continues in real time" }, "timeout": { "type": "time", - "required": false, + "default": "20s", "description": "Controls the time to wait until a datafeed has started. Default to 20 seconds" } }, "body": { - "description": "The start datafeed parameters" + "description": "The start datafeed parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.start_trained_model_deployment.json b/specification/_json_spec/ml.start_trained_model_deployment.json index d4fc693862..b5d4f8a7ec 100644 --- a/specification/_json_spec/ml.start_trained_model_deployment.json +++ b/specification/_json_spec/ml.start_trained_model_deployment.json @@ -1,8 +1,8 @@ { "ml.start_trained_model_deployment": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", - "description": "Start a trained model deployment." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-trained-model-deployment", + "description": "Start a trained model deployment" }, "stability": "stable", "visibility": "public", @@ -28,47 +28,39 @@ "params": { "cache_size": { "type": "string", - "description": "A byte-size value for configuring the inference cache size. For example, 20mb.", - "required": false + "description": "A byte-size value for configuring the inference cache size. For example, 20mb." }, "deployment_id": { "type": "string", - "description": "The Id of the new deployment. Defaults to the model_id if not set.", - "required": false + "description": "The Id of the new deployment. Defaults to the model_id if not set." }, "number_of_allocations": { "type": "int", "description": "The total number of allocations this model is assigned across machine learning nodes.", - "required": false, "default": 1 }, "threads_per_allocation": { "type": "int", "description": "The number of threads used by each model allocation during inference.", - "required": false, "default": 1 }, "priority": { "type": "string", "description": "The deployment priority.", - "required": false, "default": "normal" }, "queue_capacity": { "type": "int", "description": "Controls how many inference requests are allowed in the queue at a time.", - "required": false, "default": 1024 }, "timeout": { "type": "time", - "required": false, "description": "Controls the amount of time to wait for the model to deploy.", "default": "20s" }, "wait_for": { "type": "string", - "required": false, "description": "The allocation status for which to wait", "options": ["starting", "started", "fully_allocated"], "default": "started" diff --git a/specification/_json_spec/ml.stop_data_frame_analytics.json b/specification/_json_spec/ml.stop_data_frame_analytics.json index b4fa6e9a18..4f8a60218e 100644 --- a/specification/_json_spec/ml.stop_data_frame_analytics.json +++ b/specification/_json_spec/ml.stop_data_frame_analytics.json @@ -1,8 +1,8 @@ { "ml.stop_data_frame_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", - "description": "Stops one or more data frame analytics jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics", + "description": "Stop data frame analytics jobs" }, "stability": "stable", "visibility": "public", @@ -27,22 +27,23 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)" }, "force": { "type": "boolean", - "required": false, + "default": false, "description": "True if the data frame analytics should be forcefully stopped" }, "timeout": { "type": "time", - "required": false, + "default": "20s", "description": "Controls the time to wait until the task has stopped. Defaults to 20 seconds" } }, "body": { - "description": "The stop data frame analytics parameters" + "description": "The stop data frame analytics parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.stop_datafeed.json b/specification/_json_spec/ml.stop_datafeed.json index b3faacb438..372ecb47a4 100644 --- a/specification/_json_spec/ml.stop_datafeed.json +++ b/specification/_json_spec/ml.stop_datafeed.json @@ -1,8 +1,8 @@ { "ml.stop_datafeed": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", - "description": "Stops one or more datafeeds." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed", + "description": "Stop datafeeds" }, "stability": "stable", "visibility": "public", @@ -27,17 +27,17 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)" }, "force": { "type": "boolean", - "required": false, + "default": false, "description": "True if the datafeed should be forcefully stopped." }, "timeout": { "type": "time", - "required": false, + "default": "20s", "description": "Controls the time to wait until a datafeed has stopped. Default to 20 seconds" } }, diff --git a/specification/_json_spec/ml.stop_trained_model_deployment.json b/specification/_json_spec/ml.stop_trained_model_deployment.json index fe57dddf90..2b0dffcfd1 100644 --- a/specification/_json_spec/ml.stop_trained_model_deployment.json +++ b/specification/_json_spec/ml.stop_trained_model_deployment.json @@ -1,8 +1,8 @@ { "ml.stop_trained_model_deployment": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", - "description": "Stop a trained model deployment." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment", + "description": "Stop a trained model deployment" }, "stability": "stable", "visibility": "public", @@ -28,17 +28,18 @@ "params": { "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified)" }, "force": { "type": "boolean", - "required": false, + "default": false, "description": "True if the deployment should be forcefully stopped" } }, "body": { - "description": "The stop deployment parameters" + "description": "The stop deployment parameters", + "required": false } } } diff --git a/specification/_json_spec/ml.update_data_frame_analytics.json b/specification/_json_spec/ml.update_data_frame_analytics.json index c2083f36ec..75593e2928 100644 --- a/specification/_json_spec/ml.update_data_frame_analytics.json +++ b/specification/_json_spec/ml.update_data_frame_analytics.json @@ -1,8 +1,8 @@ { "ml.update_data_frame_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", - "description": "Updates certain properties of a data frame analytics job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics", + "description": "Update a data frame analytics job" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.update_datafeed.json b/specification/_json_spec/ml.update_datafeed.json index ac6fca29d9..35bb5ebd3f 100644 --- a/specification/_json_spec/ml.update_datafeed.json +++ b/specification/_json_spec/ml.update_datafeed.json @@ -1,8 +1,8 @@ { "ml.update_datafeed": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", - "description": "Updates certain properties of a datafeed." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed", + "description": "Update a datafeed" }, "stability": "stable", "visibility": "public", @@ -31,19 +31,23 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Ignore unavailable indexes (default: false)" }, "allow_no_indices": { "type": "boolean", + "default": true, "description": "Ignore if the source indices expressions resolves to no concrete indices (default: true)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Ignore indices that are marked as throttled (default: true)" }, "expand_wildcards": { "type": "enum", "options": ["open", "closed", "hidden", "none", "all"], + "default": "open", "description": "Whether source index expressions should get expanded to open or closed indices (default: open)" } } diff --git a/specification/_json_spec/ml.update_filter.json b/specification/_json_spec/ml.update_filter.json index e10a40a4dd..3948631c90 100644 --- a/specification/_json_spec/ml.update_filter.json +++ b/specification/_json_spec/ml.update_filter.json @@ -1,8 +1,8 @@ { "ml.update_filter": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", - "description": "Updates the description of a filter, adds items, or removes items." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter", + "description": "Update a filter" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.update_job.json b/specification/_json_spec/ml.update_job.json index 9c3ef55e60..100d7aacc3 100644 --- a/specification/_json_spec/ml.update_job.json +++ b/specification/_json_spec/ml.update_job.json @@ -1,8 +1,8 @@ { "ml.update_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", - "description": "Updates certain properties of an anomaly detection job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job", + "description": "Update an anomaly detection job" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/ml.update_model_snapshot.json b/specification/_json_spec/ml.update_model_snapshot.json index 6c3b62f25e..3244baf054 100644 --- a/specification/_json_spec/ml.update_model_snapshot.json +++ b/specification/_json_spec/ml.update_model_snapshot.json @@ -1,8 +1,8 @@ { "ml.update_model_snapshot": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", - "description": "Updates certain properties of a snapshot." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-model-snapshot", + "description": "Update a snapshot" }, "stability": "stable", "visibility": "public", @@ -28,7 +28,6 @@ } ] }, - "params": {}, "body": { "description": "The model snapshot properties to update", "required": true diff --git a/specification/_json_spec/ml.update_trained_model_deployment.json b/specification/_json_spec/ml.update_trained_model_deployment.json index 3fa5c31a0f..ddc41f2c77 100644 --- a/specification/_json_spec/ml.update_trained_model_deployment.json +++ b/specification/_json_spec/ml.update_trained_model_deployment.json @@ -1,8 +1,8 @@ { "ml.update_trained_model_deployment": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", - "description": "Updates certain properties of trained model deployment." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment", + "description": "Update a trained model deployment" }, "stability": "stable", "visibility": "public", @@ -27,7 +27,7 @@ "params": { "number_of_allocations": { "type": "int", - "required": false, + "default": 1, "description": "Update the model deployment to this number of allocations." } }, diff --git a/specification/_json_spec/ml.upgrade_job_snapshot.json b/specification/_json_spec/ml.upgrade_job_snapshot.json index b00fc02d90..141af75e3d 100644 --- a/specification/_json_spec/ml.upgrade_job_snapshot.json +++ b/specification/_json_spec/ml.upgrade_job_snapshot.json @@ -1,8 +1,8 @@ { "ml.upgrade_job_snapshot": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", - "description": "Upgrades a given job snapshot to the current major version." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-upgrade-job-snapshot", + "description": "Upgrade a snapshot" }, "stability": "stable", "visibility": "public", @@ -30,12 +30,12 @@ "params": { "timeout": { "type": "time", - "required": false, + "default": "30m", "description": "How long should the API wait for the job to be opened and the old snapshot to be loaded." }, "wait_for_completion": { "type": "boolean", - "required": false, + "default": false, "description": "Should the request wait until the task is complete before responding to the caller. Default is false." } } diff --git a/specification/_json_spec/ml.validate.json b/specification/_json_spec/ml.validate.json index b70c729627..8509daf94f 100644 --- a/specification/_json_spec/ml.validate.json +++ b/specification/_json_spec/ml.validate.json @@ -2,7 +2,7 @@ "ml.validate": { "documentation": { "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", - "description": "Validates an anomaly detection job." + "description": "Validate an anomaly detection job" }, "stability": "stable", "visibility": "private", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The job config", "required": true diff --git a/specification/_json_spec/ml.validate_detector.json b/specification/_json_spec/ml.validate_detector.json index 85a301cd9a..31983b3a80 100644 --- a/specification/_json_spec/ml.validate_detector.json +++ b/specification/_json_spec/ml.validate_detector.json @@ -2,7 +2,7 @@ "ml.validate_detector": { "documentation": { "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", - "description": "Validates an anomaly detection detector." + "description": "Validate an anomaly detection job" }, "stability": "stable", "visibility": "private", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The detector", "required": true diff --git a/specification/_json_spec/monitoring.bulk.json b/specification/_json_spec/monitoring.bulk.json index f58c1629d3..9eb9fbc49f 100644 --- a/specification/_json_spec/monitoring.bulk.json +++ b/specification/_json_spec/monitoring.bulk.json @@ -1,8 +1,8 @@ { "monitoring.bulk": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", - "description": "Used by the monitoring features to send monitoring data." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch", + "description": "Send monitoring data" }, "stability": "stable", "visibility": "private", diff --git a/specification/_json_spec/msearch.json b/specification/_json_spec/msearch.json index e083dabb31..a18360b843 100644 --- a/specification/_json_spec/msearch.json +++ b/specification/_json_spec/msearch.json @@ -1,8 +1,8 @@ { "msearch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", - "description": "Allows to execute several search operations in one request." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch", + "description": "Run multiple searches" }, "stability": "stable", "visibility": "public", @@ -35,7 +35,7 @@ "description": "Search operation type" }, "max_concurrent_searches": { - "type": "number", + "type": "int", "description": "Controls the maximum number of concurrent searches the multi search api will execute" }, "typed_keys": { @@ -43,11 +43,11 @@ "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "pre_filter_shard_size": { - "type": "number", - "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint." + "type": "long", + "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint." }, "max_concurrent_shard_requests": { - "type": "number", + "type": "int", "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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 }, @@ -59,7 +59,45 @@ "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", - "default": "true" + "default": true + }, + "index": { + "type": "list", + "description": "A comma-separated list of index names to use as default" + }, + "ignore_unavailable": { + "type": "boolean", + "default": false, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" + }, + "ignore_throttled": { + "type": "boolean", + "deprecated": true, + "default": false, + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" + }, + "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)" + }, + "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." + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." + }, + "routing": { + "type": "list", + "description": "A comma-separated list of specific routing values" + }, + "include_named_queries_score": { + "type": "boolean", + "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)", + "default": false } }, "body": { diff --git a/specification/_json_spec/msearch_template.json b/specification/_json_spec/msearch_template.json index f52dc75645..18133d29b3 100644 --- a/specification/_json_spec/msearch_template.json +++ b/specification/_json_spec/msearch_template.json @@ -1,8 +1,8 @@ { "msearch_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", - "description": "Allows to execute several search template operations in one request." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template", + "description": "Run multiple templated searches" }, "stability": "stable", "visibility": "public", @@ -36,10 +36,11 @@ }, "typed_keys": { "type": "boolean", + "default": false, "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "max_concurrent_searches": { - "type": "number", + "type": "long", "description": "Controls the maximum number of concurrent searches the multi search api will execute" }, "rest_total_hits_as_int": { @@ -50,7 +51,11 @@ "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", - "default": "true" + "default": true + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." } }, "body": { diff --git a/specification/_json_spec/mtermvectors.json b/specification/_json_spec/mtermvectors.json index cda196e438..cd0654c3b4 100644 --- a/specification/_json_spec/mtermvectors.json +++ b/specification/_json_spec/mtermvectors.json @@ -1,8 +1,8 @@ { "mtermvectors": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", - "description": "Returns multiple termvectors in one request." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors", + "description": "Get multiple term vectors" }, "stability": "stable", "visibility": "public", @@ -72,10 +72,11 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specifies if requests are real-time as opposed to near-real-time (default: true)." }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/nodes.clear_repositories_metering_archive.json b/specification/_json_spec/nodes.clear_repositories_metering_archive.json index 1bc51fe08b..d135914f91 100644 --- a/specification/_json_spec/nodes.clear_repositories_metering_archive.json +++ b/specification/_json_spec/nodes.clear_repositories_metering_archive.json @@ -1,8 +1,8 @@ { "nodes.clear_repositories_metering_archive": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", - "description": "Removes the archived repositories metering information present in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive", + "description": "Clear the archived repositories metering" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/nodes.get_repositories_metering_info.json b/specification/_json_spec/nodes.get_repositories_metering_info.json index 7d393683d5..53fcde692e 100644 --- a/specification/_json_spec/nodes.get_repositories_metering_info.json +++ b/specification/_json_spec/nodes.get_repositories_metering_info.json @@ -1,8 +1,8 @@ { "nodes.get_repositories_metering_info": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", - "description": "Returns cluster repositories metering information." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-get-repositories-metering-info", + "description": "Get cluster repositories metering" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/nodes.hot_threads.json b/specification/_json_spec/nodes.hot_threads.json index d23e2f6d84..f998d43e79 100644 --- a/specification/_json_spec/nodes.hot_threads.json +++ b/specification/_json_spec/nodes.hot_threads.json @@ -1,8 +1,8 @@ { "nodes.hot_threads": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html", - "description": "Returns information about hot threads on each node in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-hot-threads", + "description": "Get the hot threads for nodes" }, "stability": "stable", "visibility": "public", @@ -30,23 +30,28 @@ "params": { "interval": { "type": "time", + "default": "500ms", "description": "The interval for the second sampling of threads" }, "snapshots": { - "type": "number", + "type": "long", + "default": 10, "description": "Number of samples of thread stacktrace (default: 10)" }, "threads": { - "type": "number", + "type": "long", + "default": 3, "description": "Specify the number of threads to provide information for (default: 3)" }, "ignore_idle_threads": { "type": "boolean", + "default": true, "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)" }, "type": { "type": "enum", "options": ["cpu", "wait", "block", "mem"], + "default": "cpu", "description": "The type to sample (default: cpu)" }, "sort": { @@ -56,6 +61,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/nodes.info.json b/specification/_json_spec/nodes.info.json index 4beefc22d5..5ddcbe79a5 100644 --- a/specification/_json_spec/nodes.info.json +++ b/specification/_json_spec/nodes.info.json @@ -1,8 +1,8 @@ { "nodes.info": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html", - "description": "Returns information about nodes in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info", + "description": "Get node information" }, "stability": "stable", "visibility": "public", @@ -82,10 +82,12 @@ "params": { "flat_settings": { "type": "boolean", + "default": false, "description": "Return settings in flat format (default: false)" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/nodes.reload_secure_settings.json b/specification/_json_spec/nodes.reload_secure_settings.json index 7672e914e7..9c11e4cd43 100644 --- a/specification/_json_spec/nodes.reload_secure_settings.json +++ b/specification/_json_spec/nodes.reload_secure_settings.json @@ -1,8 +1,8 @@ { "nodes.reload_secure_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", - "description": "Reloads secure settings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings", + "description": "Reload the keystore on nodes in the cluster" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/nodes.stats.json b/specification/_json_spec/nodes.stats.json index d4f30f6eda..25367ca8c9 100644 --- a/specification/_json_spec/nodes.stats.json +++ b/specification/_json_spec/nodes.stats.json @@ -1,8 +1,8 @@ { "nodes.stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html", - "description": "Returns statistical information about nodes in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats", + "description": "Get node statistics" }, "stability": "stable", "visibility": "public", @@ -208,6 +208,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "include_segment_file_sizes": { diff --git a/specification/_json_spec/nodes.usage.json b/specification/_json_spec/nodes.usage.json index efde672979..f749aab32a 100644 --- a/specification/_json_spec/nodes.usage.json +++ b/specification/_json_spec/nodes.usage.json @@ -1,8 +1,8 @@ { "nodes.usage": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html", - "description": "Returns low-level information about REST actions usage on nodes." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage", + "description": "Get feature usage information" }, "stability": "stable", "visibility": "public", @@ -56,6 +56,7 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/open_point_in_time.json b/specification/_json_spec/open_point_in_time.json index 3870c1f95f..a3b93615a9 100644 --- a/specification/_json_spec/open_point_in_time.json +++ b/specification/_json_spec/open_point_in_time.json @@ -1,8 +1,8 @@ { "open_point_in_time": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html", - "description": "Open a point in time that can be used in subsequent searches" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", + "description": "Open a point in time" }, "stability": "stable", "visibility": "public", @@ -35,6 +35,7 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "expand_wildcards": { @@ -50,11 +51,22 @@ }, "allow_partial_search_results": { "type": "boolean", + "default": false, "description": "Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false)" + }, + "max_concurrent_shard_requests": { + "type": "int", + "description": "The number of concurrent shard requests per node executed concurrently when opening this point-in-time. This value should be used to limit the impact of opening the point-in-time on the cluster", + "default": 5 + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." } }, "body": { - "description": "An index_filter specified with the Query DSL" + "description": "An index_filter specified with the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/ping.json b/specification/_json_spec/ping.json index 6f876c3c22..57a6898080 100644 --- a/specification/_json_spec/ping.json +++ b/specification/_json_spec/ping.json @@ -1,8 +1,8 @@ { "ping": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", - "description": "Returns whether the cluster is running." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster", + "description": "Ping the cluster" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["HEAD"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/profiling.flamegraph.json b/specification/_json_spec/profiling.flamegraph.json index 4213503fdc..5a5b0c38cc 100644 --- a/specification/_json_spec/profiling.flamegraph.json +++ b/specification/_json_spec/profiling.flamegraph.json @@ -2,7 +2,7 @@ "profiling.flamegraph": { "documentation": { "url": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", - "description": "Extracts a UI-optimized structure to render flamegraphs from Universal Profiling." + "description": "Extracts a UI-optimized structure to render flamegraphs from Universal Profiling" }, "stability": "stable", "visibility": "private", diff --git a/specification/_json_spec/profiling.stacktraces.json b/specification/_json_spec/profiling.stacktraces.json index 4a7c887d7f..16f90cea83 100644 --- a/specification/_json_spec/profiling.stacktraces.json +++ b/specification/_json_spec/profiling.stacktraces.json @@ -2,7 +2,7 @@ "profiling.stacktraces": { "documentation": { "url": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", - "description": "Extracts raw stacktrace information from Universal Profiling." + "description": "Extracts raw stacktrace information from Universal Profiling" }, "stability": "stable", "visibility": "private", diff --git a/specification/_json_spec/profiling.status.json b/specification/_json_spec/profiling.status.json index ae6f81847b..68a76d9cfd 100644 --- a/specification/_json_spec/profiling.status.json +++ b/specification/_json_spec/profiling.status.json @@ -2,7 +2,7 @@ "profiling.status": { "documentation": { "url": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", - "description": "Returns basic information about the status of Universal Profiling." + "description": "Returns basic information about the status of Universal Profiling" }, "stability": "stable", "visibility": "private", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { diff --git a/specification/_json_spec/profiling.topn_functions.json b/specification/_json_spec/profiling.topn_functions.json index 8571b64796..97fc478a94 100644 --- a/specification/_json_spec/profiling.topn_functions.json +++ b/specification/_json_spec/profiling.topn_functions.json @@ -2,7 +2,7 @@ "profiling.topn_functions": { "documentation": { "url": "https://www.elastic.co/guide/en/observability/current/universal-profiling.html", - "description": "Extracts a list of topN functions from Universal Profiling." + "description": "Extracts a list of topN functions from Universal Profiling" }, "stability": "stable", "visibility": "private", diff --git a/specification/_json_spec/project.tags.json b/specification/_json_spec/project.tags.json new file mode 100644 index 0000000000..5647ab285a --- /dev/null +++ b/specification/_json_spec/project.tags.json @@ -0,0 +1,21 @@ +{ + "project.tags": { + "documentation": { + "url": null, + "description": "Return tags defined for the project" + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_project/tags", + "methods": ["GET"] + } + ] + } + } +} diff --git a/specification/_json_spec/put_script.json b/specification/_json_spec/put_script.json index 13a366565c..469a4d809b 100644 --- a/specification/_json_spec/put_script.json +++ b/specification/_json_spec/put_script.json @@ -1,8 +1,8 @@ { "put_script": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", - "description": "Creates or updates a script." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script", + "description": "Create or update a script or search template" }, "stability": "stable", "visibility": "public", @@ -41,10 +41,12 @@ "params": { "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" }, "context": { diff --git a/specification/_json_spec/query_rules.delete_rule.json b/specification/_json_spec/query_rules.delete_rule.json index 65cd9b6d86..d0663308df 100644 --- a/specification/_json_spec/query_rules.delete_rule.json +++ b/specification/_json_spec/query_rules.delete_rule.json @@ -1,8 +1,8 @@ { "query_rules.delete_rule": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html", - "description": "Deletes an individual query rule within a ruleset." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-rule", + "description": "Delete a query rule" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/query_rules.delete_ruleset.json b/specification/_json_spec/query_rules.delete_ruleset.json index 150ceb1447..bbda75f6b0 100644 --- a/specification/_json_spec/query_rules.delete_ruleset.json +++ b/specification/_json_spec/query_rules.delete_ruleset.json @@ -1,8 +1,8 @@ { "query_rules.delete_ruleset": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html", - "description": "Deletes a query ruleset." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-ruleset", + "description": "Delete a query ruleset" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/query_rules.get_rule.json b/specification/_json_spec/query_rules.get_rule.json index f88b3c221c..4d09f0c9cb 100644 --- a/specification/_json_spec/query_rules.get_rule.json +++ b/specification/_json_spec/query_rules.get_rule.json @@ -1,8 +1,8 @@ { "query_rules.get_rule": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html", - "description": "Returns the details about an individual query rule within a ruleset." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule", + "description": "Get a query rule" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/query_rules.get_ruleset.json b/specification/_json_spec/query_rules.get_ruleset.json index 10d57f4880..8d1dce9ff6 100644 --- a/specification/_json_spec/query_rules.get_ruleset.json +++ b/specification/_json_spec/query_rules.get_ruleset.json @@ -1,8 +1,8 @@ { "query_rules.get_ruleset": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html", - "description": "Returns the details about a query ruleset." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset", + "description": "Get a query ruleset" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/query_rules.list_rulesets.json b/specification/_json_spec/query_rules.list_rulesets.json index feb8cb2b3a..74f45b68b5 100644 --- a/specification/_json_spec/query_rules.list_rulesets.json +++ b/specification/_json_spec/query_rules.list_rulesets.json @@ -1,8 +1,8 @@ { "query_rules.list_rulesets": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html", - "description": "Lists query rulesets." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets", + "description": "Get all query rulesets" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/query_rules.put_rule.json b/specification/_json_spec/query_rules.put_rule.json index 8cba1b6e8f..977093ed52 100644 --- a/specification/_json_spec/query_rules.put_rule.json +++ b/specification/_json_spec/query_rules.put_rule.json @@ -1,8 +1,8 @@ { "query_rules.put_rule": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html", - "description": "Creates or updates a query rule within a ruleset." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-rule", + "description": "Create or update a query rule" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/query_rules.put_ruleset.json b/specification/_json_spec/query_rules.put_ruleset.json index 4c069067de..63841dabce 100644 --- a/specification/_json_spec/query_rules.put_ruleset.json +++ b/specification/_json_spec/query_rules.put_ruleset.json @@ -1,8 +1,8 @@ { "query_rules.put_ruleset": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html", - "description": "Creates or updates a query ruleset." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset", + "description": "Create or update a query ruleset" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/query_rules.test.json b/specification/_json_spec/query_rules.test.json index 43167c765b..0bc10d8b94 100644 --- a/specification/_json_spec/query_rules.test.json +++ b/specification/_json_spec/query_rules.test.json @@ -1,10 +1,10 @@ { "query_rules.test": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html", - "description": "Tests a query ruleset to identify the rules that would match input criteria" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test", + "description": "Test a query ruleset" }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/rank_eval.json b/specification/_json_spec/rank_eval.json index 801d72a4ec..56c912f562 100644 --- a/specification/_json_spec/rank_eval.json +++ b/specification/_json_spec/rank_eval.json @@ -1,8 +1,8 @@ { "rank_eval": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval", + "description": "Evaluate ranked search results" }, "stability": "stable", "visibility": "public", @@ -31,10 +31,12 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { diff --git a/specification/_json_spec/reindex.json b/specification/_json_spec/reindex.json index 097d1e9c04..655002dc37 100644 --- a/specification/_json_spec/reindex.json +++ b/specification/_json_spec/reindex.json @@ -1,8 +1,8 @@ { "reindex": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", - "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex", + "description": "Reindex documents" }, "stability": "stable", "visibility": "public", @@ -21,6 +21,7 @@ "params": { "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -30,6 +31,7 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the reindex 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)" }, "wait_for_completion": { @@ -39,7 +41,7 @@ }, "requests_per_second": { "type": "number", - "default": 0, + "default": -1, "description": "The throttle to set on this request in sub-requests per second. -1 means no throttle." }, "scroll": { @@ -53,8 +55,13 @@ "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." }, "max_docs": { - "type": "number", + "type": "int", "description": "Maximum number of documents to process (default: all documents)" + }, + "require_alias": { + "type": "boolean", + "default": false, + "description": "When true, requires destination to be an alias." } }, "body": { diff --git a/specification/_json_spec/reindex_rethrottle.json b/specification/_json_spec/reindex_rethrottle.json index 556011d8e5..0bcb0446d4 100644 --- a/specification/_json_spec/reindex_rethrottle.json +++ b/specification/_json_spec/reindex_rethrottle.json @@ -1,8 +1,8 @@ { "reindex_rethrottle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", - "description": "Changes the number of requests per second for a particular Reindex operation." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex", + "description": "Throttle a reindex operation" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/render_search_template.json b/specification/_json_spec/render_search_template.json index c8f3918a9b..6db006051e 100644 --- a/specification/_json_spec/render_search_template.json +++ b/specification/_json_spec/render_search_template.json @@ -1,8 +1,8 @@ { "render_search_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", - "description": "Allows to use the Mustache language to pre-render a search definition." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template", + "description": "Render a search template" }, "stability": "stable", "visibility": "public", @@ -29,7 +29,8 @@ ] }, "body": { - "description": "The search definition template and its params" + "description": "The search definition template and its params", + "required": true } } } diff --git a/specification/_json_spec/rollup.delete_job.json b/specification/_json_spec/rollup.delete_job.json index 315a427089..24d6f83363 100644 --- a/specification/_json_spec/rollup.delete_job.json +++ b/specification/_json_spec/rollup.delete_job.json @@ -1,8 +1,8 @@ { "rollup.delete_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", - "description": "Deletes an existing rollup job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-delete-job", + "description": "Delete a rollup job" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/rollup.get_jobs.json b/specification/_json_spec/rollup.get_jobs.json index d15e12cae0..3629fd7c4b 100644 --- a/specification/_json_spec/rollup.get_jobs.json +++ b/specification/_json_spec/rollup.get_jobs.json @@ -1,8 +1,8 @@ { "rollup.get_jobs": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", - "description": "Retrieves the configuration, stats, and status of rollup jobs." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-jobs", + "description": "Get rollup job information" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/rollup.get_rollup_caps.json b/specification/_json_spec/rollup.get_rollup_caps.json index 04ea752e65..274e473113 100644 --- a/specification/_json_spec/rollup.get_rollup_caps.json +++ b/specification/_json_spec/rollup.get_rollup_caps.json @@ -1,8 +1,8 @@ { "rollup.get_rollup_caps": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", - "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-caps", + "description": "Get the rollup job capabilities" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/rollup.get_rollup_index_caps.json b/specification/_json_spec/rollup.get_rollup_index_caps.json index d2adc00eaa..1439b2f9db 100644 --- a/specification/_json_spec/rollup.get_rollup_index_caps.json +++ b/specification/_json_spec/rollup.get_rollup_index_caps.json @@ -1,8 +1,8 @@ { "rollup.get_rollup_index_caps": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", - "description": "Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored)." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps", + "description": "Get the rollup index capabilities" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/rollup.put_job.json b/specification/_json_spec/rollup.put_job.json index 5058513990..535b657d54 100644 --- a/specification/_json_spec/rollup.put_job.json +++ b/specification/_json_spec/rollup.put_job.json @@ -1,8 +1,8 @@ { "rollup.put_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", - "description": "Creates a rollup job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-put-job", + "description": "Create a rollup job" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/rollup.rollup_search.json b/specification/_json_spec/rollup.rollup_search.json index 54355c3d01..4f63574097 100644 --- a/specification/_json_spec/rollup.rollup_search.json +++ b/specification/_json_spec/rollup.rollup_search.json @@ -1,8 +1,8 @@ { "rollup.rollup_search": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", - "description": "Enables searching rolled-up data using the standard query DSL." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-rollup-search", + "description": "Search rolled-up data" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/rollup.start_job.json b/specification/_json_spec/rollup.start_job.json index 35d8af4376..168d4dbb03 100644 --- a/specification/_json_spec/rollup.start_job.json +++ b/specification/_json_spec/rollup.start_job.json @@ -1,8 +1,8 @@ { "rollup.start_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", - "description": "Starts an existing, stopped rollup job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-start-job", + "description": "Start rollup jobs" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/rollup.stop_job.json b/specification/_json_spec/rollup.stop_job.json index 59d161bafe..6ac3e019b3 100644 --- a/specification/_json_spec/rollup.stop_job.json +++ b/specification/_json_spec/rollup.stop_job.json @@ -1,8 +1,8 @@ { "rollup.stop_job": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", - "description": "Stops an existing, started rollup job." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-stop-job", + "description": "Stop rollup jobs" }, "stability": "experimental", "visibility": "public", @@ -26,12 +26,12 @@ "params": { "wait_for_completion": { "type": "boolean", - "required": false, + "default": false, "description": "True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false." }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s." } } diff --git a/specification/_json_spec/scripts_painless_execute.json b/specification/_json_spec/scripts_painless_execute.json index e59fdfd450..da2a661f57 100644 --- a/specification/_json_spec/scripts_painless_execute.json +++ b/specification/_json_spec/scripts_painless_execute.json @@ -1,8 +1,8 @@ { "scripts_painless_execute": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", - "description": "Allows an arbitrary script to be executed and a result to be returned" + "url": "https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples", + "description": "Run a script" }, "stability": "experimental", "visibility": "public", @@ -18,9 +18,9 @@ } ] }, - "params": {}, "body": { - "description": "The script to execute" + "description": "The script to execute", + "required": true } } } diff --git a/specification/_json_spec/scroll.json b/specification/_json_spec/scroll.json index f136ac8dca..177901e371 100644 --- a/specification/_json_spec/scroll.json +++ b/specification/_json_spec/scroll.json @@ -1,8 +1,8 @@ { "scroll": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", - "description": "Allows to retrieve a large numbers of results from a single search request." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll", + "description": "Run a scrolling search" }, "stability": "stable", "visibility": "public", @@ -36,6 +36,7 @@ "params": { "scroll": { "type": "time", + "default": "1d", "description": "Specify how long a consistent view of the index should be maintained for scrolled search" }, "scroll_id": { @@ -49,7 +50,8 @@ } }, "body": { - "description": "The scroll ID if not passed by URL or query parameter." + "description": "The scroll ID if not passed by URL or query parameter.", + "required": false } } } diff --git a/specification/_json_spec/search.json b/specification/_json_spec/search.json index 42125fa044..89985d7dd3 100644 --- a/specification/_json_spec/search.json +++ b/specification/_json_spec/search.json @@ -1,8 +1,8 @@ { "search": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", - "description": "Returns results matching a query." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search", + "description": "Run a search" }, "stability": "stable", "visibility": "public", @@ -35,17 +35,18 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", - "default": "true" + "default": true }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -54,6 +55,7 @@ }, "explain": { "type": "boolean", + "default": false, "description": "Specify whether to return detailed information about score computation as part of a hit" }, "stored_fields": { @@ -65,7 +67,8 @@ "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit" }, "from": { - "type": "number", + "type": "int", + "default": 0, "description": "Starting offset (default: 0)" }, "force_synthetic_source": { @@ -76,14 +79,17 @@ }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -94,12 +100,17 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "preference": { "type": "string", "description": "Specify the node or shard the operation should be performed on (default: random)" }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." + }, "q": { "type": "string", "description": "Query in the Lucene query string syntax" @@ -118,7 +129,8 @@ "description": "Search operation type" }, "size": { - "type": "number", + "type": "int", + "default": 10, "description": "Number of hits to return (default: 10)" }, "sort": { @@ -127,6 +139,7 @@ }, "_source": { "type": "list", + "default": "true", "description": "True or false to return the _source field or not, or a list of fields to return" }, "_source_excludes": { @@ -137,8 +150,14 @@ "type": "list", "description": "A list of fields to extract and return from the _source field" }, + "_source_exclude_vectors": { + "type": "boolean", + "default": false, + "description": "Whether vectors should be excluded from _source" + }, "terminate_after": { - "type": "number", + "type": "long", + "default": 0, "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." }, "stats": { @@ -156,7 +175,7 @@ "description": "Specify suggest mode" }, "suggest_size": { - "type": "number", + "type": "long", "description": "How many suggestions to return in response" }, "suggest_text": { @@ -169,10 +188,12 @@ }, "track_scores": { "type": "boolean", + "default": false, "description": "Whether to calculate and return scores even if they are not used for sorting" }, "track_total_hits": { "type": "boolean|long", + "default": "10000", "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number." }, "allow_partial_search_results": { @@ -182,10 +203,12 @@ }, "typed_keys": { "type": "boolean", + "default": false, "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "version": { "type": "boolean", + "default": false, "description": "Specify whether to return document version as part of a hit" }, "seq_no_primary_term": { @@ -197,18 +220,18 @@ "description": "Specify if request cache should be used for this request or not, defaults to index level setting" }, "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 a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "default": 512 }, "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 }, "pre_filter_shard_size": { - "type": "number", - "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint." + "type": "long", + "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint." }, "rest_total_hits_as_int": { "type": "boolean", @@ -222,7 +245,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/search_application.delete.json b/specification/_json_spec/search_application.delete.json index 352611e2dc..8e8b90c598 100644 --- a/specification/_json_spec/search_application.delete.json +++ b/specification/_json_spec/search_application.delete.json @@ -1,10 +1,10 @@ { "search_application.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", - "description": "Deletes a search application." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete", + "description": "Delete a search application" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/search_application.delete_behavioral_analytics.json b/specification/_json_spec/search_application.delete_behavioral_analytics.json index fbc8f1fd62..180da5ab5a 100644 --- a/specification/_json_spec/search_application.delete_behavioral_analytics.json +++ b/specification/_json_spec/search_application.delete_behavioral_analytics.json @@ -1,8 +1,8 @@ { "search_application.delete_behavioral_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", - "description": "Delete a behavioral analytics collection." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics", + "description": "Delete a behavioral analytics collection" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/search_application.get.json b/specification/_json_spec/search_application.get.json index a2e4d2bddb..fd29bc9051 100644 --- a/specification/_json_spec/search_application.get.json +++ b/specification/_json_spec/search_application.get.json @@ -1,10 +1,10 @@ { "search_application.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", - "description": "Returns the details about a search application." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get", + "description": "Get search application details" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] diff --git a/specification/_json_spec/search_application.get_behavioral_analytics.json b/specification/_json_spec/search_application.get_behavioral_analytics.json index 80d88dba4f..0647925df7 100644 --- a/specification/_json_spec/search_application.get_behavioral_analytics.json +++ b/specification/_json_spec/search_application.get_behavioral_analytics.json @@ -1,8 +1,8 @@ { "search_application.get_behavioral_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", - "description": "Returns the existing behavioral analytics collections." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics", + "description": "Get behavioral analytics collections" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/search_application.list.json b/specification/_json_spec/search_application.list.json index 348c0a4b08..69a89807fc 100644 --- a/specification/_json_spec/search_application.list.json +++ b/specification/_json_spec/search_application.list.json @@ -1,10 +1,10 @@ { "search_application.list": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html", - "description": "Returns the existing search applications." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics", + "description": "Get search applications" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"] @@ -24,6 +24,7 @@ }, "from": { "type": "int", + "default": 0, "description": "Starting offset (default: 0)" }, "size": { diff --git a/specification/_json_spec/search_application.post_behavioral_analytics_event.json b/specification/_json_spec/search_application.post_behavioral_analytics_event.json index 2de761b5f7..477bef30d8 100644 --- a/specification/_json_spec/search_application.post_behavioral_analytics_event.json +++ b/specification/_json_spec/search_application.post_behavioral_analytics_event.json @@ -1,8 +1,8 @@ { "search_application.post_behavioral_analytics_event": { "documentation": { - "url": "http://todo.com/tbd", - "description": "Creates a behavioral analytics event for existing collection." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event", + "description": "Create a behavioral analytics collection event" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/search_application.put.json b/specification/_json_spec/search_application.put.json index 8e93526b86..88eae1747e 100644 --- a/specification/_json_spec/search_application.put.json +++ b/specification/_json_spec/search_application.put.json @@ -1,10 +1,10 @@ { "search_application.put": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", - "description": "Creates or updates a search application." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put", + "description": "Create or update a search application" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], @@ -27,6 +27,7 @@ "params": { "create": { "type": "boolean", + "default": false, "description": "If true, requires that a search application with the specified resource_id does not already exist. (default: false)" } }, diff --git a/specification/_json_spec/search_application.put_behavioral_analytics.json b/specification/_json_spec/search_application.put_behavioral_analytics.json index 90b5c11c74..819efd72a2 100644 --- a/specification/_json_spec/search_application.put_behavioral_analytics.json +++ b/specification/_json_spec/search_application.put_behavioral_analytics.json @@ -1,8 +1,8 @@ { "search_application.put_behavioral_analytics": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", - "description": "Creates a behavioral analytics collection." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics", + "description": "Create a behavioral analytics collection" }, "stability": "experimental", "deprecated": { diff --git a/specification/_json_spec/search_application.render_query.json b/specification/_json_spec/search_application.render_query.json index 2e61c36afa..6950ebb8e6 100644 --- a/specification/_json_spec/search_application.render_query.json +++ b/specification/_json_spec/search_application.render_query.json @@ -1,8 +1,8 @@ { "search_application.render_query": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-render-query.html", - "description": "Renders a query for given search application search parameters" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-render-query", + "description": "Render a search application query" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/search_application.search.json b/specification/_json_spec/search_application.search.json index 07709bf8e1..8464c3a8a5 100644 --- a/specification/_json_spec/search_application.search.json +++ b/specification/_json_spec/search_application.search.json @@ -1,10 +1,10 @@ { "search_application.search": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", - "description": "Perform a search against a search application" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search", + "description": "Run a search application search" }, - "stability": "experimental", + "stability": "beta", "visibility": "public", "headers": { "accept": ["application/json"], diff --git a/specification/_json_spec/search_mvt.json b/specification/_json_spec/search_mvt.json index 9dc7676d73..8703762ba1 100644 --- a/specification/_json_spec/search_mvt.json +++ b/specification/_json_spec/search_mvt.json @@ -1,10 +1,10 @@ { "search_mvt": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", - "description": "Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt", + "description": "Search a vector tile" }, - "stability": "experimental", + "stability": "stable", "visibility": "public", "headers": { "accept": ["application/vnd.mapbox-vector-tile"], @@ -62,6 +62,16 @@ "description": "Determines the geometry type for features in the aggs layer.", "default": "grid" }, + "grid_agg": { + "type": "enum", + "options": ["geotile", "geohex"], + "description": "Aggregation used to create a grid for `field`.", + "default": "geotile" + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." + }, "size": { "type": "int", "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.", @@ -69,6 +79,7 @@ }, "track_total_hits": { "type": "boolean|long", + "default": "10000", "description": "Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number." }, "with_labels": { diff --git a/specification/_json_spec/search_shards.json b/specification/_json_spec/search_shards.json index 1aa0f93b30..5ad4ed3b5d 100644 --- a/specification/_json_spec/search_shards.json +++ b/specification/_json_spec/search_shards.json @@ -1,8 +1,8 @@ { "search_shards": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", - "description": "Returns information about the indices and shards that a search request would be executed against." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards", + "description": "Get the search shards" }, "stability": "stable", "visibility": "public", @@ -38,14 +38,17 @@ }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": false, "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)" }, "expand_wildcards": { @@ -56,6 +59,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } } diff --git a/specification/_json_spec/search_template.json b/specification/_json_spec/search_template.json index 8c67065435..6730e75548 100644 --- a/specification/_json_spec/search_template.json +++ b/specification/_json_spec/search_template.json @@ -1,8 +1,8 @@ { "search_template": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", - "description": "Allows to use the Mustache language to pre-render a search definition." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template", + "description": "Run a search with a search template" }, "stability": "stable", "visibility": "public", @@ -31,14 +31,17 @@ "params": { "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "ignore_throttled": { "type": "boolean", + "default": true, "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "expand_wildcards": { @@ -66,14 +69,17 @@ }, "explain": { "type": "boolean", + "default": false, "description": "Specify whether to return detailed information about score computation as part of a hit" }, "profile": { "type": "boolean", + "default": false, "description": "Specify whether to profile the query execution" }, "typed_keys": { "type": "boolean", + "default": false, "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response" }, "rest_total_hits_as_int": { @@ -84,7 +90,11 @@ "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", - "default": "true" + "default": true + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." } }, "body": { diff --git a/specification/_json_spec/searchable_snapshots.cache_stats.json b/specification/_json_spec/searchable_snapshots.cache_stats.json index bca42a6bad..016b650ba4 100644 --- a/specification/_json_spec/searchable_snapshots.cache_stats.json +++ b/specification/_json_spec/searchable_snapshots.cache_stats.json @@ -1,8 +1,8 @@ { "searchable_snapshots.cache_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", - "description": "Retrieve node-level cache statistics about searchable snapshots." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats", + "description": "Get cache statistics" }, "stability": "experimental", "visibility": "public", diff --git a/specification/_json_spec/searchable_snapshots.clear_cache.json b/specification/_json_spec/searchable_snapshots.clear_cache.json index 311bd1b829..6c644a27cf 100644 --- a/specification/_json_spec/searchable_snapshots.clear_cache.json +++ b/specification/_json_spec/searchable_snapshots.clear_cache.json @@ -1,7 +1,7 @@ { "searchable_snapshots.clear_cache": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache", "description": "Clear the cache of searchable snapshots." }, "stability": "experimental", @@ -21,7 +21,7 @@ "parts": { "index": { "type": "list", - "description": "A comma-separated list of index names" + "description": "Clear the cache" } } } @@ -38,13 +38,9 @@ }, "expand_wildcards": { "type": "enum", - "options": ["open", "closed", "none", "all"], + "options": ["open", "closed", "hidden", "none", "all"], "default": "open", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both." - }, - "index": { - "type": "list", - "description": "A comma-separated list of index name to limit the operation" } } } diff --git a/specification/_json_spec/searchable_snapshots.mount.json b/specification/_json_spec/searchable_snapshots.mount.json index 73cb77b0fa..1a0aca4bd1 100644 --- a/specification/_json_spec/searchable_snapshots.mount.json +++ b/specification/_json_spec/searchable_snapshots.mount.json @@ -1,8 +1,8 @@ { "searchable_snapshots.mount": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html", - "description": "Mount a snapshot as a searchable index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount", + "description": "Mount a snapshot" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "wait_for_completion": { @@ -41,7 +42,7 @@ "storage": { "type": "string", "description": "Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`", - "default": false + "default": "full_copy" } }, "body": { diff --git a/specification/_json_spec/searchable_snapshots.stats.json b/specification/_json_spec/searchable_snapshots.stats.json index 49ca284199..59e1ea1fef 100644 --- a/specification/_json_spec/searchable_snapshots.stats.json +++ b/specification/_json_spec/searchable_snapshots.stats.json @@ -1,8 +1,8 @@ { "searchable_snapshots.stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", - "description": "Retrieve shard-level statistics about searchable snapshots." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-stats", + "description": "Get searchable snapshot statistics" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.activate_user_profile.json b/specification/_json_spec/security.activate_user_profile.json index 2e5a61a234..b9a6bc2023 100644 --- a/specification/_json_spec/security.activate_user_profile.json +++ b/specification/_json_spec/security.activate_user_profile.json @@ -1,11 +1,11 @@ { "security.activate_user_profile": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", - "description": "Creates or updates the user profile on behalf of another user." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-activate-user-profile", + "description": "Activate a user profile" }, "stability": "stable", - "visibility": "private", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/security.authenticate.json b/specification/_json_spec/security.authenticate.json index 2e5034eb19..0ddb4d539a 100644 --- a/specification/_json_spec/security.authenticate.json +++ b/specification/_json_spec/security.authenticate.json @@ -1,8 +1,8 @@ { "security.authenticate": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", - "description": "Enables authentication as a user and retrieve information about the authenticated user." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate", + "description": "Authenticate a user" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.bulk_delete_role.json b/specification/_json_spec/security.bulk_delete_role.json index ccd860dd0d..2aa0dc8f81 100644 --- a/specification/_json_spec/security.bulk_delete_role.json +++ b/specification/_json_spec/security.bulk_delete_role.json @@ -1,8 +1,8 @@ { "security.bulk_delete_role": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html", - "description": "Bulk delete roles in the native realm." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-delete-role", + "description": "Bulk delete roles" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.bulk_put_role.json b/specification/_json_spec/security.bulk_put_role.json index d3045955ef..abde2611b2 100644 --- a/specification/_json_spec/security.bulk_put_role.json +++ b/specification/_json_spec/security.bulk_put_role.json @@ -1,8 +1,8 @@ { "security.bulk_put_role": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html", - "description": "Bulk adds and updates roles in the native realm." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-put-role", + "description": "Bulk create or update roles" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.bulk_update_api_keys.json b/specification/_json_spec/security.bulk_update_api_keys.json index b489c138e9..00271afcd6 100644 --- a/specification/_json_spec/security.bulk_update_api_keys.json +++ b/specification/_json_spec/security.bulk_update_api_keys.json @@ -1,8 +1,8 @@ { "security.bulk_update_api_keys": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html", - "description": "Updates the attributes of multiple existing API keys." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-update-api-keys", + "description": "Bulk update API keys" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.change_password.json b/specification/_json_spec/security.change_password.json index c717538db2..816c498f4f 100644 --- a/specification/_json_spec/security.change_password.json +++ b/specification/_json_spec/security.change_password.json @@ -1,8 +1,8 @@ { "security.change_password": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", - "description": "Changes the passwords of users in the native realm and built-in users." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-change-password", + "description": "Change passwords" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.clear_api_key_cache.json b/specification/_json_spec/security.clear_api_key_cache.json index 773381cac9..31a5dea20b 100644 --- a/specification/_json_spec/security.clear_api_key_cache.json +++ b/specification/_json_spec/security.clear_api_key_cache.json @@ -1,8 +1,8 @@ { "security.clear_api_key_cache": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", - "description": "Clear a subset or all entries from the API key cache." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-api-key-cache", + "description": "Clear the API key cache" }, "stability": "stable", "visibility": "public", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.clear_cached_privileges.json b/specification/_json_spec/security.clear_cached_privileges.json index fc8a9e8b8a..24a24373bf 100644 --- a/specification/_json_spec/security.clear_cached_privileges.json +++ b/specification/_json_spec/security.clear_cached_privileges.json @@ -1,8 +1,8 @@ { "security.clear_cached_privileges": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", - "description": "Evicts application privileges from the native application privileges cache." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-privileges", + "description": "Clear the privileges cache" }, "stability": "stable", "visibility": "public", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.clear_cached_realms.json b/specification/_json_spec/security.clear_cached_realms.json index 3423a06c8a..98337763c4 100644 --- a/specification/_json_spec/security.clear_cached_realms.json +++ b/specification/_json_spec/security.clear_cached_realms.json @@ -1,8 +1,8 @@ { "security.clear_cached_realms": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", - "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-realms", + "description": "Clear the user cache" }, "stability": "stable", "visibility": "public", @@ -26,8 +26,7 @@ "params": { "usernames": { "type": "list", - "description": "Comma-separated list of usernames to clear from the cache", - "required": false + "description": "Comma-separated list of usernames to clear from the cache" } } } diff --git a/specification/_json_spec/security.clear_cached_roles.json b/specification/_json_spec/security.clear_cached_roles.json index b1cc6a3843..e272a55720 100644 --- a/specification/_json_spec/security.clear_cached_roles.json +++ b/specification/_json_spec/security.clear_cached_roles.json @@ -1,8 +1,8 @@ { "security.clear_cached_roles": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", - "description": "Evicts roles from the native role cache." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-roles", + "description": "Clear the roles cache" }, "stability": "stable", "visibility": "public", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.clear_cached_service_tokens.json b/specification/_json_spec/security.clear_cached_service_tokens.json index 5dfd13d621..f1c99e842b 100644 --- a/specification/_json_spec/security.clear_cached_service_tokens.json +++ b/specification/_json_spec/security.clear_cached_service_tokens.json @@ -1,8 +1,8 @@ { "security.clear_cached_service_tokens": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", - "description": "Evicts tokens from the service account token caches." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-service-tokens", + "description": "Clear service account token caches" }, "stability": "stable", "visibility": "public", @@ -30,7 +30,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.create_api_key.json b/specification/_json_spec/security.create_api_key.json index efcc4e92a8..2e53ffdfbf 100644 --- a/specification/_json_spec/security.create_api_key.json +++ b/specification/_json_spec/security.create_api_key.json @@ -1,8 +1,8 @@ { "security.create_api_key": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", - "description": "Creates an API key for access without requiring basic authentication." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key", + "description": "Create an API key" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.create_cross_cluster_api_key.json b/specification/_json_spec/security.create_cross_cluster_api_key.json index 0665a38446..4be79c09a8 100644 --- a/specification/_json_spec/security.create_cross_cluster_api_key.json +++ b/specification/_json_spec/security.create_cross_cluster_api_key.json @@ -1,8 +1,8 @@ { "security.create_cross_cluster_api_key": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", - "description": "Creates a cross-cluster API key for API key based remote cluster access." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key", + "description": "Create a cross-cluster API key" }, "stability": "stable", "visibility": "public", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The request to create a cross-cluster API key", "required": true diff --git a/specification/_json_spec/security.create_service_token.json b/specification/_json_spec/security.create_service_token.json index 3df72e92c1..8bbf8b726d 100644 --- a/specification/_json_spec/security.create_service_token.json +++ b/specification/_json_spec/security.create_service_token.json @@ -1,8 +1,8 @@ { "security.create_service_token": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", - "description": "Creates a service account token for access without requiring basic authentication." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token", + "description": "Create a service account token" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.delegate_pki.json b/specification/_json_spec/security.delegate_pki.json index 90d48dc826..1908994c0f 100644 --- a/specification/_json_spec/security.delegate_pki.json +++ b/specification/_json_spec/security.delegate_pki.json @@ -1,8 +1,8 @@ { "security.delegate_pki": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delegate-pki-authentication.html", - "description": "Delegate PKI authentication." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delegate-pki", + "description": "Delegate PKI authentication" }, "stability": "stable", "visibility": "public", @@ -17,7 +17,6 @@ } ] }, - "params": {}, "body": { "description": "The X509Certificate chain.", "required": true diff --git a/specification/_json_spec/security.delete_privileges.json b/specification/_json_spec/security.delete_privileges.json index e3c469d638..4c6e3d5da6 100644 --- a/specification/_json_spec/security.delete_privileges.json +++ b/specification/_json_spec/security.delete_privileges.json @@ -1,8 +1,8 @@ { "security.delete_privileges": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", - "description": "Removes application privileges." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-privileges", + "description": "Delete application privileges" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.delete_role.json b/specification/_json_spec/security.delete_role.json index 77c4c43634..70b972bbb3 100644 --- a/specification/_json_spec/security.delete_role.json +++ b/specification/_json_spec/security.delete_role.json @@ -1,8 +1,8 @@ { "security.delete_role": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", - "description": "Removes roles in the native realm." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role", + "description": "Delete roles" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.delete_role_mapping.json b/specification/_json_spec/security.delete_role_mapping.json index 137b709c54..614e802993 100644 --- a/specification/_json_spec/security.delete_role_mapping.json +++ b/specification/_json_spec/security.delete_role_mapping.json @@ -1,8 +1,8 @@ { "security.delete_role_mapping": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", - "description": "Removes role mappings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role-mapping", + "description": "Delete role mappings" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.delete_service_token.json b/specification/_json_spec/security.delete_service_token.json index f00f3e7450..1c961c7f22 100644 --- a/specification/_json_spec/security.delete_service_token.json +++ b/specification/_json_spec/security.delete_service_token.json @@ -1,8 +1,8 @@ { "security.delete_service_token": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", - "description": "Deletes a service account token." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-service-token", + "description": "Delete service account tokens" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.delete_user.json b/specification/_json_spec/security.delete_user.json index ab863bcf47..d624d8976e 100644 --- a/specification/_json_spec/security.delete_user.json +++ b/specification/_json_spec/security.delete_user.json @@ -1,8 +1,8 @@ { "security.delete_user": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", - "description": "Deletes users from the native realm." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-user", + "description": "Delete users" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.disable_user.json b/specification/_json_spec/security.disable_user.json index 2ce1d40c4a..40a6be9a26 100644 --- a/specification/_json_spec/security.disable_user.json +++ b/specification/_json_spec/security.disable_user.json @@ -1,8 +1,8 @@ { "security.disable_user": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", - "description": "Disables users in the native realm." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user", + "description": "Disable users" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.disable_user_profile.json b/specification/_json_spec/security.disable_user_profile.json index 92a07549d9..58656de37d 100644 --- a/specification/_json_spec/security.disable_user_profile.json +++ b/specification/_json_spec/security.disable_user_profile.json @@ -1,11 +1,11 @@ { "security.disable_user_profile": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", - "description": "Disables a user profile so it's not visible in user profile searches." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user-profile", + "description": "Disable a user profile" }, "stability": "stable", - "visibility": "private", + "visibility": "public", "headers": { "accept": ["application/json"] }, @@ -27,6 +27,7 @@ "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` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } } diff --git a/specification/_json_spec/security.enable_user.json b/specification/_json_spec/security.enable_user.json index 9a12390f86..710cdba5d7 100644 --- a/specification/_json_spec/security.enable_user.json +++ b/specification/_json_spec/security.enable_user.json @@ -1,8 +1,8 @@ { "security.enable_user": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", - "description": "Enables users in the native realm." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user", + "description": "Enable users" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.enable_user_profile.json b/specification/_json_spec/security.enable_user_profile.json index 114d35f7a3..0017748d32 100644 --- a/specification/_json_spec/security.enable_user_profile.json +++ b/specification/_json_spec/security.enable_user_profile.json @@ -1,11 +1,11 @@ { "security.enable_user_profile": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", - "description": "Enables a user profile so it's visible in user profile searches." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user-profile", + "description": "Enable a user profile" }, "stability": "stable", - "visibility": "private", + "visibility": "public", "headers": { "accept": ["application/json"] }, @@ -27,6 +27,7 @@ "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` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes." } } diff --git a/specification/_json_spec/security.enroll_kibana.json b/specification/_json_spec/security.enroll_kibana.json index 0b8a32c733..039bb3f041 100644 --- a/specification/_json_spec/security.enroll_kibana.json +++ b/specification/_json_spec/security.enroll_kibana.json @@ -1,8 +1,8 @@ { "security.enroll_kibana": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", - "description": "Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-kibana", + "description": "Enroll Kibana" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.enroll_node.json b/specification/_json_spec/security.enroll_node.json index e4854db8b4..bf13909018 100644 --- a/specification/_json_spec/security.enroll_node.json +++ b/specification/_json_spec/security.enroll_node.json @@ -1,8 +1,8 @@ { "security.enroll_node": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", - "description": "Allows a new node to enroll to an existing cluster with security enabled." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-node", + "description": "Enroll a node" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.get_api_key.json b/specification/_json_spec/security.get_api_key.json index a127e06511..939927fdac 100644 --- a/specification/_json_spec/security.get_api_key.json +++ b/specification/_json_spec/security.get_api_key.json @@ -1,8 +1,8 @@ { "security.get_api_key": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", - "description": "Retrieves information for one or more API keys." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-api-key", + "description": "Get API key information" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.get_builtin_privileges.json b/specification/_json_spec/security.get_builtin_privileges.json index 9af1e25f8d..f12d06b99f 100644 --- a/specification/_json_spec/security.get_builtin_privileges.json +++ b/specification/_json_spec/security.get_builtin_privileges.json @@ -1,8 +1,8 @@ { "security.get_builtin_privileges": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges", + "description": "Get builtin privileges" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_privileges.json b/specification/_json_spec/security.get_privileges.json index 38d36c57cb..97d5715616 100644 --- a/specification/_json_spec/security.get_privileges.json +++ b/specification/_json_spec/security.get_privileges.json @@ -1,8 +1,8 @@ { "security.get_privileges": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", - "description": "Retrieves application privileges." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-privileges", + "description": "Get application privileges" }, "stability": "stable", "visibility": "public", @@ -40,7 +40,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_role.json b/specification/_json_spec/security.get_role.json index 3b09c2f29e..8dece32e9a 100644 --- a/specification/_json_spec/security.get_role.json +++ b/specification/_json_spec/security.get_role.json @@ -1,8 +1,8 @@ { "security.get_role": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", - "description": "Retrieves roles in the native realm." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role", + "description": "Get roles" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_role_mapping.json b/specification/_json_spec/security.get_role_mapping.json index 1a076bb8a3..0d195ac767 100644 --- a/specification/_json_spec/security.get_role_mapping.json +++ b/specification/_json_spec/security.get_role_mapping.json @@ -1,8 +1,8 @@ { "security.get_role_mapping": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", - "description": "Retrieves role mappings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role-mapping", + "description": "Get role mappings" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_service_accounts.json b/specification/_json_spec/security.get_service_accounts.json index 01d38e241b..7a409998e5 100644 --- a/specification/_json_spec/security.get_service_accounts.json +++ b/specification/_json_spec/security.get_service_accounts.json @@ -1,8 +1,8 @@ { "security.get_service_accounts": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", - "description": "Retrieves information about service accounts." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-accounts", + "description": "Get service accounts" }, "stability": "stable", "visibility": "public", @@ -40,7 +40,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_service_credentials.json b/specification/_json_spec/security.get_service_credentials.json index 95e9940b5e..4c86dbf7d0 100644 --- a/specification/_json_spec/security.get_service_credentials.json +++ b/specification/_json_spec/security.get_service_credentials.json @@ -1,8 +1,8 @@ { "security.get_service_credentials": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", - "description": "Retrieves information of all service credentials for a service account." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-credentials", + "description": "Get service account credentials" }, "stability": "stable", "visibility": "public", @@ -26,7 +26,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_settings.json b/specification/_json_spec/security.get_settings.json index ff7d887738..1f46e9f79f 100644 --- a/specification/_json_spec/security.get_settings.json +++ b/specification/_json_spec/security.get_settings.json @@ -1,8 +1,8 @@ { "security.get_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html", - "description": "Retrieve settings for the security system indices" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-settings", + "description": "Get security index settings" }, "stability": "stable", "visibility": "public", @@ -21,6 +21,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master" } } diff --git a/specification/_json_spec/security.get_stats.json b/specification/_json_spec/security.get_stats.json new file mode 100644 index 0000000000..19baa75bb5 --- /dev/null +++ b/specification/_json_spec/security.get_stats.json @@ -0,0 +1,22 @@ +{ + "security.get_stats": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-stats", + "description": "Get security statistics for all nodes" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_security/stats", + "methods": ["GET"] + } + ] + } + } +} diff --git a/specification/_json_spec/security.get_token.json b/specification/_json_spec/security.get_token.json index 77cd6cf1af..d4f0ae0a0c 100644 --- a/specification/_json_spec/security.get_token.json +++ b/specification/_json_spec/security.get_token.json @@ -1,8 +1,8 @@ { "security.get_token": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", - "description": "Creates a bearer token for access without requiring basic authentication." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-token", + "description": "Get a token" }, "stability": "stable", "visibility": "public", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The token request to get", "required": true diff --git a/specification/_json_spec/security.get_user.json b/specification/_json_spec/security.get_user.json index 98c22f980c..813173510e 100644 --- a/specification/_json_spec/security.get_user.json +++ b/specification/_json_spec/security.get_user.json @@ -1,8 +1,8 @@ { "security.get_user": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", - "description": "Retrieves information about users in the native realm and built-in users." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user", + "description": "Get users" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.get_user_privileges.json b/specification/_json_spec/security.get_user_privileges.json index eee8733fd8..67799c90c3 100644 --- a/specification/_json_spec/security.get_user_privileges.json +++ b/specification/_json_spec/security.get_user_privileges.json @@ -1,8 +1,8 @@ { "security.get_user_privileges": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", - "description": "Retrieves security privileges for the logged in user." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-privileges", + "description": "Get user privileges" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/security.get_user_profile.json b/specification/_json_spec/security.get_user_profile.json index bbf83d8e10..ab91402026 100644 --- a/specification/_json_spec/security.get_user_profile.json +++ b/specification/_json_spec/security.get_user_profile.json @@ -1,11 +1,11 @@ { "security.get_user_profile": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html", - "description": "Retrieves user profiles for the given unique ID(s)." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-profile", + "description": "Get a user profile" }, "stability": "stable", - "visibility": "private", + "visibility": "public", "headers": { "accept": ["application/json"] }, diff --git a/specification/_json_spec/security.grant_api_key.json b/specification/_json_spec/security.grant_api_key.json index f2bc9fded9..158dacaeab 100644 --- a/specification/_json_spec/security.grant_api_key.json +++ b/specification/_json_spec/security.grant_api_key.json @@ -1,8 +1,8 @@ { "security.grant_api_key": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", - "description": "Creates an API key on behalf of another user." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-grant-api-key", + "description": "Grant an API key" }, "stability": "stable", "visibility": "public", @@ -22,6 +22,7 @@ "refresh": { "type": "enum", "options": ["true", "false", "wait_for"], + "default": "false", "description": "If `true` (the default) 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` then do nothing with refreshes." } }, diff --git a/specification/_json_spec/security.has_privileges.json b/specification/_json_spec/security.has_privileges.json index d3fa568c9a..03a43976b3 100644 --- a/specification/_json_spec/security.has_privileges.json +++ b/specification/_json_spec/security.has_privileges.json @@ -1,8 +1,8 @@ { "security.has_privileges": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", - "description": "Determines whether the specified user has a specified list of privileges." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges", + "description": "Check user privileges" }, "stability": "stable", "visibility": "public", @@ -28,7 +28,6 @@ } ] }, - "params": {}, "body": { "description": "The privileges to test", "required": true diff --git a/specification/_json_spec/security.has_privileges_user_profile.json b/specification/_json_spec/security.has_privileges_user_profile.json index 2ec03e8b13..0b56a67450 100644 --- a/specification/_json_spec/security.has_privileges_user_profile.json +++ b/specification/_json_spec/security.has_privileges_user_profile.json @@ -1,11 +1,11 @@ { "security.has_privileges_user_profile": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html", - "description": "Determines whether the users associated with the specified profile IDs have all the requested privileges." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges-user-profile", + "description": "Check user profile privileges" }, "stability": "stable", - "visibility": "private", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The privileges to check and the list of profile IDs", "required": true diff --git a/specification/_json_spec/security.invalidate_api_key.json b/specification/_json_spec/security.invalidate_api_key.json index e91b55e0cb..cd584a632b 100644 --- a/specification/_json_spec/security.invalidate_api_key.json +++ b/specification/_json_spec/security.invalidate_api_key.json @@ -1,8 +1,8 @@ { "security.invalidate_api_key": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", - "description": "Invalidates one or more API keys." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-api-key", + "description": "Invalidate API keys" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.invalidate_token.json b/specification/_json_spec/security.invalidate_token.json index 35e8087e4b..a90aa7e3d2 100644 --- a/specification/_json_spec/security.invalidate_token.json +++ b/specification/_json_spec/security.invalidate_token.json @@ -1,8 +1,8 @@ { "security.invalidate_token": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", - "description": "Invalidates one or more access tokens or refresh tokens." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-token", + "description": "Invalidate a token" }, "stability": "stable", "visibility": "public", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "The token to invalidate", "required": true diff --git a/specification/_json_spec/security.oidc_authenticate.json b/specification/_json_spec/security.oidc_authenticate.json index 2c58093209..8bf700b48a 100644 --- a/specification/_json_spec/security.oidc_authenticate.json +++ b/specification/_json_spec/security.oidc_authenticate.json @@ -1,8 +1,8 @@ { "security.oidc_authenticate": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html", - "description": "Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-authenticate", + "description": "Authenticate OpenID Connect" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.oidc_logout.json b/specification/_json_spec/security.oidc_logout.json index da73b91951..8bd22cba63 100644 --- a/specification/_json_spec/security.oidc_logout.json +++ b/specification/_json_spec/security.oidc_logout.json @@ -1,8 +1,8 @@ { "security.oidc_logout": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html", - "description": "Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-logout", + "description": "Logout of OpenID Connect" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.oidc_prepare_authentication.json b/specification/_json_spec/security.oidc_prepare_authentication.json index fa6c980c34..ce50c46894 100644 --- a/specification/_json_spec/security.oidc_prepare_authentication.json +++ b/specification/_json_spec/security.oidc_prepare_authentication.json @@ -1,8 +1,8 @@ { "security.oidc_prepare_authentication": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html", - "description": "Creates an OAuth 2.0 authentication request as a URL string" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-prepare-authentication", + "description": "Prepare OpenID connect authentication" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.put_privileges.json b/specification/_json_spec/security.put_privileges.json index e13b556b87..6b0316d3b8 100644 --- a/specification/_json_spec/security.put_privileges.json +++ b/specification/_json_spec/security.put_privileges.json @@ -1,8 +1,8 @@ { "security.put_privileges": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", - "description": "Adds or updates application privileges." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-privileges", + "description": "Create or update application privileges" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.put_role.json b/specification/_json_spec/security.put_role.json index 9139e05b7b..dbf5388e45 100644 --- a/specification/_json_spec/security.put_role.json +++ b/specification/_json_spec/security.put_role.json @@ -1,8 +1,8 @@ { "security.put_role": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", - "description": "Adds and updates roles in the native realm." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role", + "description": "Create or update roles" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.put_role_mapping.json b/specification/_json_spec/security.put_role_mapping.json index de65d69e89..359fbfe7ba 100644 --- a/specification/_json_spec/security.put_role_mapping.json +++ b/specification/_json_spec/security.put_role_mapping.json @@ -1,8 +1,8 @@ { "security.put_role_mapping": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", - "description": "Creates and updates role mappings." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role-mapping", + "description": "Create or update role mappings" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.put_user.json b/specification/_json_spec/security.put_user.json index b4f00e9779..b3151c36e8 100644 --- a/specification/_json_spec/security.put_user.json +++ b/specification/_json_spec/security.put_user.json @@ -1,8 +1,8 @@ { "security.put_user": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", - "description": "Adds and updates users in the native realm. These users are commonly referred to as native users." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-user", + "description": "Create or update users" }, "stability": "stable", "visibility": "public", @@ -28,6 +28,7 @@ "refresh": { "type": "enum", "options": ["true", "false", "wait_for"], + "default": "true", "description": "If `true` (the default) 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` then do nothing with refreshes." } }, diff --git a/specification/_json_spec/security.query_api_keys.json b/specification/_json_spec/security.query_api_keys.json index ab9acea209..07f431367e 100644 --- a/specification/_json_spec/security.query_api_keys.json +++ b/specification/_json_spec/security.query_api_keys.json @@ -1,8 +1,8 @@ { "security.query_api_keys": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", - "description": "Retrieves information for API keys using a subset of query DSL" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-api-keys", + "description": "Find API keys with a query" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.query_role.json b/specification/_json_spec/security.query_role.json index 15baf32f32..a6cd9f0ba0 100644 --- a/specification/_json_spec/security.query_role.json +++ b/specification/_json_spec/security.query_role.json @@ -1,8 +1,8 @@ { "security.query_role": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html", - "description": "Retrieves information for Roles using a subset of query DSL" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role", + "description": "Find roles with a query" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.query_user.json b/specification/_json_spec/security.query_user.json index a16a1aeadc..23ce7a6a1d 100644 --- a/specification/_json_spec/security.query_user.json +++ b/specification/_json_spec/security.query_user.json @@ -1,8 +1,8 @@ { "security.query_user": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html", - "description": "Retrieves information for Users using a subset of query DSL" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-user", + "description": "Find users with a query" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.saml_authenticate.json b/specification/_json_spec/security.saml_authenticate.json index 2fce00d4d0..a6eb07e9c9 100644 --- a/specification/_json_spec/security.saml_authenticate.json +++ b/specification/_json_spec/security.saml_authenticate.json @@ -1,8 +1,8 @@ { "security.saml_authenticate": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", - "description": "Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-authenticate", + "description": "Authenticate SAML" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.saml_complete_logout.json b/specification/_json_spec/security.saml_complete_logout.json index c802d210c1..436b1302e7 100644 --- a/specification/_json_spec/security.saml_complete_logout.json +++ b/specification/_json_spec/security.saml_complete_logout.json @@ -1,8 +1,8 @@ { "security.saml_complete_logout": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", - "description": "Verifies the logout response sent from the SAML IdP" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-complete-logout", + "description": "Logout of SAML completely" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.saml_invalidate.json b/specification/_json_spec/security.saml_invalidate.json index fd82b7d18e..a3ef070f1e 100644 --- a/specification/_json_spec/security.saml_invalidate.json +++ b/specification/_json_spec/security.saml_invalidate.json @@ -1,8 +1,8 @@ { "security.saml_invalidate": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", - "description": "Consumes a SAML LogoutRequest" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-invalidate", + "description": "Invalidate SAML" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.saml_logout.json b/specification/_json_spec/security.saml_logout.json index 19198f3ca9..ae08110bd3 100644 --- a/specification/_json_spec/security.saml_logout.json +++ b/specification/_json_spec/security.saml_logout.json @@ -1,8 +1,8 @@ { "security.saml_logout": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", - "description": "Invalidates an access token and a refresh token that were generated via the SAML Authenticate API" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-logout", + "description": "Logout of SAML" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.saml_prepare_authentication.json b/specification/_json_spec/security.saml_prepare_authentication.json index 42f30029dd..4da94fb597 100644 --- a/specification/_json_spec/security.saml_prepare_authentication.json +++ b/specification/_json_spec/security.saml_prepare_authentication.json @@ -1,8 +1,8 @@ { "security.saml_prepare_authentication": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", - "description": "Creates a SAML authentication request" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-prepare-authentication", + "description": "Prepare SAML authentication" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.saml_service_provider_metadata.json b/specification/_json_spec/security.saml_service_provider_metadata.json index 19b82dcfb8..5c928365cb 100644 --- a/specification/_json_spec/security.saml_service_provider_metadata.json +++ b/specification/_json_spec/security.saml_service_provider_metadata.json @@ -1,8 +1,8 @@ { "security.saml_service_provider_metadata": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", - "description": "Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-service-provider-metadata", + "description": "Create SAML service provider metadata" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.suggest_user_profiles.json b/specification/_json_spec/security.suggest_user_profiles.json index 276f132909..47043a1bd9 100644 --- a/specification/_json_spec/security.suggest_user_profiles.json +++ b/specification/_json_spec/security.suggest_user_profiles.json @@ -1,11 +1,11 @@ { "security.suggest_user_profiles": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html", - "description": "Get suggestions for user profiles that match specified search criteria." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-suggest-user-profiles", + "description": "Suggest a user profile" }, "stability": "stable", - "visibility": "private", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] diff --git a/specification/_json_spec/security.update_api_key.json b/specification/_json_spec/security.update_api_key.json index ad5eb4ed68..464caf6a27 100644 --- a/specification/_json_spec/security.update_api_key.json +++ b/specification/_json_spec/security.update_api_key.json @@ -1,8 +1,8 @@ { "security.update_api_key": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", - "description": "Updates attributes of an existing API key." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key", + "description": "Update an API key" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.update_cross_cluster_api_key.json b/specification/_json_spec/security.update_cross_cluster_api_key.json index 7f10d6d254..7c93c89188 100644 --- a/specification/_json_spec/security.update_cross_cluster_api_key.json +++ b/specification/_json_spec/security.update_cross_cluster_api_key.json @@ -1,8 +1,8 @@ { "security.update_cross_cluster_api_key": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", - "description": "Updates attributes of an existing cross-cluster API key." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key", + "description": "Update a cross-cluster API key" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/security.update_settings.json b/specification/_json_spec/security.update_settings.json index fd3aa19945..bae094e2c8 100644 --- a/specification/_json_spec/security.update_settings.json +++ b/specification/_json_spec/security.update_settings.json @@ -1,8 +1,8 @@ { "security.update_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html", - "description": "Update settings for the security system index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-settings", + "description": "Update security index settings" }, "stability": "stable", "visibility": "public", @@ -21,6 +21,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for connection to master" }, "timeout": { diff --git a/specification/_json_spec/security.update_user_profile_data.json b/specification/_json_spec/security.update_user_profile_data.json index e546cee3b4..398c9c6605 100644 --- a/specification/_json_spec/security.update_user_profile_data.json +++ b/specification/_json_spec/security.update_user_profile_data.json @@ -1,11 +1,11 @@ { "security.update_user_profile_data": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html", - "description": "Update application specific data for the user profile of the given unique ID." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-user-profile-data", + "description": "Update user profile data" }, "stability": "stable", - "visibility": "private", + "visibility": "public", "headers": { "accept": ["application/json"], "content_type": ["application/json"] @@ -26,16 +26,17 @@ }, "params": { "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified primary term" }, "refresh": { "type": "enum", "options": ["true", "false", "wait_for"], + "default": "false", "description": "If `true` (the default) 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` then do nothing with refreshes." } }, diff --git a/specification/_json_spec/shutdown.delete_node.json b/specification/_json_spec/shutdown.delete_node.json index d6c6551340..bba125b182 100644 --- a/specification/_json_spec/shutdown.delete_node.json +++ b/specification/_json_spec/shutdown.delete_node.json @@ -1,8 +1,8 @@ { "shutdown.delete_node": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-delete-node", + "description": "Cancel node shutdown preparations" }, "stability": "stable", "visibility": "private", @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/shutdown.get_node.json b/specification/_json_spec/shutdown.get_node.json index 975f8530f6..110b8d6c50 100644 --- a/specification/_json_spec/shutdown.get_node.json +++ b/specification/_json_spec/shutdown.get_node.json @@ -1,8 +1,8 @@ { "shutdown.get_node": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-get-node", + "description": "Get the shutdown status" }, "stability": "stable", "visibility": "private", @@ -14,8 +14,7 @@ "paths": [ { "path": "/_nodes/shutdown", - "methods": ["GET"], - "parts": {} + "methods": ["GET"] }, { "path": "/_nodes/{node_id}/shutdown", @@ -32,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" } } diff --git a/specification/_json_spec/shutdown.put_node.json b/specification/_json_spec/shutdown.put_node.json index b0e29899e1..78292e3c78 100644 --- a/specification/_json_spec/shutdown.put_node.json +++ b/specification/_json_spec/shutdown.put_node.json @@ -1,8 +1,8 @@ { "shutdown.put_node": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current", - "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-put-node", + "description": "Prepare a node to be shut down" }, "stability": "stable", "visibility": "private", @@ -27,10 +27,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, diff --git a/specification/_json_spec/simulate.ingest.json b/specification/_json_spec/simulate.ingest.json index 5bd6527f24..e88aba811f 100644 --- a/specification/_json_spec/simulate.ingest.json +++ b/specification/_json_spec/simulate.ingest.json @@ -1,8 +1,8 @@ { "simulate.ingest": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-ingest-api.html", - "description": "Simulates running ingest with example documents." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-simulate-ingest", + "description": "Simulate data ingestion" }, "stability": "experimental", "visibility": "public", @@ -32,6 +32,11 @@ "pipeline": { "type": "string", "description": "The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document" + }, + "merge_type": { + "type": "string", + "description": "The mapping merge type if mapping overrides are being provided in mapping_addition. The allowed values are one of index or template. The index option merges mappings the way they would be merged into an existing index. The template option merges mappings the way they would be merged into a template.", + "default": "index" } }, "body": { diff --git a/specification/_json_spec/slm.delete_lifecycle.json b/specification/_json_spec/slm.delete_lifecycle.json index 3017931873..5766645ba4 100644 --- a/specification/_json_spec/slm.delete_lifecycle.json +++ b/specification/_json_spec/slm.delete_lifecycle.json @@ -1,8 +1,8 @@ { "slm.delete_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", - "description": "Deletes an existing snapshot lifecycle policy." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-delete-lifecycle", + "description": "Delete a policy" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.execute_lifecycle.json b/specification/_json_spec/slm.execute_lifecycle.json index 4625097a98..4c97208c15 100644 --- a/specification/_json_spec/slm.execute_lifecycle.json +++ b/specification/_json_spec/slm.execute_lifecycle.json @@ -1,8 +1,8 @@ { "slm.execute_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", - "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle", + "description": "Run a policy" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.execute_retention.json b/specification/_json_spec/slm.execute_retention.json index eb5c31c0f0..5acc3f5b32 100644 --- a/specification/_json_spec/slm.execute_retention.json +++ b/specification/_json_spec/slm.execute_retention.json @@ -1,8 +1,8 @@ { "slm.execute_retention": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", - "description": "Deletes any snapshots that are expired according to the policy's retention rules." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-retention", + "description": "Run a retention policy" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_lifecycle.json b/specification/_json_spec/slm.get_lifecycle.json index 6d71517825..f2218aa357 100644 --- a/specification/_json_spec/slm.get_lifecycle.json +++ b/specification/_json_spec/slm.get_lifecycle.json @@ -1,8 +1,8 @@ { "slm.get_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", - "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle", + "description": "Get policy information" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_stats.json b/specification/_json_spec/slm.get_stats.json index 2d9899c8e8..9cd90507da 100644 --- a/specification/_json_spec/slm.get_stats.json +++ b/specification/_json_spec/slm.get_stats.json @@ -1,8 +1,8 @@ { "slm.get_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", - "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats", + "description": "Get snapshot lifecycle management statistics" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.get_status.json b/specification/_json_spec/slm.get_status.json index 10b0c02a12..d1f6958400 100644 --- a/specification/_json_spec/slm.get_status.json +++ b/specification/_json_spec/slm.get_status.json @@ -1,8 +1,8 @@ { "slm.get_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", - "description": "Retrieves the status of snapshot lifecycle management (SLM)." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-status", + "description": "Get the snapshot lifecycle management status" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/slm.put_lifecycle.json b/specification/_json_spec/slm.put_lifecycle.json index 5a605362e8..5c6d6e5d18 100644 --- a/specification/_json_spec/slm.put_lifecycle.json +++ b/specification/_json_spec/slm.put_lifecycle.json @@ -1,8 +1,8 @@ { "slm.put_lifecycle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", - "description": "Creates or updates a snapshot lifecycle policy." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-put-lifecycle", + "description": "Create or update a policy" }, "stability": "stable", "visibility": "public", @@ -27,15 +27,18 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } }, "body": { - "description": "The snapshot lifecycle policy definition to register" + "description": "The snapshot lifecycle policy definition to register", + "required": true } } } diff --git a/specification/_json_spec/slm.start.json b/specification/_json_spec/slm.start.json index 0afbe0ce7f..5d0ef6cacc 100644 --- a/specification/_json_spec/slm.start.json +++ b/specification/_json_spec/slm.start.json @@ -1,8 +1,8 @@ { "slm.start": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", - "description": "Turns on snapshot lifecycle management (SLM)." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start", + "description": "Start snapshot lifecycle management" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/slm.stop.json b/specification/_json_spec/slm.stop.json index 0feded1bda..0b540f8e34 100644 --- a/specification/_json_spec/slm.stop.json +++ b/specification/_json_spec/slm.stop.json @@ -1,8 +1,8 @@ { "slm.stop": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", - "description": "Turns off snapshot lifecycle management (SLM)." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-stop", + "description": "Stop snapshot lifecycle management" }, "stability": "stable", "visibility": "public", @@ -20,10 +20,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Timeout for processing on master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Timeout for acknowledgement of update from all nodes in cluster" } } diff --git a/specification/_json_spec/snapshot.cleanup_repository.json b/specification/_json_spec/snapshot.cleanup_repository.json index cb3de3cd64..dc66a39c70 100644 --- a/specification/_json_spec/snapshot.cleanup_repository.json +++ b/specification/_json_spec/snapshot.cleanup_repository.json @@ -1,8 +1,8 @@ { "snapshot.cleanup_repository": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", - "description": "Removes stale data from repository." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository", + "description": "Clean up the snapshot repository" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/snapshot.clone.json b/specification/_json_spec/snapshot.clone.json index f715683005..5a4a65bb99 100644 --- a/specification/_json_spec/snapshot.clone.json +++ b/specification/_json_spec/snapshot.clone.json @@ -1,8 +1,8 @@ { "snapshot.clone": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Clones indices from one snapshot into another snapshot in the same repository." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone", + "description": "Clone a snapshot" }, "stability": "stable", "visibility": "public", @@ -35,6 +35,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" } }, diff --git a/specification/_json_spec/snapshot.create.json b/specification/_json_spec/snapshot.create.json index c0ed2baeac..6c2c7bfbe4 100644 --- a/specification/_json_spec/snapshot.create.json +++ b/specification/_json_spec/snapshot.create.json @@ -1,8 +1,8 @@ { "snapshot.create": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Creates a snapshot in a repository." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create", + "description": "Create a snapshot" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "wait_for_completion": { diff --git a/specification/_json_spec/snapshot.create_repository.json b/specification/_json_spec/snapshot.create_repository.json index 5858424757..81af556670 100644 --- a/specification/_json_spec/snapshot.create_repository.json +++ b/specification/_json_spec/snapshot.create_repository.json @@ -1,8 +1,8 @@ { "snapshot.create_repository": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Creates a repository." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create-repository", + "description": "Create or update a snapshot repository" }, "stability": "stable", "visibility": "public", @@ -27,14 +27,17 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" }, "verify": { "type": "boolean", + "default": true, "description": "Whether to verify the repository after creation" } }, diff --git a/specification/_json_spec/snapshot.delete.json b/specification/_json_spec/snapshot.delete.json index cf2bd26b93..30de2cfa34 100644 --- a/specification/_json_spec/snapshot.delete.json +++ b/specification/_json_spec/snapshot.delete.json @@ -1,8 +1,8 @@ { "snapshot.delete": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Deletes one or more snapshots." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete", + "description": "Delete snapshots" }, "stability": "stable", "visibility": "public", @@ -30,6 +30,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "wait_for_completion": { diff --git a/specification/_json_spec/snapshot.delete_repository.json b/specification/_json_spec/snapshot.delete_repository.json index 13151599ed..5bee4f933d 100644 --- a/specification/_json_spec/snapshot.delete_repository.json +++ b/specification/_json_spec/snapshot.delete_repository.json @@ -1,8 +1,8 @@ { "snapshot.delete_repository": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Deletes a repository." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete-repository", + "description": "Delete snapshot repositories" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/snapshot.get.json b/specification/_json_spec/snapshot.get.json index 4f43652dc5..b14bc9afff 100644 --- a/specification/_json_spec/snapshot.get.json +++ b/specification/_json_spec/snapshot.get.json @@ -1,8 +1,8 @@ { "snapshot.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Returns information about a snapshot." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get", + "description": "Get snapshot information" }, "stability": "stable", "visibility": "public", @@ -30,22 +30,27 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown" }, "index_names": { "type": "boolean", + "default": true, "description": "Whether to include the name of each index in the snapshot. Defaults to true." }, "index_details": { "type": "boolean", + "default": false, "description": "Whether to include details of each index in the snapshot, if those details are available. Defaults to false." }, "include_repository": { "type": "boolean", + "default": true, "description": "Whether to include the repository name in the snapshot info. Defaults to true." }, "sort": { @@ -63,7 +68,8 @@ "description": "Allows setting a sort order for the result. Defaults to start_time" }, "size": { - "type": "integer", + "type": "int", + "default": 0, "description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit." }, "order": { @@ -81,7 +87,8 @@ "description": "Offset identifier to start pagination from as returned by the 'next' field in the response body." }, "offset": { - "type": "integer", + "type": "int", + "default": 0, "description": "Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0" }, "slm_policy_filter": { @@ -90,6 +97,7 @@ }, "verbose": { "type": "boolean", + "default": true, "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob" }, "state": { diff --git a/specification/_json_spec/snapshot.get_repository.json b/specification/_json_spec/snapshot.get_repository.json index 854198378b..2c436e545a 100644 --- a/specification/_json_spec/snapshot.get_repository.json +++ b/specification/_json_spec/snapshot.get_repository.json @@ -1,8 +1,8 @@ { "snapshot.get_repository": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Returns information about a repository." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get-repository", + "description": "Get snapshot repository information" }, "stability": "stable", "visibility": "public", @@ -30,10 +30,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "local": { "type": "boolean", + "default": false, "description": "Return local information, do not retrieve the state from master node (default: false)" } } diff --git a/specification/_json_spec/snapshot.repository_analyze.json b/specification/_json_spec/snapshot.repository_analyze.json index d80c4bc122..da1758cf91 100644 --- a/specification/_json_spec/snapshot.repository_analyze.json +++ b/specification/_json_spec/snapshot.repository_analyze.json @@ -1,8 +1,8 @@ { "snapshot.repository_analyze": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Analyzes a repository for correctness and performance" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze", + "description": "Analyze a snapshot repository" }, "stability": "stable", "visibility": "public", @@ -25,47 +25,62 @@ }, "params": { "blob_count": { - "type": "number", + "type": "int", + "default": 100, "description": "Number of blobs to create during the test. Defaults to 100." }, "concurrency": { - "type": "number", + "type": "int", + "default": 10, "description": "Number of operations to run concurrently during the test. Defaults to 10." }, + "register_operation_count": { + "type": "int", + "default": 10, + "description": "The minimum number of linearizable register operations to perform in total. Defaults to 10." + }, "read_node_count": { - "type": "number", + "type": "int", + "default": 10, "description": "Number of nodes on which to read a blob after writing. Defaults to 10." }, "early_read_node_count": { - "type": "number", + "type": "int", + "default": 2, "description": "Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2." }, "seed": { - "type": "number", + "type": "int", "description": "Seed for the random number generator used to create the test workload. Defaults to a random value." }, "rare_action_probability": { - "type": "number", + "type": "double", + "default": 0, "description": "Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02." }, "max_blob_size": { "type": "string", + "default": "10mb", "description": "Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'." }, "max_total_data_size": { "type": "string", + "default": "1gb", "description": "Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'." }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout. Defaults to '30s'." }, "detailed": { "type": "boolean", + "default": false, "description": "Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned." }, "rarely_abort_writes": { "type": "boolean", + "default": true, "description": "Whether to rarely abort writes before they complete. Defaults to 'true'." } } diff --git a/specification/_json_spec/snapshot.repository_verify_integrity.json b/specification/_json_spec/snapshot.repository_verify_integrity.json index 482eaaec30..b3eae64af0 100644 --- a/specification/_json_spec/snapshot.repository_verify_integrity.json +++ b/specification/_json_spec/snapshot.repository_verify_integrity.json @@ -1,8 +1,8 @@ { "snapshot.repository_verify_integrity": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Verifies the integrity of the contents of a snapshot repository" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-verify-integrity", + "description": "Verify the repository integrity" }, "stability": "experimental", "visibility": "public", @@ -25,35 +25,43 @@ }, "params": { "meta_thread_pool_concurrency": { - "type": "number", + "type": "int", + "default": 0, "description": "Number of threads to use for reading metadata" }, "blob_thread_pool_concurrency": { - "type": "number", + "type": "int", + "default": 1, "description": "Number of threads to use for reading blob contents" }, "snapshot_verification_concurrency": { - "type": "number", + "type": "int", + "default": 0, "description": "Number of snapshots to verify concurrently" }, "index_verification_concurrency": { - "type": "number", + "type": "int", + "default": 0, "description": "Number of indices to verify concurrently" }, "index_snapshot_verification_concurrency": { - "type": "number", + "type": "int", + "default": 1, "description": "Number of snapshots to verify concurrently within each index" }, "max_failed_shard_snapshots": { - "type": "number", + "type": "int", + "default": 10000, "description": "Maximum permitted number of failed shard snapshots" }, "verify_blob_contents": { "type": "boolean", + "default": false, "description": "Whether to verify the contents of individual blobs" }, "max_bytes_per_sec": { "type": "string", + "default": "10mb", "description": "Rate limit for individual blob verification" } } diff --git a/specification/_json_spec/snapshot.restore.json b/specification/_json_spec/snapshot.restore.json index 5480ac4a6e..280df5a9d6 100644 --- a/specification/_json_spec/snapshot.restore.json +++ b/specification/_json_spec/snapshot.restore.json @@ -1,8 +1,8 @@ { "snapshot.restore": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Restores a snapshot." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-restore", + "description": "Restore a snapshot" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "wait_for_completion": { diff --git a/specification/_json_spec/snapshot.status.json b/specification/_json_spec/snapshot.status.json index 42530074f9..d7b617ea6f 100644 --- a/specification/_json_spec/snapshot.status.json +++ b/specification/_json_spec/snapshot.status.json @@ -1,8 +1,8 @@ { "snapshot.status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Returns information about the status of a snapshot." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-status", + "description": "Get the snapshot status" }, "stability": "stable", "visibility": "public", @@ -44,10 +44,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown" } } diff --git a/specification/_json_spec/snapshot.verify_repository.json b/specification/_json_spec/snapshot.verify_repository.json index 9faacd3a6d..5155bd0b7a 100644 --- a/specification/_json_spec/snapshot.verify_repository.json +++ b/specification/_json_spec/snapshot.verify_repository.json @@ -1,8 +1,8 @@ { "snapshot.verify_repository": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", - "description": "Verifies a repository." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository", + "description": "Verify a snapshot repository" }, "stability": "stable", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout for connection to master node" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/sql.clear_cursor.json b/specification/_json_spec/sql.clear_cursor.json index 1085d4eac5..8861ba1999 100644 --- a/specification/_json_spec/sql.clear_cursor.json +++ b/specification/_json_spec/sql.clear_cursor.json @@ -1,8 +1,8 @@ { "sql.clear_cursor": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", - "description": "Clears the SQL cursor" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor", + "description": "Clear an SQL search cursor" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/sql.delete_async.json b/specification/_json_spec/sql.delete_async.json index 50da9ad6d2..b14e7f54c8 100644 --- a/specification/_json_spec/sql.delete_async.json +++ b/specification/_json_spec/sql.delete_async.json @@ -1,8 +1,8 @@ { "sql.delete_async": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", - "description": "Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async", + "description": "Delete an async SQL search" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/sql.get_async.json b/specification/_json_spec/sql.get_async.json index efe68c538a..51d397b282 100644 --- a/specification/_json_spec/sql.get_async.json +++ b/specification/_json_spec/sql.get_async.json @@ -1,8 +1,8 @@ { "sql.get_async": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", - "description": "Returns the current status and available results for an async SQL search or stored synchronous SQL search" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async", + "description": "Get async SQL search results" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/sql.get_async_status.json b/specification/_json_spec/sql.get_async_status.json index 8ef268e5d5..a162ac3eaf 100644 --- a/specification/_json_spec/sql.get_async_status.json +++ b/specification/_json_spec/sql.get_async_status.json @@ -1,8 +1,8 @@ { "sql.get_async_status": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", - "description": "Returns the current status of an async SQL search or a stored synchronous SQL search" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status", + "description": "Get the async SQL search status" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/sql.query.json b/specification/_json_spec/sql.query.json index c660867694..fef69b0617 100644 --- a/specification/_json_spec/sql.query.json +++ b/specification/_json_spec/sql.query.json @@ -1,8 +1,8 @@ { "sql.query": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", - "description": "Executes a SQL request" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query", + "description": "Get SQL search results" }, "stability": "stable", "visibility": "public", @@ -22,6 +22,10 @@ "format": { "type": "string", "description": "a short version of the Accept header, e.g. json, yaml" + }, + "project_routing": { + "type": "string", + "description": "A Lucene query using project metadata tags to limit which projects to search, such as _alias:_origin or _alias:*pr*. Only supported in serverless." } }, "body": { diff --git a/specification/_json_spec/sql.translate.json b/specification/_json_spec/sql.translate.json index 5b2208a7c1..09b25484fd 100644 --- a/specification/_json_spec/sql.translate.json +++ b/specification/_json_spec/sql.translate.json @@ -1,8 +1,8 @@ { "sql.translate": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", - "description": "Translates SQL into Elasticsearch queries" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate", + "description": "Translate SQL into Elasticsearch queries" }, "stability": "stable", "visibility": "public", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "Specify the query in the `query` element.", "required": true diff --git a/specification/_json_spec/ssl.certificates.json b/specification/_json_spec/ssl.certificates.json index ce56da82cf..f0db925ac2 100644 --- a/specification/_json_spec/ssl.certificates.json +++ b/specification/_json_spec/ssl.certificates.json @@ -1,8 +1,8 @@ { "ssl.certificates": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", - "description": "Retrieves information about the X.509 certificates used to encrypt communications in the cluster." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ssl-certificates", + "description": "Get SSL certificates" }, "stability": "stable", "visibility": "public", @@ -16,7 +16,6 @@ "methods": ["GET"] } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/streams.logs_disable.json b/specification/_json_spec/streams.logs_disable.json new file mode 100644 index 0000000000..58589d9a70 --- /dev/null +++ b/specification/_json_spec/streams.logs_disable.json @@ -0,0 +1,34 @@ +{ + "streams.logs_disable": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", + "description": "Disable the Logs Streams feature for this cluster" + }, + "stability": "experimental", + "visibility": "feature_flag", + "feature_flag": "logs_stream", + "headers": { + "accept": ["application/json", "text/plain"] + }, + "url": { + "paths": [ + { + "path": "/_streams/logs/_disable", + "methods": ["POST"] + } + ] + }, + "params": { + "timeout": { + "type": "time", + "default": "30s", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + "master_timeout": { + "type": "time", + "default": "30s", + "description": "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." + } + } + } +} diff --git a/specification/_json_spec/streams.logs_enable.json b/specification/_json_spec/streams.logs_enable.json new file mode 100644 index 0000000000..8220bc9065 --- /dev/null +++ b/specification/_json_spec/streams.logs_enable.json @@ -0,0 +1,34 @@ +{ + "streams.logs_enable": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", + "description": "Enable the Logs Streams feature for this cluster" + }, + "stability": "experimental", + "visibility": "feature_flag", + "feature_flag": "logs_stream", + "headers": { + "accept": ["application/json", "text/plain"] + }, + "url": { + "paths": [ + { + "path": "/_streams/logs/_enable", + "methods": ["POST"] + } + ] + }, + "params": { + "timeout": { + "type": "time", + "default": "30s", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + "master_timeout": { + "type": "time", + "default": "30s", + "description": "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." + } + } + } +} diff --git a/specification/_json_spec/streams.status.json b/specification/_json_spec/streams.status.json new file mode 100644 index 0000000000..395596a45d --- /dev/null +++ b/specification/_json_spec/streams.status.json @@ -0,0 +1,29 @@ +{ + "streams.status": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO", + "description": "Return the current status of the streams feature for each streams type" + }, + "stability": "experimental", + "visibility": "feature_flag", + "feature_flag": "logs_stream", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_streams/status", + "methods": ["GET"] + } + ] + }, + "params": { + "master_timeout": { + "type": "time", + "default": "30s", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + } + } + } +} diff --git a/specification/_json_spec/synonyms.delete_synonym.json b/specification/_json_spec/synonyms.delete_synonym.json index 32604b9bf2..6ed91b7054 100644 --- a/specification/_json_spec/synonyms.delete_synonym.json +++ b/specification/_json_spec/synonyms.delete_synonym.json @@ -1,8 +1,8 @@ { "synonyms.delete_synonym": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html", - "description": "Deletes a synonym set" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym", + "description": "Delete a synonym set" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/synonyms.delete_synonym_rule.json b/specification/_json_spec/synonyms.delete_synonym_rule.json index 03b60e126f..a3de21355f 100644 --- a/specification/_json_spec/synonyms.delete_synonym_rule.json +++ b/specification/_json_spec/synonyms.delete_synonym_rule.json @@ -1,8 +1,8 @@ { "synonyms.delete_synonym_rule": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html", - "description": "Deletes a synonym rule in a synonym set" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule", + "description": "Delete a synonym rule" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "refresh": { "type": "boolean", + "default": true, "description": "Refresh search analyzers to update synonyms" } } diff --git a/specification/_json_spec/synonyms.get_synonym.json b/specification/_json_spec/synonyms.get_synonym.json index 37d2881a50..fd016b3e93 100644 --- a/specification/_json_spec/synonyms.get_synonym.json +++ b/specification/_json_spec/synonyms.get_synonym.json @@ -1,8 +1,8 @@ { "synonyms.get_synonym": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html", - "description": "Retrieves a synonym set" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym", + "description": "Get a synonym set" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/synonyms.get_synonym_rule.json b/specification/_json_spec/synonyms.get_synonym_rule.json index 3f15f77bcf..e7e03c19b3 100644 --- a/specification/_json_spec/synonyms.get_synonym_rule.json +++ b/specification/_json_spec/synonyms.get_synonym_rule.json @@ -1,8 +1,8 @@ { "synonyms.get_synonym_rule": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html", - "description": "Retrieves a synonym rule from a synonym set" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule", + "description": "Get a synonym rule" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/synonyms.get_synonyms_sets.json b/specification/_json_spec/synonyms.get_synonyms_sets.json index 9da5296a59..4e8d9fecbd 100644 --- a/specification/_json_spec/synonyms.get_synonyms_sets.json +++ b/specification/_json_spec/synonyms.get_synonyms_sets.json @@ -1,8 +1,8 @@ { "synonyms.get_synonyms_sets": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html", - "description": "Retrieves a summary of all defined synonym sets" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym", + "description": "Get all synonym sets" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/synonyms.put_synonym.json b/specification/_json_spec/synonyms.put_synonym.json index 2df17d737a..ccf4501887 100644 --- a/specification/_json_spec/synonyms.put_synonym.json +++ b/specification/_json_spec/synonyms.put_synonym.json @@ -1,8 +1,8 @@ { "synonyms.put_synonym": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html", - "description": "Creates or updates a synonyms set" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym", + "description": "Create or update a synonym set" }, "stability": "stable", "visibility": "public", @@ -27,6 +27,7 @@ "params": { "refresh": { "type": "boolean", + "default": true, "description": "Refresh search analyzers to update synonyms" } }, diff --git a/specification/_json_spec/synonyms.put_synonym_rule.json b/specification/_json_spec/synonyms.put_synonym_rule.json index a2c4e3062f..104f239171 100644 --- a/specification/_json_spec/synonyms.put_synonym_rule.json +++ b/specification/_json_spec/synonyms.put_synonym_rule.json @@ -1,8 +1,8 @@ { "synonyms.put_synonym_rule": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html", - "description": "Creates or updates a synonym rule in a synonym set" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule", + "description": "Create or update a synonym rule" }, "stability": "stable", "visibility": "public", @@ -31,6 +31,7 @@ "params": { "refresh": { "type": "boolean", + "default": true, "description": "Refresh search analyzers to update synonyms" } }, diff --git a/specification/_json_spec/tasks.cancel.json b/specification/_json_spec/tasks.cancel.json index a52ee00f6a..96ad580d6b 100644 --- a/specification/_json_spec/tasks.cancel.json +++ b/specification/_json_spec/tasks.cancel.json @@ -1,8 +1,8 @@ { "tasks.cancel": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", - "description": "Cancels a task, if it can be cancelled through an API." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", + "description": "Cancel a task" }, "stability": "experimental", "visibility": "public", @@ -42,6 +42,7 @@ }, "wait_for_completion": { "type": "boolean", + "default": false, "description": "Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false" } } diff --git a/specification/_json_spec/tasks.get.json b/specification/_json_spec/tasks.get.json index ddcd23d4f1..a90f45f833 100644 --- a/specification/_json_spec/tasks.get.json +++ b/specification/_json_spec/tasks.get.json @@ -1,8 +1,8 @@ { "tasks.get": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", - "description": "Returns information about a task." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", + "description": "Get task information" }, "stability": "experimental", "visibility": "public", @@ -26,10 +26,12 @@ "params": { "wait_for_completion": { "type": "boolean", + "default": false, "description": "Wait for the matching tasks to complete (default: false)" }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/tasks.list.json b/specification/_json_spec/tasks.list.json index 16ad12373f..ee78def8c7 100644 --- a/specification/_json_spec/tasks.list.json +++ b/specification/_json_spec/tasks.list.json @@ -1,8 +1,8 @@ { "tasks.list": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html", - "description": "Returns a list of tasks." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", + "description": "Get all tasks" }, "stability": "experimental", "visibility": "public", @@ -28,6 +28,7 @@ }, "detailed": { "type": "boolean", + "default": false, "description": "Return detailed task information (default: false)" }, "parent_task_id": { @@ -36,6 +37,7 @@ }, "wait_for_completion": { "type": "boolean", + "default": false, "description": "Wait for the matching tasks to complete (default: false)" }, "group_by": { @@ -46,6 +48,7 @@ }, "timeout": { "type": "time", + "default": "30s", "description": "Explicit operation timeout" } } diff --git a/specification/_json_spec/terms_enum.json b/specification/_json_spec/terms_enum.json index e8018491f9..c2c3c4b5d3 100644 --- a/specification/_json_spec/terms_enum.json +++ b/specification/_json_spec/terms_enum.json @@ -1,8 +1,8 @@ { "terms_enum": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", - "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum", + "description": "Get terms in an index" }, "stability": "stable", "visibility": "public", @@ -24,9 +24,9 @@ } ] }, - "params": {}, "body": { - "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results" + "description": "field name, string which is the prefix expected in matching terms, timeout and size for max number of results", + "required": true } } } diff --git a/specification/_json_spec/termvectors.json b/specification/_json_spec/termvectors.json index 49372051cf..8037e04099 100644 --- a/specification/_json_spec/termvectors.json +++ b/specification/_json_spec/termvectors.json @@ -1,8 +1,8 @@ { "termvectors": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", - "description": "Returns information and statistics about terms in the fields of a particular document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors", + "description": "Get term vector information" }, "stability": "stable", "visibility": "public", @@ -78,10 +78,11 @@ }, "realtime": { "type": "boolean", + "default": true, "description": "Specifies if request is real-time as opposed to near-real-time (default: true)." }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "version_type": { diff --git a/specification/_json_spec/text_structure.find_field_structure.json b/specification/_json_spec/text_structure.find_field_structure.json index 9bbf183de9..f4ffbc6728 100644 --- a/specification/_json_spec/text_structure.find_field_structure.json +++ b/specification/_json_spec/text_structure.find_field_structure.json @@ -1,8 +1,8 @@ { "text_structure.find_field_structure": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html", - "description": "Finds the structure of a text field in an index." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-text_structure", + "description": "Find the structure of a text field" }, "stability": "stable", "visibility": "public", @@ -65,6 +65,7 @@ }, "ecs_compatibility": { "type": "string", + "default": "disabled", "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" }, "timestamp_field": { diff --git a/specification/_json_spec/text_structure.find_message_structure.json b/specification/_json_spec/text_structure.find_message_structure.json index db4d552cb4..824415ec08 100644 --- a/specification/_json_spec/text_structure.find_message_structure.json +++ b/specification/_json_spec/text_structure.find_message_structure.json @@ -1,8 +1,8 @@ { "text_structure.find_message_structure": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html", - "description": "Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure", + "description": "Find the structure of text messages" }, "stability": "stable", "visibility": "public", @@ -51,6 +51,7 @@ }, "ecs_compatibility": { "type": "string", + "default": "disabled", "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" }, "timestamp_field": { diff --git a/specification/_json_spec/text_structure.find_structure.json b/specification/_json_spec/text_structure.find_structure.json index 16e082de71..1d6c137a5d 100644 --- a/specification/_json_spec/text_structure.find_structure.json +++ b/specification/_json_spec/text_structure.find_structure.json @@ -1,8 +1,8 @@ { "text_structure.find_structure": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", - "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure", + "description": "Find the structure of a text file" }, "stability": "stable", "visibility": "public", @@ -69,6 +69,7 @@ }, "ecs_compatibility": { "type": "string", + "default": "disabled", "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" }, "timestamp_field": { diff --git a/specification/_json_spec/text_structure.test_grok_pattern.json b/specification/_json_spec/text_structure.test_grok_pattern.json index b291ce6b87..811c20004b 100644 --- a/specification/_json_spec/text_structure.test_grok_pattern.json +++ b/specification/_json_spec/text_structure.test_grok_pattern.json @@ -1,8 +1,8 @@ { "text_structure.test_grok_pattern": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html", - "description": "Tests a Grok pattern on some text." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern", + "description": "Test a Grok pattern" }, "stability": "stable", "visibility": "public", @@ -21,6 +21,7 @@ "params": { "ecs_compatibility": { "type": "string", + "default": "disabled", "description": "Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'" } }, diff --git a/specification/_json_spec/transform.delete_transform.json b/specification/_json_spec/transform.delete_transform.json index f7229553a6..1ab585f616 100644 --- a/specification/_json_spec/transform.delete_transform.json +++ b/specification/_json_spec/transform.delete_transform.json @@ -1,8 +1,8 @@ { "transform.delete_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", - "description": "Deletes an existing transform." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform", + "description": "Delete a transform" }, "stability": "stable", "visibility": "public", @@ -26,17 +26,17 @@ "params": { "force": { "type": "boolean", - "required": false, + "default": false, "description": "When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted." }, "delete_dest_index": { "type": "boolean", - "required": false, + "default": false, "description": "When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted." }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait for the transform deletion" } } diff --git a/specification/_json_spec/transform.get_node_stats.json b/specification/_json_spec/transform.get_node_stats.json index 335cbb557b..2b284b6502 100644 --- a/specification/_json_spec/transform.get_node_stats.json +++ b/specification/_json_spec/transform.get_node_stats.json @@ -2,7 +2,7 @@ "transform.get_node_stats": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html", - "description": "Retrieves transform usage information for transform nodes." + "description": "Retrieves transform usage information for transform nodes" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/transform.get_transform.json b/specification/_json_spec/transform.get_transform.json index ecc8645acd..b9791d415b 100644 --- a/specification/_json_spec/transform.get_transform.json +++ b/specification/_json_spec/transform.get_transform.json @@ -1,8 +1,8 @@ { "transform.get_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", - "description": "Retrieves configuration information for transforms." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform", + "description": "Get transforms" }, "stability": "stable", "visibility": "public", @@ -30,21 +30,20 @@ "params": { "from": { "type": "int", - "required": false, + "default": 0, "description": "skips a number of transform configs, defaults to 0" }, "size": { "type": "int", - "required": false, + "default": 100, "description": "specifies a max number of transforms to get, defaults to 100" }, "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" }, "exclude_generated": { - "required": false, "type": "boolean", "default": false, "description": "Omits fields that are illegal to set on transform PUT" diff --git a/specification/_json_spec/transform.get_transform_stats.json b/specification/_json_spec/transform.get_transform_stats.json index 685dc9b880..8985eecfef 100644 --- a/specification/_json_spec/transform.get_transform_stats.json +++ b/specification/_json_spec/transform.get_transform_stats.json @@ -1,8 +1,8 @@ { "transform.get_transform_stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", - "description": "Retrieves usage information for transforms." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats", + "description": "Get transform stats" }, "stability": "stable", "visibility": "public", @@ -25,23 +25,22 @@ }, "params": { "from": { - "type": "number", - "required": false, + "type": "long", + "default": 0, "description": "skips a number of transform stats, defaults to 0" }, "size": { - "type": "number", - "required": false, + "type": "long", + "default": 100, "description": "specifies a max number of transform stats to get, defaults to 100" }, "timeout": { "type": "time", - "required": false, "description": "Controls the time to wait for the stats" }, "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" } } diff --git a/specification/_json_spec/transform.preview_transform.json b/specification/_json_spec/transform.preview_transform.json index 6ea0764d4a..70f1c9cc32 100644 --- a/specification/_json_spec/transform.preview_transform.json +++ b/specification/_json_spec/transform.preview_transform.json @@ -1,8 +1,8 @@ { "transform.preview_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", - "description": "Previews a transform." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform", + "description": "Preview a transform" }, "stability": "stable", "visibility": "public", @@ -31,7 +31,7 @@ "params": { "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait for the preview" } }, diff --git a/specification/_json_spec/transform.put_transform.json b/specification/_json_spec/transform.put_transform.json index 79214c0b0b..178ae3791b 100644 --- a/specification/_json_spec/transform.put_transform.json +++ b/specification/_json_spec/transform.put_transform.json @@ -1,8 +1,8 @@ { "transform.put_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", - "description": "Instantiates a transform." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform", + "description": "Create a transform" }, "stability": "stable", "visibility": "public", @@ -27,12 +27,12 @@ "params": { "defer_validation": { "type": "boolean", - "required": false, + "default": false, "description": "If validations should be deferred until transform starts, defaults to false." }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait for the transform to start" } }, diff --git a/specification/_json_spec/transform.reset_transform.json b/specification/_json_spec/transform.reset_transform.json index 2d43de70a0..dedc512e12 100644 --- a/specification/_json_spec/transform.reset_transform.json +++ b/specification/_json_spec/transform.reset_transform.json @@ -1,8 +1,8 @@ { "transform.reset_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", - "description": "Resets an existing transform." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform", + "description": "Reset a transform" }, "stability": "stable", "visibility": "public", @@ -26,12 +26,12 @@ "params": { "force": { "type": "boolean", - "required": false, + "default": false, "description": "When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset." }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait for the transform to reset" } } diff --git a/specification/_json_spec/transform.schedule_now_transform.json b/specification/_json_spec/transform.schedule_now_transform.json index 86440271ac..803a8af112 100644 --- a/specification/_json_spec/transform.schedule_now_transform.json +++ b/specification/_json_spec/transform.schedule_now_transform.json @@ -1,8 +1,8 @@ { "transform.schedule_now_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", - "description": "Schedules now a transform." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform", + "description": "Schedule a transform to start now" }, "stability": "stable", "visibility": "public", @@ -28,7 +28,7 @@ "params": { "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait for the scheduling to take place" } } diff --git a/specification/_json_spec/transform.set_upgrade_mode.json b/specification/_json_spec/transform.set_upgrade_mode.json new file mode 100644 index 0000000000..d34690ffb1 --- /dev/null +++ b/specification/_json_spec/transform.set_upgrade_mode.json @@ -0,0 +1,33 @@ +{ + "transform.set_upgrade_mode": { + "documentation": { + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode", + "description": "Set upgrade_mode for transform indices" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_transform/set_upgrade_mode", + "methods": ["POST"] + } + ] + }, + "params": { + "enabled": { + "type": "boolean", + "default": false, + "description": "Whether to enable upgrade_mode Transform setting or not. Defaults to false." + }, + "timeout": { + "type": "time", + "default": "30s", + "description": "Controls the time to wait before action times out. Defaults to 30 seconds" + } + } + } +} diff --git a/specification/_json_spec/transform.start_transform.json b/specification/_json_spec/transform.start_transform.json index b7ff41d3be..986f9bb223 100644 --- a/specification/_json_spec/transform.start_transform.json +++ b/specification/_json_spec/transform.start_transform.json @@ -1,8 +1,8 @@ { "transform.start_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", - "description": "Starts one or more transforms." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform", + "description": "Start a transform" }, "stability": "stable", "visibility": "public", @@ -26,12 +26,11 @@ "params": { "from": { "type": "string", - "required": false, "description": "Restricts the set of transformed entities to those changed after this time" }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait for the transform to start" } } diff --git a/specification/_json_spec/transform.stop_transform.json b/specification/_json_spec/transform.stop_transform.json index e031ca85ee..bede6777a5 100644 --- a/specification/_json_spec/transform.stop_transform.json +++ b/specification/_json_spec/transform.stop_transform.json @@ -1,8 +1,8 @@ { "transform.stop_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", - "description": "Stops one or more transforms." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform", + "description": "Stop transforms" }, "stability": "stable", "visibility": "public", @@ -26,27 +26,27 @@ "params": { "force": { "type": "boolean", - "required": false, + "default": false, "description": "Whether to force stop a failed transform or not. Default to false" }, "wait_for_completion": { "type": "boolean", - "required": false, + "default": false, "description": "Whether to wait for the transform to fully stop before returning or not. Default to false" }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait until the transform has stopped. Default to 30 seconds" }, "allow_no_match": { "type": "boolean", - "required": false, + "default": true, "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)" }, "wait_for_checkpoint": { "type": "boolean", - "required": false, + "default": false, "description": "Whether to wait for the transform to reach a checkpoint before stopping. Default to false" } } diff --git a/specification/_json_spec/transform.update_transform.json b/specification/_json_spec/transform.update_transform.json index 47ef2d4126..2ff351cd53 100644 --- a/specification/_json_spec/transform.update_transform.json +++ b/specification/_json_spec/transform.update_transform.json @@ -1,8 +1,8 @@ { "transform.update_transform": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", - "description": "Updates certain properties of a transform." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform", + "description": "Update a transform" }, "stability": "stable", "visibility": "public", @@ -28,12 +28,11 @@ "params": { "defer_validation": { "type": "boolean", - "required": false, "description": "If validations should be deferred until transform starts, defaults to false." }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait for the update" } }, diff --git a/specification/_json_spec/transform.upgrade_transforms.json b/specification/_json_spec/transform.upgrade_transforms.json index 55dc5a3679..949d9ba508 100644 --- a/specification/_json_spec/transform.upgrade_transforms.json +++ b/specification/_json_spec/transform.upgrade_transforms.json @@ -1,8 +1,8 @@ { "transform.upgrade_transforms": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", - "description": "Upgrades all transforms." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms", + "description": "Upgrade all transforms" }, "stability": "stable", "visibility": "public", @@ -21,12 +21,12 @@ "params": { "dry_run": { "type": "boolean", - "required": false, + "default": false, "description": "Whether to only check for updates but don't execute" }, "timeout": { "type": "time", - "required": false, + "default": "30s", "description": "Controls the time to wait for the upgrade" } } diff --git a/specification/_json_spec/update.json b/specification/_json_spec/update.json index de6ce04872..7fd6785106 100644 --- a/specification/_json_spec/update.json +++ b/specification/_json_spec/update.json @@ -1,8 +1,8 @@ { "update": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", - "description": "Updates a document with a script or partial document." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update", + "description": "Update a document" }, "stability": "stable", "visibility": "public", @@ -31,10 +31,12 @@ "params": { "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the update 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)" }, "_source": { "type": "list", + "default": "true", "description": "True or false to return the _source field or not, or a list of fields to return" }, "_source_excludes": { @@ -47,15 +49,18 @@ }, "lang": { "type": "string", + "default": "painless", "description": "The script language (default: painless)" }, "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." }, "retry_on_conflict": { - "type": "number", + "type": "int", + "default": 0, "description": "Specify how many times should the operation be retried when a conflict occurs (default: 0)" }, "routing": { @@ -64,22 +69,25 @@ }, "timeout": { "type": "time", + "default": "1m", "description": "Explicit operation timeout" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only perform the update operation if the last operation that has changed the document has the specified primary term" }, "require_alias": { "type": "boolean", + "default": false, "description": "When true, requires destination is an alias. Default is 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." } }, diff --git a/specification/_json_spec/update_by_query.json b/specification/_json_spec/update_by_query.json index 3856c4249a..325feca2b1 100644 --- a/specification/_json_spec/update_by_query.json +++ b/specification/_json_spec/update_by_query.json @@ -1,8 +1,8 @@ { "update_by_query": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", - "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query", + "description": "Update documents" }, "stability": "stable", "visibility": "public", @@ -31,12 +31,13 @@ }, "analyze_wildcard": { "type": "boolean", + "default": false, "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)" }, "default_operator": { "type": "enum", - "options": ["AND", "OR"], - "default": "OR", + "options": ["and", "or"], + "default": "or", "description": "The default operator for query string query (AND or OR)" }, "df": { @@ -44,15 +45,18 @@ "description": "The field to use as default where no field prefix is given in the query string" }, "from": { - "type": "number", + "type": "long", + "default": 0, "description": "Starting offset (default: 0)" }, "ignore_unavailable": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)" }, "allow_no_indices": { "type": "boolean", + "default": true, "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)" }, "conflicts": { @@ -69,6 +73,7 @@ }, "lenient": { "type": "boolean", + "default": false, "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored" }, "pipeline": { @@ -89,6 +94,7 @@ }, "scroll": { "type": "time", + "default": "5m", "description": "Specify how long a consistent view of the index should be maintained for scrolled search" }, "search_type": { @@ -101,7 +107,7 @@ "description": "Explicit timeout for each search request. Defaults to no timeout." }, "max_docs": { - "type": "number", + "type": "long", "description": "Maximum number of documents to process (default: all documents)" }, "sort": { @@ -109,7 +115,7 @@ "description": "A comma-separated list of : pairs" }, "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": { @@ -130,6 +136,7 @@ }, "refresh": { "type": "boolean", + "default": false, "description": "Should the affected indexes be refreshed?" }, "timeout": { @@ -139,11 +146,12 @@ }, "wait_for_active_shards": { "type": "string", + "default": "1", "description": "Sets the number of shard copies that must be active before proceeding with the update by query 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)" }, "scroll_size": { - "type": "number", - "default": 100, + "type": "long", + "default": 1000, "description": "Size on the scroll request powering the update by query" }, "wait_for_completion": { @@ -153,7 +161,7 @@ }, "requests_per_second": { "type": "number", - "default": 0, + "default": -1, "description": "The throttle to set on this request in sub-requests per second. -1 means no throttle." }, "slices": { @@ -163,7 +171,8 @@ } }, "body": { - "description": "The search definition using the Query DSL" + "description": "The search definition using the Query DSL", + "required": false } } } diff --git a/specification/_json_spec/update_by_query_rethrottle.json b/specification/_json_spec/update_by_query_rethrottle.json index c92f04fdcb..db0d092456 100644 --- a/specification/_json_spec/update_by_query_rethrottle.json +++ b/specification/_json_spec/update_by_query_rethrottle.json @@ -1,8 +1,8 @@ { "update_by_query_rethrottle": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", - "description": "Changes the number of requests per second for a particular Update By Query operation." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle", + "description": "Throttle an update by query operation" }, "stability": "stable", "visibility": "public", @@ -27,6 +27,7 @@ "requests_per_second": { "type": "number", "required": true, + "default": -1, "description": "The throttle to set on this request in floating sub-requests per second. -1 means set no throttle." } } diff --git a/specification/_json_spec/watcher.ack_watch.json b/specification/_json_spec/watcher.ack_watch.json index 5e6e46954e..a0b04e3ba4 100644 --- a/specification/_json_spec/watcher.ack_watch.json +++ b/specification/_json_spec/watcher.ack_watch.json @@ -1,8 +1,8 @@ { "watcher.ack_watch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", - "description": "Acknowledges a watch, manually throttling the execution of the watch's actions." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch", + "description": "Acknowledge a watch" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/watcher.activate_watch.json b/specification/_json_spec/watcher.activate_watch.json index e64e409315..724b3d0d56 100644 --- a/specification/_json_spec/watcher.activate_watch.json +++ b/specification/_json_spec/watcher.activate_watch.json @@ -1,8 +1,8 @@ { "watcher.activate_watch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", - "description": "Activates a currently inactive watch." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch", + "description": "Activate a watch" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/watcher.deactivate_watch.json b/specification/_json_spec/watcher.deactivate_watch.json index e20e2504b2..362abbb533 100644 --- a/specification/_json_spec/watcher.deactivate_watch.json +++ b/specification/_json_spec/watcher.deactivate_watch.json @@ -1,8 +1,8 @@ { "watcher.deactivate_watch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", - "description": "Deactivates a currently active watch." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch", + "description": "Deactivate a watch" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/watcher.delete_watch.json b/specification/_json_spec/watcher.delete_watch.json index 963eb038c3..9084a06514 100644 --- a/specification/_json_spec/watcher.delete_watch.json +++ b/specification/_json_spec/watcher.delete_watch.json @@ -1,8 +1,8 @@ { "watcher.delete_watch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", - "description": "Removes a watch from Watcher." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch", + "description": "Delete a watch" }, "stability": "stable", "visibility": "public", diff --git a/specification/_json_spec/watcher.execute_watch.json b/specification/_json_spec/watcher.execute_watch.json index 7b41a8383b..2dd77afe37 100644 --- a/specification/_json_spec/watcher.execute_watch.json +++ b/specification/_json_spec/watcher.execute_watch.json @@ -1,8 +1,8 @@ { "watcher.execute_watch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", - "description": "Forces the execution of a stored watch." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch", + "description": "Run a watch" }, "stability": "stable", "visibility": "public", @@ -31,8 +31,8 @@ "params": { "debug": { "type": "boolean", - "description": "indicates whether the watch should execute in debug mode", - "required": false + "default": false, + "description": "indicates whether the watch should execute in debug mode" } }, "body": { diff --git a/specification/_json_spec/watcher.get_settings.json b/specification/_json_spec/watcher.get_settings.json index 965dc4891b..8e68f9bc41 100644 --- a/specification/_json_spec/watcher.get_settings.json +++ b/specification/_json_spec/watcher.get_settings.json @@ -1,8 +1,8 @@ { "watcher.get_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html", - "description": "Retrieve settings for the watcher system index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings", + "description": "Get Watcher index settings" }, "stability": "stable", "visibility": "public", @@ -21,6 +21,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/watcher.get_watch.json b/specification/_json_spec/watcher.get_watch.json index 8182fca0b2..483c2924b6 100644 --- a/specification/_json_spec/watcher.get_watch.json +++ b/specification/_json_spec/watcher.get_watch.json @@ -1,8 +1,8 @@ { "watcher.get_watch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", - "description": "Retrieves a watch by its ID." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch", + "description": "Get a watch" }, "stability": "stable", "visibility": "public", @@ -22,7 +22,6 @@ } } ] - }, - "params": {} + } } } diff --git a/specification/_json_spec/watcher.put_watch.json b/specification/_json_spec/watcher.put_watch.json index 3abdfbd45f..aab3cebcbf 100644 --- a/specification/_json_spec/watcher.put_watch.json +++ b/specification/_json_spec/watcher.put_watch.json @@ -1,8 +1,8 @@ { "watcher.put_watch": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", - "description": "Creates a new watch, or updates an existing one." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch", + "description": "Create or update a watch" }, "stability": "stable", "visibility": "public", @@ -27,24 +27,25 @@ "params": { "active": { "type": "boolean", + "default": true, "description": "Specify whether the watch is in/active by default" }, "version": { - "type": "number", + "type": "long", "description": "Explicit version number for concurrency control" }, "if_seq_no": { - "type": "number", + "type": "long", "description": "only update the watch if the last operation that has changed the watch has the specified sequence number" }, "if_primary_term": { - "type": "number", + "type": "long", "description": "only update the watch if the last operation that has changed the watch has the specified primary term" } }, "body": { "description": "The watch", - "required": false + "required": true } } } diff --git a/specification/_json_spec/watcher.query_watches.json b/specification/_json_spec/watcher.query_watches.json index 83d13dab69..7f989e7722 100644 --- a/specification/_json_spec/watcher.query_watches.json +++ b/specification/_json_spec/watcher.query_watches.json @@ -1,8 +1,8 @@ { "watcher.query_watches": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", - "description": "Retrieves stored watches." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches", + "description": "Query watches" }, "stability": "stable", "visibility": "public", @@ -18,7 +18,6 @@ } ] }, - "params": {}, "body": { "description": "From, size, query, sort and search_after", "required": false diff --git a/specification/_json_spec/watcher.start.json b/specification/_json_spec/watcher.start.json index 069adfd98f..3e85fb7ad0 100644 --- a/specification/_json_spec/watcher.start.json +++ b/specification/_json_spec/watcher.start.json @@ -1,8 +1,8 @@ { "watcher.start": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", - "description": "Starts Watcher if it is not already running." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start", + "description": "Start the watch service" }, "stability": "stable", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/watcher.stats.json b/specification/_json_spec/watcher.stats.json index 98758a0404..335ffd3cc4 100644 --- a/specification/_json_spec/watcher.stats.json +++ b/specification/_json_spec/watcher.stats.json @@ -1,8 +1,8 @@ { "watcher.stats": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", - "description": "Retrieves the current Watcher metrics." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stats", + "description": "Get Watcher statistics" }, "stability": "stable", "visibility": "public", @@ -46,8 +46,8 @@ }, "emit_stacktraces": { "type": "boolean", - "description": "Emits stack traces of currently running watches", - "required": false + "default": false, + "description": "Emits stack traces of currently running watches" } } } diff --git a/specification/_json_spec/watcher.stop.json b/specification/_json_spec/watcher.stop.json index 7767a55daf..b0c379ccf3 100644 --- a/specification/_json_spec/watcher.stop.json +++ b/specification/_json_spec/watcher.stop.json @@ -1,8 +1,8 @@ { "watcher.stop": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", - "description": "Stops Watcher if it is running." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop", + "description": "Stop the watch service" }, "stability": "stable", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } } diff --git a/specification/_json_spec/watcher.update_settings.json b/specification/_json_spec/watcher.update_settings.json index 2958e15e81..f23ac7ccf4 100644 --- a/specification/_json_spec/watcher.update_settings.json +++ b/specification/_json_spec/watcher.update_settings.json @@ -1,8 +1,8 @@ { "watcher.update_settings": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html", - "description": "Update settings for the watcher system index" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings", + "description": "Update Watcher index settings" }, "stability": "stable", "visibility": "public", @@ -25,6 +25,7 @@ }, "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for connection to master" } }, diff --git a/specification/_json_spec/xpack.info.json b/specification/_json_spec/xpack.info.json index d98ff6563b..b1e11ae4cc 100644 --- a/specification/_json_spec/xpack.info.json +++ b/specification/_json_spec/xpack.info.json @@ -1,8 +1,8 @@ { "xpack.info": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", - "description": "Retrieves information about the installed X-Pack features." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info", + "description": "Get information" }, "stability": "stable", "visibility": "public", @@ -20,7 +20,6 @@ "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 }, diff --git a/specification/_json_spec/xpack.usage.json b/specification/_json_spec/xpack.usage.json index 3e6fe3537d..4fe4a77499 100644 --- a/specification/_json_spec/xpack.usage.json +++ b/specification/_json_spec/xpack.usage.json @@ -1,8 +1,8 @@ { "xpack.usage": { "documentation": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", - "description": "Retrieves usage information about the installed X-Pack features." + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack", + "description": "Get usage information" }, "stability": "stable", "visibility": "public", @@ -20,6 +20,7 @@ "params": { "master_timeout": { "type": "time", + "default": "30s", "description": "Specify timeout for watch write operation" } } diff --git a/specification/snapshot/get/SnapshotGetRequest.ts b/specification/snapshot/get/SnapshotGetRequest.ts index a3fb758f89..adf5dfddab 100644 --- a/specification/snapshot/get/SnapshotGetRequest.ts +++ b/specification/snapshot/get/SnapshotGetRequest.ts @@ -22,7 +22,6 @@ import { Name, Names } from '@_types/common' import { integer } from '@_types/Numeric' import { SortOrder } from '@_types/sort' import { Duration } from '@_types/Time' -import { SnapshotSort } from '@snapshot/_types/SnapshotInfo' /** * Get snapshot information.