From 82a4b20c63a9722c5374705b963ce65926795b1d Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 3 Dec 2024 14:33:00 -0800 Subject: [PATCH] [DOCS] Add query rule operation summaries --- specification/_doc_ids/table.csv | 1 + .../query_rules/delete_rule/QueryRuleDeleteRequest.ts | 3 ++- .../query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts | 2 +- specification/query_rules/get_rule/QueryRuleGetRequest.ts | 4 +++- .../query_rules/get_ruleset/QueryRulesetGetRequest.ts | 3 ++- .../query_rules/list_rulesets/QueryRulesetListRequest.ts | 3 ++- specification/query_rules/put_rule/QueryRulePutRequest.ts | 3 ++- .../query_rules/put_ruleset/QueryRulesetPutRequest.ts | 3 ++- specification/query_rules/test/QueryRulesetTestRequest.ts | 3 ++- 9 files changed, 17 insertions(+), 8 deletions(-) diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 02c04d4df9..fe073f44cb 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -414,6 +414,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