Skip to content

Fix eql.search response types #2663

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 4 commits into from
Jul 1, 2024
Merged

Fix eql.search response types #2663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae8fe8e
Fix eql.search response types
pquentin Jul 1, 2024
023aacb
Merge remote-tracking branch 'origin/main' into eql-response
pquentin Jul 1, 2024
6144560
Fix lint
pquentin Jul 1, 2024
c197d82
Run make contrib
pquentin Jul 1, 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
10 changes: 8 additions & 2 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78919,6 +78919,13 @@
"description": "Original JSON body passed for the event at index time.",
"type": "object"
},
"missing": {
"externalDocs": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-missing-events"
},
"description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.",
"type": "boolean"
},
"fields": {
"type": "object",
"additionalProperties": {
Expand Down Expand Up @@ -78957,8 +78964,7 @@
}
},
"required": [
"events",
"join_keys"
"events"
]
},
"eql.search:ResultPosition": {
Expand Down
10 changes: 8 additions & 2 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 17 additions & 3 deletions output/schema/schema-serverless.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113905,6 +113905,20 @@
}
}
},
{
"description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.",
"docId": "eql-missing-events",
"docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-missing-events",
"name": "missing",
"required": false,
"type": {
"kind": "instance_of",
"type": {
"name": "boolean",
"namespace": "_builtins"
}
}
},
{
"name": "fields",
"required": false,
Expand All @@ -113927,7 +113941,7 @@
}
}
],
"specLocation": "eql/_types/EqlHits.ts#L41-L49"
"specLocation": "eql/_types/EqlHits.ts#L41-L54"
},
{
"generics": [
Expand Down Expand Up @@ -113971,7 +113985,7 @@
"docId": "eql-sequences",
"docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-sequences",
"name": "join_keys",
"required": true,
"required": false,
"type": {
"kind": "array_of",
"value": {
Expand All @@ -113980,7 +113994,7 @@
}
}
],
"specLocation": "eql/_types/EqlHits.ts#L51-L59"
"specLocation": "eql/_types/EqlHits.ts#L56-L64"
},
{
"kind": "interface",
Expand Down
20 changes: 17 additions & 3 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ eql-async-search-status-api,https://www.elastic.co/guide/en/elasticsearch/refere
eql-basic-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-basic-syntax
eql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-search-api.html
eql-sequences,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-sequences
eql-missing-events,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-missing-events
eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html
eql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html
esql-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html
Expand Down
7 changes: 6 additions & 1 deletion specification/eql/_types/EqlHits.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ export class HitsEvent<TEvent> {
_id: Id
/** Original JSON body passed for the event at index time. */
_source: TEvent
/**
* Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.
* @doc_id eql-missing-events
*/
missing?: boolean
fields?: Dictionary<Field, UserDefinedValue[]>
}

Expand All @@ -55,5 +60,5 @@ export class HitsSequence<TEvent> {
* Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.
* @doc_id eql-sequences
*/
join_keys: UserDefinedValue[]
join_keys?: UserDefinedValue[]
}
Loading