diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 764839482c..2526aafad3 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -1904,7 +1904,7 @@ "stability": "stable" } }, - "description": "Returns number of documents matching a query.", + "description": "Count search results.\nGet the number of documents matching a query.", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "name": "count", @@ -2135,7 +2135,7 @@ "stability": "stable" } }, - "description": "Creates the enrich index for an existing enrich policy.", + "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", "docId": "execute-enrich-policy-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html", "name": "enrich.execute_policy", @@ -2286,7 +2286,7 @@ "stability": "stable" } }, - "description": "Deletes an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", + "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "name": "eql.delete", "request": { @@ -2321,7 +2321,7 @@ "stability": "stable" } }, - "description": "Returns the current status and available results for an async EQL search or a stored synchronous EQL search.", + "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "docId": "eql-async-search-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", "name": "eql.get", @@ -2357,7 +2357,7 @@ "stability": "stable" } }, - "description": "Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.", + "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "docId": "eql-async-search-status-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", "name": "eql.get_status", @@ -2393,8 +2393,10 @@ "stability": "stable" } }, - "description": "Returns results matching a query expressed in Event Query Language (EQL)", + "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", + "extDocId": "eql", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html", "name": "eql.search", "request": { "name": "Request", @@ -2428,9 +2430,11 @@ "since": "8.11.0" } }, - "description": "Executes an ES|QL request", + "description": "Run an ES|QL query.\nGet search results for an ES|QL (Elasticsearch query language) query.", "docId": "esql-query", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html", + "extDocId": "esql", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html", "name": "esql.query", "request": { "name": "Request", @@ -2735,9 +2739,11 @@ "stability": "stable" } }, - "description": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.", + "description": "Explore graph analytics.\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "docId": "graph-explore-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html", + "extDocId": "graph", + "extDocUrl": "https://www.elastic.co/guide/en/kibana/{branch}/xpack-graph.html", "name": "graph.explore", "request": { "name": "Request", @@ -3296,7 +3302,7 @@ "stability": "stable" } }, - "description": "Returns information about whether a particular index template exists.", + "description": "Check index templates.\nCheck whether index templates exist.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", "name": "indices.exists_index_template", "request": { @@ -4055,7 +4061,7 @@ "stability": "stable" } }, - "description": "Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", + "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", "name": "indices.resolve_index", "request": { @@ -4520,8 +4526,10 @@ "stability": "stable" } }, - "description": "Deletes one or more existing ingest pipeline.", + "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", + "extDocId": "ingest", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.delete_pipeline", "request": { "name": "Request", @@ -4555,8 +4563,10 @@ "stability": "stable" } }, - "description": "Returns information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", + "extDocId": "ingest", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.get_pipeline", "request": { "name": "Request", @@ -4596,9 +4606,11 @@ "stability": "stable" } }, - "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", + "extDocId": "grok-processor", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "name": "ingest.processor_grok", "request": { "name": "Request", @@ -4632,9 +4644,11 @@ "stability": "stable" } }, - "description": "Creates or updates an ingest pipeline.\nChanges made using this API take effect immediately.", + "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", "docId": "ingest", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", + "extDocId": "ingest", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.put_pipeline", "request": { "name": "Request", @@ -4671,7 +4685,7 @@ "stability": "stable" } }, - "description": "Executes an ingest pipeline against a set of provided documents.", + "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", "name": "ingest.simulate", "request": { @@ -7472,7 +7486,7 @@ "stability": "stable" } }, - "description": "Ping the cluster.\nReturns whether the cluster is running.", + "description": "Ping the cluster.\nGet information about whether the cluster is running.", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "ping", @@ -7554,7 +7568,7 @@ "stability": "stable" } }, - "description": "Deletes a query rule within a query ruleset.", + "description": "Delete a query rule.\nDelete a query rule within a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html", "name": "query_rules.delete_rule", "request": { @@ -7589,7 +7603,7 @@ "stability": "stable" } }, - "description": "Deletes a query ruleset.", + "description": "Delete a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html", "name": "query_rules.delete_ruleset", "request": { @@ -7624,8 +7638,10 @@ "stability": "stable" } }, - "description": "Returns the details about a query rule within a query ruleset", + "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html", + "extDocId": "query-rule", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html", "name": "query_rules.get_rule", "request": { "name": "Request", @@ -7659,7 +7675,7 @@ "stability": "stable" } }, - "description": "Returns the details about a query ruleset", + "description": "Get a query ruleset.\nGet details about a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html", "name": "query_rules.get_ruleset", "request": { @@ -7694,7 +7710,7 @@ "stability": "stable" } }, - "description": "Returns summarized information about existing query rulesets.", + "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html", "name": "query_rules.list_rulesets", "request": { @@ -7729,7 +7745,7 @@ "stability": "stable" } }, - "description": "Creates or updates a query rule within a query ruleset.", + "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html", "name": "query_rules.put_rule", "request": { @@ -7767,8 +7783,10 @@ "stability": "stable" } }, - "description": "Creates or updates a query ruleset.", + "description": "Create or update a query ruleset.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html", + "extDocId": "query-rule", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html", "name": "query_rules.put_ruleset", "request": { "name": "Request", @@ -7805,7 +7823,7 @@ "stability": "stable" } }, - "description": "Creates or updates a query ruleset.", + "description": "Test a query ruleset.\nEvaluate match criteria against a query ruleset to identify the rules that would match that criteria.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html", "name": "query_rules.test", "request": { @@ -8807,7 +8825,7 @@ "stability": "stable" } }, - "description": "Clears the SQL cursor", + "description": "Clear an SQL search cursor.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", "name": "sql.clear_cursor", "request": { @@ -8845,7 +8863,7 @@ "stability": "stable" } }, - "description": "Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.", + "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", "name": "sql.delete_async", "request": { @@ -8880,7 +8898,7 @@ "stability": "stable" } }, - "description": "Returns the current status and available results for an async SQL search or stored synchronous SQL search", + "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", "name": "sql.get_async", "request": { @@ -8915,7 +8933,7 @@ "stability": "stable" } }, - "description": "Returns the current status of an async SQL search or a stored synchronous SQL search", + "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", "name": "sql.get_async_status", "request": { @@ -8950,7 +8968,7 @@ "stability": "stable" } }, - "description": "Executes a SQL request", + "description": "Get SQL search results.\nRun an SQL request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", "name": "sql.query", "request": { @@ -8989,7 +9007,7 @@ "stability": "stable" } }, - "description": "Translates SQL into Elasticsearch queries", + "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", "name": "sql.translate", "request": { @@ -9028,7 +9046,7 @@ "stability": "stable" } }, - "description": "Deletes a synonym set", + "description": "Delete a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html", "name": "synonyms.delete_synonym", "request": { @@ -9063,7 +9081,7 @@ "stability": "stable" } }, - "description": "Deletes a synonym rule in a synonym set", + "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html", "name": "synonyms.delete_synonym_rule", "request": { @@ -9101,7 +9119,7 @@ "stability": "stable" } }, - "description": "Retrieves a synonym set", + "description": "Get a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html", "name": "synonyms.get_synonym", "request": { @@ -9136,7 +9154,7 @@ "stability": "stable" } }, - "description": "Retrieves a synonym rule from a synonym set", + "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html", "name": "synonyms.get_synonym_rule", "request": { @@ -9174,7 +9192,7 @@ "stability": "stable" } }, - "description": "Retrieves a summary of all defined synonym sets", + "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html", "name": "synonyms.get_synonyms_sets", "request": { @@ -9209,7 +9227,7 @@ "stability": "stable" } }, - "description": "Creates or updates a synonym set.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html", "name": "synonyms.put_synonym", "request": { @@ -9247,7 +9265,7 @@ "stability": "stable" } }, - "description": "Creates or updates a synonym rule in a synonym set", + "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html", "name": "synonyms.put_synonym_rule", "request": { @@ -15255,7 +15273,7 @@ } ] }, - "description": "Returns number of documents matching a query.", + "description": "Count search results.\nGet the number of documents matching a query.", "inherits": { "type": { "name": "RequestBase", @@ -15457,7 +15475,7 @@ } } ], - "specLocation": "_global/count/CountRequest.ts#L26-L121" + "specLocation": "_global/count/CountRequest.ts#L26-L123" }, { "body": { @@ -16661,7 +16679,7 @@ "body": { "kind": "no_body" }, - "description": "Creates the enrich index for an existing enrich policy.", + "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", "inherits": { "type": { "name": "RequestBase", @@ -16702,7 +16720,7 @@ } } ], - "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L23-L44" + "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L23-L45" }, { "body": { @@ -16988,7 +17006,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", + "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "inherits": { "type": { "name": "RequestBase", @@ -17015,7 +17033,7 @@ } ], "query": [], - "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L39" + "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L40" }, { "body": { @@ -17042,7 +17060,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the current status and available results for an async EQL search or a stored synchronous EQL search.", + "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "inherits": { "type": { "name": "RequestBase", @@ -17094,7 +17112,7 @@ } } ], - "specLocation": "eql/get/EqlGetRequest.ts#L24-L50" + "specLocation": "eql/get/EqlGetRequest.ts#L24-L51" }, { "body": { @@ -17136,7 +17154,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.", + "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "inherits": { "type": { "name": "RequestBase", @@ -17163,7 +17181,7 @@ } ], "query": [], - "specLocation": "eql/get_status/EqlGetStatusRequest.ts#L23-L35" + "specLocation": "eql/get_status/EqlGetStatusRequest.ts#L23-L36" }, { "body": { @@ -17484,7 +17502,7 @@ } ] }, - "description": "Returns results matching a query expressed in Event Query Language (EQL)", + "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "inherits": { "type": { "name": "RequestBase", @@ -17587,7 +17605,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L118" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L122" }, { "body": { @@ -17741,7 +17759,7 @@ } ] }, - "description": "Executes an ES|QL request", + "description": "Run an ES|QL query.\nGet search results for an ES|QL (Elasticsearch query language) query.", "inherits": { "type": { "name": "RequestBase", @@ -17793,7 +17811,7 @@ } } ], - "specLocation": "esql/query/QueryRequest.ts#L26-L89" + "specLocation": "esql/query/QueryRequest.ts#L26-L91" }, { "body": { @@ -19332,7 +19350,7 @@ } ] }, - "description": "Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.", + "description": "Explore graph analytics.\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "inherits": { "type": { "name": "RequestBase", @@ -19384,7 +19402,7 @@ } } ], - "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L72" + "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L78" }, { "body": { @@ -21150,7 +21168,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about whether a particular index template exists.", + "description": "Check index templates.\nCheck whether index templates exist.", "inherits": { "type": { "name": "RequestBase", @@ -21191,7 +21209,7 @@ } } ], - "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L41" + "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L43" }, { "body": { @@ -23709,7 +23727,7 @@ "body": { "kind": "no_body" }, - "description": "Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", + "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "inherits": { "type": { "name": "RequestBase", @@ -23776,7 +23794,7 @@ } } ], - "specLocation": "indices/resolve_index/ResolveIndexRequest.ts#L23-L60" + "specLocation": "indices/resolve_index/ResolveIndexRequest.ts#L23-L61" }, { "body": { @@ -25290,7 +25308,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes one or more existing ingest pipeline.", + "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "inherits": { "type": { "name": "RequestBase", @@ -25344,7 +25362,7 @@ } } ], - "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L52" + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L54" }, { "body": { @@ -25371,7 +25389,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -25425,7 +25443,7 @@ } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L50" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L52" }, { "body": { @@ -25463,7 +25481,7 @@ "body": { "kind": "no_body" }, - "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "inherits": { "type": { "name": "RequestBase", @@ -25477,7 +25495,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L31" + "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L33" }, { "body": { @@ -25602,7 +25620,7 @@ } ] }, - "description": "Creates or updates an ingest pipeline.\nChanges made using this API take effect immediately.", + "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", "inherits": { "type": { "name": "RequestBase", @@ -25668,7 +25686,7 @@ } } ], - "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L83" + "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L84" }, { "body": { @@ -25724,7 +25742,7 @@ } ] }, - "description": "Executes an ingest pipeline against a set of provided documents.", + "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "inherits": { "type": { "name": "RequestBase", @@ -25764,7 +25782,7 @@ } } ], - "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L57" + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L59" }, { "body": { @@ -34702,7 +34720,7 @@ "body": { "kind": "no_body" }, - "description": "Ping the cluster.\nReturns whether the cluster is running.", + "description": "Ping the cluster.\nGet information about whether the cluster is running.", "inherits": { "type": { "name": "RequestBase", @@ -34843,7 +34861,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a query rule within a query ruleset.", + "description": "Delete a query rule.\nDelete a query rule within a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -34882,7 +34900,7 @@ } ], "query": [], - "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L40" + "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L41" }, { "body": { @@ -34909,7 +34927,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a query ruleset.", + "description": "Delete a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -34963,7 +34981,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the details about a query rule within a query ruleset", + "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -35002,7 +35020,7 @@ } ], "query": [], - "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L40" + "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L42" }, { "body": { @@ -35029,7 +35047,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the details about a query ruleset", + "description": "Get a query ruleset.\nGet details about a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -35056,7 +35074,7 @@ } ], "query": [], - "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L35" + "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L36" }, { "body": { @@ -35083,7 +35101,7 @@ "body": { "kind": "no_body" }, - "description": "Returns summarized information about existing query rulesets.", + "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", "inherits": { "type": { "name": "RequestBase", @@ -35122,7 +35140,7 @@ } } ], - "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L39" + "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L40" }, { "body": { @@ -35230,7 +35248,7 @@ } ] }, - "description": "Creates or updates a query rule within a query ruleset.", + "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -35269,7 +35287,7 @@ } ], "query": [], - "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L56" + "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L57" }, { "body": { @@ -35330,7 +35348,7 @@ } ] }, - "description": "Creates or updates a query ruleset.", + "description": "Create or update a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -35357,7 +35375,7 @@ } ], "query": [], - "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L43" + "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L44" }, { "body": { @@ -35410,7 +35428,7 @@ } ] }, - "description": "Creates or updates a query ruleset.", + "description": "Test a query ruleset.\nEvaluate match criteria against a query ruleset to identify the rules that would match that criteria.", "inherits": { "type": { "name": "RequestBase", @@ -35437,7 +35455,7 @@ } ], "query": [], - "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L44" + "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L45" }, { "body": { @@ -40297,7 +40315,7 @@ } ] }, - "description": "Clears the SQL cursor", + "description": "Clear an SQL search cursor.", "inherits": { "type": { "name": "RequestBase", @@ -40311,7 +40329,7 @@ }, "path": [], "query": [], - "specLocation": "sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L34" + "specLocation": "sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L35" }, { "body": { @@ -40344,7 +40362,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.", + "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.", "inherits": { "type": { "name": "RequestBase", @@ -40371,7 +40389,7 @@ } ], "query": [], - "specLocation": "sql/delete_async/SqlDeleteAsyncRequest.ts#L23-L35" + "specLocation": "sql/delete_async/SqlDeleteAsyncRequest.ts#L23-L38" }, { "body": { @@ -40398,7 +40416,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the current status and available results for an async SQL search or stored synchronous SQL search", + "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.", "inherits": { "type": { "name": "RequestBase", @@ -40475,7 +40493,7 @@ } } ], - "specLocation": "sql/get_async/SqlGetAsyncRequest.ts#L24-L58" + "specLocation": "sql/get_async/SqlGetAsyncRequest.ts#L24-L60" }, { "body": { @@ -40575,7 +40593,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the current status of an async SQL search or a stored synchronous SQL search", + "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", "inherits": { "type": { "name": "RequestBase", @@ -40602,7 +40620,7 @@ } ], "query": [], - "specLocation": "sql/get_async_status/SqlGetAsyncStatusRequest.ts#L23-L35" + "specLocation": "sql/get_async_status/SqlGetAsyncStatusRequest.ts#L23-L37" }, { "body": { @@ -40928,7 +40946,7 @@ } ] }, - "description": "Executes a SQL request", + "description": "Get SQL search results.\nRun an SQL request.", "inherits": { "type": { "name": "RequestBase", @@ -40957,7 +40975,7 @@ } } ], - "specLocation": "sql/query/QuerySqlRequest.ts#L28-L122" + "specLocation": "sql/query/QuerySqlRequest.ts#L28-L124" }, { "body": { @@ -41113,7 +41131,7 @@ } ] }, - "description": "Translates SQL into Elasticsearch queries", + "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.", "inherits": { "type": { "name": "RequestBase", @@ -41127,7 +41145,7 @@ }, "path": [], "query": [], - "specLocation": "sql/translate/TranslateSqlRequest.ts#L25-L54" + "specLocation": "sql/translate/TranslateSqlRequest.ts#L25-L56" }, { "body": { @@ -41229,7 +41247,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a synonym set", + "description": "Delete a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -41283,7 +41301,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a synonym rule in a synonym set", + "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -41322,7 +41340,7 @@ } ], "query": [], - "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L40" + "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L41" }, { "body": { @@ -41349,7 +41367,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a synonym set", + "description": "Get a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -41450,7 +41468,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a synonym rule from a synonym set", + "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -41489,7 +41507,7 @@ } ], "query": [], - "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L40" + "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L41" }, { "body": { @@ -41516,7 +41534,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a summary of all defined synonym sets", + "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", "inherits": { "type": { "name": "RequestBase", @@ -41557,7 +41575,7 @@ } } ], - "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L41" + "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L42" }, { "body": { @@ -41633,7 +41651,7 @@ } ] }, - "description": "Creates or updates a synonym set.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", "inherits": { "type": { "name": "RequestBase", @@ -41660,7 +41678,7 @@ } ], "query": [], - "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L42" + "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L44" }, { "body": { @@ -41717,7 +41735,7 @@ } ] }, - "description": "Creates or updates a synonym rule in a synonym set", + "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -41756,7 +41774,7 @@ } ], "query": [], - "specLocation": "synonyms/put_synonym_rule/SynonymRulePutRequest.ts#L23-L47" + "specLocation": "synonyms/put_synonym_rule/SynonymRulePutRequest.ts#L23-L48" }, { "body": { @@ -93302,7 +93320,7 @@ "name": "EsqlFormat", "namespace": "esql.query" }, - "specLocation": "esql/query/QueryRequest.ts#L91-L100" + "specLocation": "esql/query/QueryRequest.ts#L93-L102" }, { "kind": "type_alias", @@ -104533,7 +104551,7 @@ "name": "SqlFormat", "namespace": "sql.query" }, - "specLocation": "sql/query/QuerySqlRequest.ts#L124-L132" + "specLocation": "sql/query/QuerySqlRequest.ts#L126-L134" }, { "kind": "type_alias",