elastic / elasticsearch-specification

Elasticsearch full specification
Apache License 2.0
111 stars 68 forks source link

Fix Query Rules validation #2677

Closed pquentin closed 3 weeks ago

pquentin commented 1 month ago

For reference, now that we can use Query Rules YAML tests, here is the current validation status:

API Status Request Response Stability Visibility
delete_rule :green_circle: 6/6 6/6 stable public
delete_ruleset :green_circle: 7/7 7/7 stable public
get_rule :red_circle: 5/5 3/5 stable public
get_ruleset :red_circle: 8/8 5/8 stable public
list_rulesets :red_circle: 7/7 1/7 stable public
put_rule :red_circle: 0/7 7/7 stable public
put_ruleset :red_circle: 4/10 10/10 stable public
Summary :red_circle: 74% 78%

With only looking at docs and validation errors (not the code), I've fixed validation of all APIs in four commits:

github-actions[bot] commented 1 month ago

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

API Status Request Response
query_rules.delete_rule :green_circle: 6/6 6/6
query_rules.delete_ruleset :green_circle: 7/7 7/7
query_rules.get_rule :green_circle: 5/5 5/5
query_rules.get_ruleset :green_circle: 8/8 8/8
query_rules.list_rulesets :green_circle: 7/7 7/7
query_rules.put_rule :green_circle: 7/7 7/7
query_rules.put_ruleset :green_circle: 10/10 10/10

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

pquentin commented 1 month ago

Since this is not urgent, I'd like to wait a few working days before merging in order to give @kderusso a change to review this.