From 914fda45b627dca9215a4ce2ce7ebcde3e3344b1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 5 Dec 2024 10:58:03 -0800 Subject: [PATCH] [DOCS] Add query rule operation summaries (#3219) (#3242) (cherry picked from commit 44a773292cbdffc6ffcf5ab874c17e5af0d4a422) Co-authored-by: Lisa Cawley --- output/openapi/elasticsearch-openapi.json | 28 ++++++++--- .../elasticsearch-serverless-openapi.json | 28 ++++++++--- output/schema/schema.json | 50 ++++++++++--------- specification/_doc_ids/table.csv | 1 + .../delete_rule/QueryRuleDeleteRequest.ts | 3 +- .../QueryRulesetDeleteRequest.ts | 2 +- .../get_rule/QueryRuleGetRequest.ts | 4 +- .../get_ruleset/QueryRulesetGetRequest.ts | 3 +- .../list_rulesets/QueryRulesetListRequest.ts | 3 +- .../put_rule/QueryRulePutRequest.ts | 3 +- .../put_ruleset/QueryRulesetPutRequest.ts | 3 +- .../test/QueryRulesetTestRequest.ts | 3 +- 12 files changed, 84 insertions(+), 47 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index d5e897172f..79f894c7cf 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -23953,7 +23953,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": [ { @@ -23997,7 +24001,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": [ { @@ -24088,7 +24093,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": [ { @@ -24134,7 +24140,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": [ { @@ -24167,7 +24174,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": [ { @@ -24236,7 +24246,7 @@ "tags": [ "query_rules" ], - "summary": "Deletes a query ruleset", + "summary": "Delete a query ruleset", "operationId": "query-rules-delete-ruleset", "parameters": [ { @@ -24271,7 +24281,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": [ { @@ -24330,7 +24341,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 57093f33ea..d383ee878c 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -14716,7 +14716,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": [ { @@ -14760,7 +14764,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": [ { @@ -14851,7 +14856,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": [ { @@ -14897,7 +14903,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": [ { @@ -14930,7 +14937,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": [ { @@ -14999,7 +15009,7 @@ "tags": [ "query_rules" ], - "summary": "Deletes a query ruleset", + "summary": "Delete a query ruleset", "operationId": "query-rules-delete-ruleset", "parameters": [ { @@ -15034,7 +15044,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": [ { @@ -15093,7 +15104,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 ae0ac649fe..2122b3fc9a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -13617,7 +13617,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": { @@ -13652,7 +13652,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": { @@ -13687,8 +13687,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", @@ -13722,7 +13724,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": { @@ -13757,7 +13759,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": { @@ -13792,7 +13794,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": { @@ -13830,8 +13832,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", @@ -13868,7 +13872,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": { @@ -182986,7 +182990,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", @@ -183024,7 +183028,7 @@ } ], "query": [], - "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L40" + "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L41" }, { "kind": "response", @@ -183052,7 +183056,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a query ruleset.", + "description": "Delete a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -183106,7 +183110,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", @@ -183144,7 +183148,7 @@ } ], "query": [], - "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L40" + "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L42" }, { "kind": "response", @@ -183172,7 +183176,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", @@ -183198,7 +183202,7 @@ } ], "query": [], - "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L35" + "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L36" }, { "kind": "response", @@ -183306,7 +183310,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", @@ -183344,7 +183348,7 @@ } } ], - "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L39" + "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L40" }, { "kind": "response", @@ -183453,7 +183457,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", @@ -183491,7 +183495,7 @@ } ], "query": [], - "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L56" + "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L57" }, { "kind": "response", @@ -183553,7 +183557,7 @@ } ] }, - "description": "Creates or updates a query ruleset.", + "description": "Create or update a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -183579,7 +183583,7 @@ } ], "query": [], - "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L43" + "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L44" }, { "kind": "response", @@ -183667,7 +183671,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", @@ -183693,7 +183697,7 @@ } ], "query": [], - "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L44" + "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L45" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 060161ef30..efa19ff503 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -415,6 +415,7 @@ query-dsl-weighted-tokens-query,https://www.elastic.co/guide/en/elasticsearch/re query-dsl-wildcard-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html query-dsl-wrapper-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html query-dsl,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html +query-rule,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html realtime,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime redact-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/redact-processor.html regexp-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/regexp-syntax.html diff --git a/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts b/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts index 33398e41d2..df745da4ab 100644 --- a/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts +++ b/specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts @@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a query rule within a query ruleset. + * Delete a query rule. + * Delete a query rule within a query ruleset. * @rest_spec_name query_rules.delete_rule * @availability stack since=8.15.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts b/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts index 21dd9bf92a..3698895120 100644 --- a/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts +++ b/specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a query ruleset. + * Delete a query ruleset. * @rest_spec_name query_rules.delete_ruleset * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/query_rules/get_rule/QueryRuleGetRequest.ts b/specification/query_rules/get_rule/QueryRuleGetRequest.ts index 7aa110fdc3..de16f7ff86 100644 --- a/specification/query_rules/get_rule/QueryRuleGetRequest.ts +++ b/specification/query_rules/get_rule/QueryRuleGetRequest.ts @@ -20,10 +20,12 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Returns the details about a query rule within a query ruleset + * Get a query rule. + * Get details about a query rule within a query ruleset. * @rest_spec_name query_rules.get_rule * @availability stack since=8.15.0 stability=stable * @availability serverless stability=stable visibility=public + * @ext_doc_id query-rule */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts b/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts index 7ec6faffd1..bbc3118e70 100644 --- a/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts +++ b/specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts @@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Returns the details about a query ruleset + * Get a query ruleset. + * Get details about a query ruleset. * @rest_spec_name query_rules.get_ruleset * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts b/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts index 3a71d2761e..f98ee4a6b5 100644 --- a/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts +++ b/specification/query_rules/list_rulesets/QueryRulesetListRequest.ts @@ -20,7 +20,8 @@ import { RequestBase } from '@_types/Base' import { integer } from '@_types/Numeric' /** - * Returns summarized information about existing query rulesets. + * Get all query rulesets. + * Get summarized information about the query rulesets. * @rest_spec_name query_rules.list_rulesets * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/query_rules/put_rule/QueryRulePutRequest.ts b/specification/query_rules/put_rule/QueryRulePutRequest.ts index 506f3b2b97..e3c1f5aefe 100644 --- a/specification/query_rules/put_rule/QueryRulePutRequest.ts +++ b/specification/query_rules/put_rule/QueryRulePutRequest.ts @@ -26,7 +26,8 @@ import { } from '../_types/QueryRuleset' /** - * Creates or updates a query rule within a query ruleset. + * Create or update a query rule. + * Create or update a query rule within a query ruleset. * @rest_spec_name query_rules.put_rule * @availability stack since=8.15.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts b/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts index 1b9f22f27e..06d244fe1c 100644 --- a/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts +++ b/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts @@ -21,10 +21,11 @@ import { Id } from '@_types/common' import { QueryRule } from '../_types/QueryRuleset' /** - * Creates or updates a query ruleset. + * Create or update a query ruleset. * @rest_spec_name query_rules.put_ruleset * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public + * @ext_doc_id query-rule */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/query_rules/test/QueryRulesetTestRequest.ts b/specification/query_rules/test/QueryRulesetTestRequest.ts index 78f1e493bd..6ce634de10 100644 --- a/specification/query_rules/test/QueryRulesetTestRequest.ts +++ b/specification/query_rules/test/QueryRulesetTestRequest.ts @@ -22,7 +22,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Creates or updates a query ruleset. + * Test a query ruleset. + * Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. * @rest_spec_name query_rules.test * @availability stack since=8.10.0 stability=stable * @availability serverless stability=stable visibility=public