Add Put Query Ruleset API call #96812
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| { | ||
| "query_ruleset.put": { | ||
| "documentation": { | ||
| "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html", | ||
| "description": "Creates or updates a query ruleset." | ||
| }, | ||
| "stability": "experimental", | ||
| "visibility": "feature_flag", | ||
| "feature_flag": "es.query_rules_feature_flag_enabled", | ||
| "headers": { | ||
| "accept": [ | ||
| "application/json" | ||
| ], | ||
| "content_type": [ | ||
| "application/json" | ||
| ] | ||
| }, | ||
| "url": { | ||
| "paths": [ | ||
| { | ||
| "path": "/_query_rules/{ruleset_id}", | ||
| "methods": [ | ||
| "PUT" | ||
| ], | ||
| "parts": { | ||
| "ruleset_id": { | ||
| "type": "string", | ||
| "description": "The unique identifier of the ruleset to be created or updated." | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "params": { | ||
| "create": { | ||
| "type": "boolean", | ||
| "description": "If true, requires that a query_ruleset with the specified resource_id does not already exist. (default: false)" | ||
| } | ||
| }, | ||
| "body": { | ||
| "description": "The query ruleset configuration, including `rules`", | ||
| "required": true | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
|
|
||
|
|
||
| --- | ||
| 'Create Query Ruleset': | ||
|
Member
Author
There was a problem hiding this comment. Note: Since only the |
||
| - do: | ||
| query_ruleset.put: | ||
| ruleset_id: test-ruleset | ||
| body: | ||
| ruleset_id: test-ruleset | ||
| rules: | ||
| - rule_id: query-rule-id1 | ||
| type: pinned | ||
| criteria: | ||
| - type: exact | ||
| metadata: query_string | ||
| value: elastic | ||
| actions: | ||
| ids: | ||
| - 'id1' | ||
| - 'id2' | ||
| - rule_id: query-rule-id2 | ||
| type: pinned | ||
| criteria: | ||
| - type: exact | ||
| metadata: query_string | ||
| value: kibana | ||
| actions: | ||
| docs: | ||
| - '_index': 'test-index1' | ||
| '_id': 'id3' | ||
| - '_index': 'test-index2' | ||
| '_id': 'id4' | ||
|
|
||
| - match: { result: 'created' } | ||
|
|
||
| --- | ||
| 'Create Query Ruleset - Resource already exists': | ||
| - do: | ||
| query_ruleset.put: | ||
| create: true | ||
| ruleset_id: test-query-ruleset-recreating | ||
| body: | ||
| ruleset_id: 'test-query-ruleset-recreating' | ||
| rules: | ||
| rule_id: 'test-rule-1' | ||
| type: 'pinned' | ||
| criteria: | ||
| type: 'exact' | ||
| metadata: 'query_string' | ||
| value: 'elastic' | ||
| actions: | ||
| ids: | ||
| - 'id1' | ||
|
|
||
| - match: { result: 'created' } | ||
|
|
||
| - do: | ||
| catch: conflict | ||
| query_ruleset.put: | ||
| create: true | ||
| ruleset_id: test-query-ruleset-recreating | ||
| body: | ||
| ruleset_id: 'test-query-ruleset-recreating' | ||
| rules: | ||
| rule_id: 'test-rule-1' | ||
| type: 'pinned' | ||
| criteria: | ||
| type: 'exact' | ||
| metadata: 'query_string' | ||
| value: 'elastic' | ||
| actions: | ||
| ids: | ||
| - 'id2' | ||
|
|
||
| - match: { error.type: 'version_conflict_engine_exception' } | ||
|
|
||
| --- | ||
| 'Create Query Ruleset - Insufficient privilege': | ||
| - skip: | ||
| features: headers | ||
|
|
||
| - do: | ||
| catch: forbidden | ||
| headers: { Authorization: "Basic ZW50c2VhcmNoLXVzZXI6ZW50c2VhcmNoLXVzZXItcGFzc3dvcmQ=" } # user | ||
| query_ruleset.put: | ||
| ruleset_id: forbidden-query-ruleset | ||
| create: true | ||
| body: | ||
| ruleset_id: 'forbidden-query-ruleset' | ||
| rules: | ||
| rule_id: 'test-rule-1' | ||
| type: 'pinned' | ||
| criteria: | ||
| type: 'exact' | ||
| metadata: 'query_string' | ||
| value: 'elastic' | ||
| actions: | ||
| ids: | ||
| - 'id1' | ||
| - 'id2' | ||
|
|
||
| - match: { error.type: 'security_exception' } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this from the start?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably not, but it's a paradigm we already use with search applications and it wasn't a big lift to support.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say YAGNI - let's not add anything we're not sure to need, to avoid testing / documenting / maintaining it. It's easy to add later if needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of the time I'd agree, but there is a chance of accidentally overwriting an entire ruleset, with no history. This could be a guardrail.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we added that option to Search Applications for a very specific UI use case, and I don't feel this is something we need as a rule. I don't see this as a deal breaker for the PR, just a warning that we probably should not add it at least yet. It adds code and tests that we are not needing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I don't feel strongly enough that it has to stay in to argue more 😉 - I will plan to remove it, but I'll do so in a follow up PR (I want to get this merged to unblock the next one).