Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 25, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d58e691
Mark existing query rules APIs as GA
kderusso Jun 21, 2024
1e4fbbb
Add individual CRUD API calls
kderusso Jun 21, 2024
cdf1df8
Linting
kderusso Jun 21, 2024
62824c5
PR feedback
kderusso Jun 24, 2024
22bb49c
PR feedback
kderusso Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
244 changes: 216 additions & 28 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24523,6 +24523,183 @@
}
}
},
"/_query_rules/{ruleset_id}/_rule/{rule_id}": {
"get": {
"tags": [
"query_rule.get"
],
"summary": "Returns the details about a query rule within a query ruleset",
"externalDocs": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html"
},
"operationId": "query-rule-get",
"parameters": [
{
"in": "path",
"name": "ruleset_id",
"description": "The unique identifier of the query ruleset containing the rule to retrieve",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types:Id"
},
"style": "simple"
},
{
"in": "path",
"name": "rule_id",
"description": "The unique identifier of the query rule within the specified ruleset to retrieve",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types:Id"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/query_ruleset._types:QueryRule"
}
}
}
}
}
},
"put": {
"tags": [
"query_rule.put"
],
"summary": "Creates or updates a query rule within a query ruleset",
"externalDocs": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html"
},
"operationId": "query-rule-put",
"parameters": [
{
"in": "path",
"name": "ruleset_id",
"description": "The unique identifier of the query ruleset containing the rule to be created or updated",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types:Id"
},
"style": "simple"
},
{
"in": "path",
"name": "rule_id",
"description": "The unique identifier of the query rule within the specified ruleset to be created or updated",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types:Id"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/query_ruleset._types:QueryRuleType"
},
"criteria": {
"type": "array",
"items": {
"$ref": "#/components/schemas/query_ruleset._types:QueryRuleCriteria"
}
},
"actions": {
"$ref": "#/components/schemas/query_ruleset._types:QueryRuleActions"
}
},
"required": [
"type",
"criteria",
"actions"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/_types:Result"
}
},
"required": [
"result"
]
}
}
}
}
}
},
"delete": {
"tags": [
"query_rule.delete"
],
"summary": "Deletes a query rule within a query ruleset",
"externalDocs": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html"
},
"operationId": "query-rule-delete",
"parameters": [
{
"in": "path",
"name": "ruleset_id",
"description": "The unique identifier of the query ruleset containing the rule to delete",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types:Id"
},
"style": "simple"
},
{
"in": "path",
"name": "rule_id",
"description": "The unique identifier of the query rule within the specified ruleset to delete",
"required": true,
"deprecated": false,
"schema": {
"$ref": "#/components/schemas/_types:Id"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_types:AcknowledgedResponseBase"
}
}
}
}
}
}
},
"/_query_rules/{ruleset_id}": {
"get": {
"tags": [
Expand Down Expand Up @@ -56991,7 +57168,7 @@
"minProperties": 1,
"maxProperties": 1
},
"rule_query": {
"rule": {
"$ref": "#/components/schemas/_types.query_dsl:RuleQuery"
},
"script": {
Expand Down Expand Up @@ -60508,16 +60685,19 @@
"organic": {
"$ref": "#/components/schemas/_types.query_dsl:QueryContainer"
},
"ruleset_id": {
"$ref": "#/components/schemas/_types:Id"
"ruleset_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_types:Id"
}
},
"match_criteria": {
"type": "object"
}
},
"required": [
"organic",
"ruleset_id",
"ruleset_ids",
"match_criteria"
]
}
Expand Down Expand Up @@ -92718,25 +92898,6 @@
"aggregations"
]
},
"query_ruleset._types:QueryRuleset": {
"type": "object",
"properties": {
"ruleset_id": {
"$ref": "#/components/schemas/_types:Id"
},
"rules": {
"description": "Rules associated with the query ruleset",
"type": "array",
"items": {
"$ref": "#/components/schemas/query_ruleset._types:QueryRule"
}
}
},
"required": [
"ruleset_id",
"rules"
]
},
"query_ruleset._types:QueryRule": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -92786,8 +92947,7 @@
}
},
"required": [
"type",
"metadata"
"type"
]
},
"query_ruleset._types:QueryRuleCriteriaType": {
Expand All @@ -92802,7 +92962,8 @@
"lt",
"lte",
"gt",
"gte"
"gte",
"always"
]
},
"query_ruleset._types:QueryRuleActions": {
Expand All @@ -92822,20 +92983,47 @@
}
}
},
"query_ruleset._types:QueryRuleset": {
"type": "object",
"properties": {
"ruleset_id": {
"$ref": "#/components/schemas/_types:Id"
},
"rules": {
"description": "Rules associated with the query ruleset",
"type": "array",
"items": {
"$ref": "#/components/schemas/query_ruleset._types:QueryRule"
}
}
},
"required": [
"ruleset_id",
"rules"
]
},
"query_ruleset.list:QueryRulesetListItem": {
"type": "object",
"properties": {
"ruleset_id": {
"$ref": "#/components/schemas/_types:Id"
},
"rules_count": {
"rule_total_count": {
"description": "The number of rules associated with this ruleset",
"type": "number"
},
"rule_criteria_types_counts": {
"description": "A map of criteria type to the number of rules of that type",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"ruleset_id",
"rules_count"
"rule_total_count",
"rule_criteria_types_counts"
]
},
"_global.rank_eval:RankEvalRequestItem": {
Expand Down
Loading
Loading