diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 8fcde9063e..d322c576ce 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -23991,7 +23991,11 @@ "tags": [ "query_rules" ], - "summary": "Returns the details about a query rule within a query ruleset", + "summary": "Get a query rule", + "description": "Get details about a query rule within a query ruleset.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html" + }, "operationId": "query-rules-get-rule", "parameters": [ { @@ -24035,7 +24039,8 @@ "tags": [ "query_rules" ], - "summary": "Creates or updates a query rule within a query ruleset", + "summary": "Create or update a query rule", + "description": "Create or update a query rule within a query ruleset.", "operationId": "query-rules-put-rule", "parameters": [ { @@ -24126,7 +24131,8 @@ "tags": [ "query_rules" ], - "summary": "Deletes a query rule within a query ruleset", + "summary": "Delete a query rule", + "description": "Delete a query rule within a query ruleset.", "operationId": "query-rules-delete-rule", "parameters": [ { @@ -24172,7 +24178,8 @@ "tags": [ "query_rules" ], - "summary": "Returns the details about a query ruleset", + "summary": "Get a query ruleset", + "description": "Get details about a query ruleset.", "operationId": "query-rules-get-ruleset", "parameters": [ { @@ -24205,7 +24212,10 @@ "tags": [ "query_rules" ], - "summary": "Creates or updates a query ruleset", + "summary": "Create or update a query ruleset", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html" + }, "operationId": "query-rules-put-ruleset", "parameters": [ { @@ -24274,7 +24284,7 @@ "tags": [ "query_rules" ], - "summary": "Deletes a query ruleset", + "summary": "Delete a query ruleset", "operationId": "query-rules-delete-ruleset", "parameters": [ { @@ -24309,7 +24319,8 @@ "tags": [ "query_rules" ], - "summary": "Returns summarized information about existing query rulesets", + "summary": "Get all query rulesets", + "description": "Get summarized information about the query rulesets.", "operationId": "query-rules-list-rulesets", "parameters": [ { @@ -24368,7 +24379,8 @@ "tags": [ "query_rules" ], - "summary": "Creates or updates a query ruleset", + "summary": "Test a query ruleset", + "description": "Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.", "operationId": "query-rules-test", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 2f460e5736..4bb0428729 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -14448,7 +14448,11 @@ "tags": [ "query_rules" ], - "summary": "Returns the details about a query rule within a query ruleset", + "summary": "Get a query rule", + "description": "Get details about a query rule within a query ruleset.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html" + }, "operationId": "query-rules-get-rule", "parameters": [ { @@ -14492,7 +14496,8 @@ "tags": [ "query_rules" ], - "summary": "Creates or updates a query rule within a query ruleset", + "summary": "Create or update a query rule", + "description": "Create or update a query rule within a query ruleset.", "operationId": "query-rules-put-rule", "parameters": [ { @@ -14583,7 +14588,8 @@ "tags": [ "query_rules" ], - "summary": "Deletes a query rule within a query ruleset", + "summary": "Delete a query rule", + "description": "Delete a query rule within a query ruleset.", "operationId": "query-rules-delete-rule", "parameters": [ { @@ -14629,7 +14635,8 @@ "tags": [ "query_rules" ], - "summary": "Returns the details about a query ruleset", + "summary": "Get a query ruleset", + "description": "Get details about a query ruleset.", "operationId": "query-rules-get-ruleset", "parameters": [ { @@ -14662,7 +14669,10 @@ "tags": [ "query_rules" ], - "summary": "Creates or updates a query ruleset", + "summary": "Create or update a query ruleset", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html" + }, "operationId": "query-rules-put-ruleset", "parameters": [ { @@ -14731,7 +14741,7 @@ "tags": [ "query_rules" ], - "summary": "Deletes a query ruleset", + "summary": "Delete a query ruleset", "operationId": "query-rules-delete-ruleset", "parameters": [ { @@ -14766,7 +14776,8 @@ "tags": [ "query_rules" ], - "summary": "Returns summarized information about existing query rulesets", + "summary": "Get all query rulesets", + "description": "Get summarized information about the query rulesets.", "operationId": "query-rules-list-rulesets", "parameters": [ { @@ -14825,7 +14836,8 @@ "tags": [ "query_rules" ], - "summary": "Creates or updates a query ruleset", + "summary": "Test a query ruleset", + "description": "Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.", "operationId": "query-rules-test", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 10cc868603..745fcfa861 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -13609,7 +13609,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": { @@ -13644,7 +13644,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": { @@ -13679,8 +13679,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", @@ -13714,7 +13716,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": { @@ -13749,7 +13751,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": { @@ -13784,7 +13786,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": { @@ -13822,8 +13824,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", @@ -13860,7 +13864,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": { @@ -183262,7 +183266,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", @@ -183300,7 +183304,7 @@ } ], "query": [], - "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L40" + "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L41" }, { "kind": "response", @@ -183328,7 +183332,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a query ruleset.", + "description": "Delete a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -183382,7 +183386,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", @@ -183420,7 +183424,7 @@ } ], "query": [], - "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L40" + "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L42" }, { "kind": "response", @@ -183448,7 +183452,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", @@ -183474,7 +183478,7 @@ } ], "query": [], - "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L35" + "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L36" }, { "kind": "response", @@ -183582,7 +183586,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", @@ -183620,7 +183624,7 @@ } } ], - "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L39" + "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L40" }, { "kind": "response", @@ -183729,7 +183733,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", @@ -183767,7 +183771,7 @@ } ], "query": [], - "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L56" + "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L57" }, { "kind": "response", @@ -183829,7 +183833,7 @@ } ] }, - "description": "Creates or updates a query ruleset.", + "description": "Create or update a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -183855,7 +183859,7 @@ } ], "query": [], - "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L43" + "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L44" }, { "kind": "response", @@ -183943,7 +183947,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", @@ -183969,7 +183973,7 @@ } ], "query": [], - "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L44" + "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L45" }, { "kind": "response",