[DOCS] Add query rule operation summaries

elastic · Dec 3, 2024 · 82a4b20 · 82a4b20
1 parent a8c87f6
commit 82a4b20
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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