[Query Rules] Update Query Rules API for 8.15

elastic / elasticsearch-specification

Elasticsearch full specification

Apache License 2.0

121 stars 70 forks source link

[Query Rules] Update Query Rules API for 8.15 #2639

Closed kderusso closed 3 months ago

kderusso commented 3 months ago

The following changes are going live in 8.15 for query rules:

The feature is moving from Technical Preview to GA
The rule_query has been renamed to rule and support for multiple rulesets was added in https://github.com/elastic/elasticsearch/pull/108831
A CRUD API for individual rule updates was added in https://github.com/elastic/elasticsearch/pull/109042 and https://github.com/elastic/elasticsearch/pull/109554

github-actions[bot] commented 3 months ago

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
`query_rule.delete`	:white_circle:	Missing test	Missing test
`query_rule.get`	:white_circle:	Missing test	Missing test
`query_rule.put`	:white_circle:	Missing test	Missing test
`query_ruleset.delete`	:white_circle:	Missing test	Missing test
`query_ruleset.get`	:white_circle:	Missing test	Missing test
`query_ruleset.list`	:white_circle:	Missing test	Missing test
`query_ruleset.put`	:white_circle:	Missing test	Missing test

You can validate these APIs yourself by using the make validate target.

github-actions[bot] commented 3 months ago

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
`query_rule.delete`	:white_circle:	Missing test	Missing test
`query_rule.get`	:white_circle:	Missing test	Missing test
`query_rule.put`	:white_circle:	Missing test	Missing test
`query_ruleset.delete`	:white_circle:	Missing test	Missing test
`query_ruleset.get`	:white_circle:	Missing test	Missing test
`query_ruleset.list`	:white_circle:	Missing test	Missing test
`query_ruleset.put`	:white_circle:	Missing test	Missing test

You can validate these APIs yourself by using the make validate target.

l-trotta commented 3 months ago

the spec is missing the Always criteria type, and if I got this correctly metadata here should be optional.

l-trotta commented 3 months ago

QueryRulesetListItem probably has to be updated as well, server, current spec

github-actions[bot] commented 3 months ago

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
`query_rule.delete`	:white_circle:	Missing test	Missing test
`query_rule.get`	:white_circle:	Missing test	Missing test
`query_rule.put`	:white_circle:	Missing test	Missing test
`query_ruleset.delete`	:white_circle:	Missing test	Missing test
`query_ruleset.get`	:white_circle:	Missing test	Missing test
`query_ruleset.list`	:white_circle:	Missing test	Missing test
`query_ruleset.put`	:white_circle:	Missing test	Missing test

You can validate these APIs yourself by using the make validate target.

kderusso commented 3 months ago

@l-trotta thanks for the review!

the spec is missing the Always criteria type, and if I got this correctly metadata here should be optional.

Thanks for the catch, fixed!

QueryRulesetListItem probably has to be updated as well, server, current spec

Updated!

l-trotta commented 3 months ago

one last thing! in QueryRulesetListItem, rules_count should be rule_total_count and rule_criteria_type_counts should be rule_criteria_types_counts

pquentin commented 3 months ago

(I sound like a broken record, but those would be easier to catch if we could collect the Query Rules YAML tests.)

kderusso commented 3 months ago

(I sound like a broken record, but those would be easier to catch if we could collect the Query Rules YAML tests.)

I know, I promise it's on my list to look into!

github-actions[bot] commented 3 months ago

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
`query_rule.delete`	:white_circle:	Missing test	Missing test
`query_rule.get`	:white_circle:	Missing test	Missing test
`query_rule.put`	:white_circle:	Missing test	Missing test
`query_ruleset.delete`	:white_circle:	Missing test	Missing test
`query_ruleset.get`	:white_circle:	Missing test	Missing test
`query_ruleset.list`	:white_circle:	Missing test	Missing test
`query_ruleset.put`	:white_circle:	Missing test	Missing test

You can validate these APIs yourself by using the make validate target.