Skip to content

Commit 5841a81

Browse files
add external doc links to Query rules GUI from the query rule spec files (#5171)
1 parent 5a23786 commit 5841a81

File tree

9 files changed

+15
-4
lines changed

9 files changed

+15
-4
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,10 @@ actions:
197197
198198
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
199199
This allows pinning documents for only queries that match a specific term.
200+
Alternatively, you can use the [Query Rules UI](https://www.elastic.co/docs/solutions/search/query-rules-ui) to manage query rules.
200201
externalDocs:
201-
url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rule-query
202-
description: Learn more about the rule query.
202+
url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules
203+
description: Learn more about searching with query rules.
203204
# R
204205
- name: rollup
205206
x-displayName: Rollup

specification/_doc_ids/table.csv

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -598,6 +598,11 @@ query-ruleset-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/op
598598
query-ruleset-list,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-query-rulesets.html,
599599
query-ruleset-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-query-ruleset.html,
600600
query-ruleset-test,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/test-query-ruleset.html,
601+
create-query-rule-from-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#create-a-query-rule,,Create rules and rulesets from the Query Rules UI
602+
edit-query-rule-from-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#edit-a-rule,,Edit rules and rulesets from the Query Rules UI
603+
delete-query-rule-from-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#delete-a-rule,,Delete a rule from the Query Rules UI
604+
list-query-rules-in-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#accessing-the-query-rules-ui,,See rules and rulesets in Query Rules UI
605+
delete-query-ruleset-from-ui,https://www.elastic.co/docs/solutions/search/query-rules-ui#delete-a-ruleset,,Delete a ruleset from the Query Rules UI
601606
realtime,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-get.html,
602607
redact-processor,https://www.elastic.co/docs/reference/enrich-processor/redact-processor,,
603608
regexp-syntax,https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax,,

specification/query_rules/delete_rule/QueryRuleDeleteRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import { Id } from '@_types/common'
2828
* @availability serverless stability=stable visibility=public
2929
* @cluster_privileges manage_search_query_rules
3030
* @doc_id query-rule-delete
31+
* @ext_doc_id delete-query-rule-from-ui
3132
*/
3233
export interface Request extends RequestBase {
3334
urls: [

specification/query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import { Id } from '@_types/common'
2828
* @availability serverless stability=stable visibility=public
2929
* @cluster_privileges manage_search_query_rules
3030
* @doc_id query-ruleset-delete
31+
* @ext_doc_id delete-query-ruleset-from-ui
3132
*/
3233
export interface Request extends RequestBase {
3334
urls: [

specification/query_rules/get_rule/QueryRuleGetRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { Id } from '@_types/common'
2727
* @availability serverless stability=stable visibility=public
2828
* @cluster_privileges manage_search_query_rules
2929
* @doc_id query-rule-get
30-
* @ext_doc_id query-rule
30+
* @ext_doc_id list-query-rules-in-ui
3131
*/
3232
export interface Request extends RequestBase {
3333
urls: [

specification/query_rules/get_ruleset/QueryRulesetGetRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Id } from '@_types/common'
2727
* @availability serverless stability=stable visibility=public
2828
* @cluster_privileges manage_search_query_rules
2929
* @doc_id query-ruleset-get
30+
* @ext_doc_id list-query-rules-in-ui
3031
*/
3132
export interface Request extends RequestBase {
3233
urls: [

specification/query_rules/list_rulesets/QueryRulesetListRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { integer } from '@_types/Numeric'
2727
* @availability serverless stability=stable visibility=public
2828
* @cluster_privileges manage_search_query_rules
2929
* @doc_id query-ruleset-list
30+
* @ext_doc_id list-query-rules-in-ui
3031
*/
3132
export interface Request extends RequestBase {
3233
urls: [

specification/query_rules/put_rule/QueryRulePutRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ import {
3838
* @availability serverless stability=stable visibility=public
3939
* @cluster_privileges manage_search_query_rules
4040
* @doc_id query-rule-put
41+
* @ext_doc_id edit-query-rule-from-ui
4142
*/
4243
export interface Request extends RequestBase {
4344
urls: [

specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import { QueryRule } from '../_types/QueryRuleset'
3434
* @availability serverless stability=stable visibility=public
3535
* @cluster_privileges manage_search_query_rules
3636
* @doc_id query-ruleset-put
37-
* @ext_doc_id query-rule
37+
* @ext_doc_id edit-query-rule-from-ui
3838
*/
3939
export interface Request extends RequestBase {
4040
urls: [

0 commit comments

Comments
 (0)