github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity

Track unreferenced deprecated apis count (#121809)

Browse source 
* Track unreferenced deprecated apis count

* Update api docs
This commit is contained in:
Stacey Gammon 2021-12-21 15:34:53 -05:00 • committed by GitHub
parent b49e8ddd50
commit cb588a3a15
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
42 changed files with 1783 additions and 1773 deletions
Download patch file Download diff file Expand all files Collapse all files

10
api_docs/alerting.json
View file

@ -1492,7 +1492,9 @@
"label": "search", "label": "search",
"description": [], "description": [],
"signature": [ "signature": [
"(query: ", "<TDocument = unknown, TContext = unknown>(query: ",
"SearchRequest",
" | ",
"SearchRequest", "SearchRequest",
", options?: ", ", options?: ",
"TransportRequestOptions", "TransportRequestOptions",
@ -1500,7 +1502,7 @@
"TransportResult", "TransportResult",
"<", "<",
"SearchResponse", "SearchResponse",
"<unknown>, unknown>>" "<TDocument>, TContext>>"
], ],
"path": "x-pack/plugins/alerting/server/lib/create_abortable_es_client_factory.ts", "path": "x-pack/plugins/alerting/server/lib/create_abortable_es_client_factory.ts",
"deprecated": false, "deprecated": false,
@ -1508,11 +1510,13 @@
{ {
"parentPluginId": "alerting", "parentPluginId": "alerting",
"id": "def-server.IAbortableEsClient.search.$1", "id": "def-server.IAbortableEsClient.search.$1",
"type": "Object", "type": "CompoundType",
"tags": [], "tags": [],
"label": "query", "label": "query",
"description": [], "description": [],
"signature": [ "signature": [
"SearchRequest",
" | ",
"SearchRequest" "SearchRequest"
], ],
"path": "x-pack/plugins/alerting/server/lib/create_abortable_es_client_factory.ts", "path": "x-pack/plugins/alerting/server/lib/create_abortable_es_client_factory.ts",

12
api_docs/apm.json
View file

@ -186,7 +186,7 @@
"APMPluginSetupDependencies", "APMPluginSetupDependencies",
") => { config$: ", ") => { config$: ",
"Observable", "Observable",
"<Readonly<{} & { indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", "<Readonly<{} & { indices: Readonly<{} & { error: string; span: string; metric: string; transaction: string; sourcemap: string; onboarding: string; }>; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting", "SearchAggregatedTransactionSetting",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>; getApmIndices: () => Promise<", "; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>; getApmIndices: () => Promise<",
"ApmIndicesConfig", "ApmIndicesConfig",
@ -378,7 +378,7 @@
"label": "config", "label": "config",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "{ readonly indices: Readonly<{} & { error: string; span: string; metric: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting", "SearchAggregatedTransactionSetting",
"; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly profilingEnabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }" "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly profilingEnabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }"
], ],
@ -765,7 +765,7 @@
"label": "APMConfig", "label": "APMConfig",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "{ readonly indices: Readonly<{} & { error: string; span: string; metric: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting", "SearchAggregatedTransactionSetting",
"; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly profilingEnabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }" "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly profilingEnabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }"
], ],
@ -781,7 +781,7 @@
"label": "ApmIndicesConfigName", "label": "ApmIndicesConfigName",
"description": [], "description": [],
"signature": [ "signature": [
"\"error\" | \"metric\" | \"span\" | \"transaction\" | \"sourcemap\" | \"onboarding\"" "\"error\" | \"span\" | \"metric\" | \"transaction\" | \"sourcemap\" | \"onboarding\""
], ],
"path": "x-pack/plugins/apm/server/index.ts", "path": "x-pack/plugins/apm/server/index.ts",
"deprecated": false, "deprecated": false,
@ -4146,7 +4146,7 @@
"section": "def-server.APMRouteHandlerResources", "section": "def-server.APMRouteHandlerResources",
"text": "APMRouteHandlerResources" "text": "APMRouteHandlerResources"
}, },
", { apmIndexSettings: { configurationName: \"error\" | \"metric\" | \"span\" | \"transaction\" | \"sourcemap\" | \"onboarding\"; defaultValue: string; savedValue: string | undefined; }[]; }, ", ", { apmIndexSettings: { configurationName: \"error\" | \"span\" | \"metric\" | \"transaction\" | \"sourcemap\" | \"onboarding\"; defaultValue: string; savedValue: string | undefined; }[]; }, ",
"APMRouteCreateOptions", "APMRouteCreateOptions",
">; } & { \"GET /internal/apm/settings/apm-indices\": ", ">; } & { \"GET /internal/apm/settings/apm-indices\": ",
{ {
@ -5559,7 +5559,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"Observable", "Observable",
"<Readonly<{} & { indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", "<Readonly<{} & { indices: Readonly<{} & { error: string; span: string; metric: string; transaction: string; sourcemap: string; onboarding: string; }>; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting", "SearchAggregatedTransactionSetting",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>" "; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>"
], ],

186
api_docs/data.json
View file

@ -10911,6 +10911,20 @@
], ],
"path": "src/plugins/data_views/common/types.ts", "path": "src/plugins/data_views/common/types.ts",
"deprecated": false "deprecated": false
},
{
"parentPluginId": "data",
"id": "def-public.GetFieldsOptions.filter",
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"signature": [
"QueryDslQueryContainer",
" | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false
@ -13419,7 +13433,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -13443,7 +13465,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -14883,7 +14913,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -14907,7 +14945,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -20245,7 +20291,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -20269,7 +20323,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -20446,7 +20508,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -20470,7 +20540,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -27159,7 +27237,9 @@
"\n Get a list of field objects for an index pattern that may contain wildcards\n" "\n Get a list of field objects for an index pattern that may contain wildcards\n"
], ],
"signature": [ "signature": [
"(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; }) => Promise<", "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; filter?: ",
"QueryDslQueryContainer",
" | undefined; }) => Promise<",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "server", "scope": "server",
@ -27246,6 +27326,20 @@
], ],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false "deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.filter",
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"signature": [
"QueryDslQueryContainer",
" | undefined"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false
} }
] ]
} }
@ -33805,7 +33899,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>" ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>"
], ],
"path": "src/plugins/data_views/common/data_views/data_views.ts", "path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false, "deprecated": false,
@ -33869,7 +33971,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>" " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>"
], ],
"path": "src/plugins/data_views/common/data_views/data_views.ts", "path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false, "deprecated": false,
@ -42552,6 +42662,20 @@
], ],
"path": "src/plugins/data_views/common/types.ts", "path": "src/plugins/data_views/common/types.ts",
"deprecated": false "deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions.filter",
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"signature": [
"QueryDslQueryContainer",
" | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false
@ -45179,7 +45303,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -45203,7 +45335,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -46497,7 +46637,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -46521,7 +46669,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",

2
api_docs/data.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3334 | 39 | 2933 | 26 | | 3337 | 39 | 2936 | 26 |
## Client ## Client

2
api_docs/data_autocomplete.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3334 | 39 | 2933 | 26 | | 3337 | 39 | 2936 | 26 |
## Client ## Client

2
api_docs/data_query.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3334 | 39 | 2933 | 26 | | 3337 | 39 | 2936 | 26 |
## Client ## Client

2
api_docs/data_search.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3334 | 39 | 2933 | 26 | | 3337 | 39 | 2936 | 26 |
## Client ## Client

2
api_docs/data_ui.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3334 | 39 | 2933 | 26 | | 3337 | 39 | 2936 | 26 |
## Client ## Client

176
api_docs/data_views.json
View file

@ -2138,7 +2138,7 @@
"label": "getFieldsForWildcard", "label": "getFieldsForWildcard",
"description": [], "description": [],
"signature": [ "signature": [
"({ pattern, metaFields, type, rollupIndex, allowNoIndex }: ", "({ pattern, metaFields, type, rollupIndex, allowNoIndex, filter, }: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -2156,7 +2156,7 @@
"id": "def-public.DataViewsApiClient.getFieldsForWildcard.$1", "id": "def-public.DataViewsApiClient.getFieldsForWildcard.$1",
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "{ pattern, metaFields, type, rollupIndex, allowNoIndex }", "label": "{\n pattern,\n metaFields,\n type,\n rollupIndex,\n allowNoIndex,\n filter,\n }",
"description": [], "description": [],
"signature": [ "signature": [
{ {
@ -2830,7 +2830,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>" ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>"
], ],
"path": "src/plugins/data_views/common/data_views/data_views.ts", "path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false, "deprecated": false,
@ -2894,7 +2902,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>" " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>"
], ],
"path": "src/plugins/data_views/common/data_views/data_views.ts", "path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false, "deprecated": false,
@ -9350,7 +9366,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -9374,7 +9398,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -9592,7 +9624,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -9616,7 +9656,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -10335,7 +10383,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -10359,7 +10415,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -10849,7 +10913,9 @@
"\n Get a list of field objects for an index pattern that may contain wildcards\n" "\n Get a list of field objects for an index pattern that may contain wildcards\n"
], ],
"signature": [ "signature": [
"(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; }) => Promise<", "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; filter?: ",
"QueryDslQueryContainer",
" | undefined; }) => Promise<",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "server", "scope": "server",
@ -10936,6 +11002,20 @@
], ],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false "deprecated": false
},
{
"parentPluginId": "dataViews",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.filter",
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"signature": [
"QueryDslQueryContainer",
" | undefined"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false
} }
] ]
} }
@ -15105,7 +15185,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>" ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>"
], ],
"path": "src/plugins/data_views/common/data_views/data_views.ts", "path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false, "deprecated": false,
@ -15169,7 +15257,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>" " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>"
], ],
"path": "src/plugins/data_views/common/data_views/data_views.ts", "path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false, "deprecated": false,
@ -21765,6 +21861,20 @@
], ],
"path": "src/plugins/data_views/common/types.ts", "path": "src/plugins/data_views/common/types.ts",
"deprecated": false "deprecated": false
},
{
"parentPluginId": "dataViews",
"id": "def-common.GetFieldsOptions.filter",
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"signature": [
"QueryDslQueryContainer",
" | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false
@ -24694,7 +24804,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -24718,7 +24836,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -25291,7 +25417,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
") => Promise<any>; getFieldsForIndexPattern: (indexPattern: ", ") => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -25315,7 +25449,15 @@
"section": "def-common.GetFieldsOptions", "section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions" "text": "GetFieldsOptions"
}, },
" | undefined) => Promise<any>; refreshFields: (indexPattern: ", " | undefined) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; refreshFields: (indexPattern: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",

2
api_docs/data_views.mdx
View file

@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 712 | 3 | 564 | 6 | | 714 | 3 | 566 | 6 |
## Client ## Client

174
api_docs/deprecations_by_api.mdx
View file

@ -153,90 +153,90 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
Safe to remove. Safe to remove.
| Deprecated API | | Deprecated API | Plugin Id |
| ---------------| | ---------------|------------|
| <DocLink id="kibDashboardPluginApi" section="def-public.DashboardUrlGeneratorState" text="DashboardUrlGeneratorState"/> | | <DocLink id="kibDashboardPluginApi" section="def-public.DashboardUrlGeneratorState" text="DashboardUrlGeneratorState"/> | dashboard |
| <DocLink id="kibDashboardPluginApi" section="def-public.createDashboardUrlGenerator" text="createDashboardUrlGenerator"/> | | <DocLink id="kibDashboardPluginApi" section="def-public.createDashboardUrlGenerator" text="createDashboardUrlGenerator"/> | dashboard |
| <DocLink id="kibDataPluginApi" section="def-public.RangeFilterMeta" text="RangeFilterMeta"/> | | <DocLink id="kibDataPluginApi" section="def-public.RangeFilterMeta" text="RangeFilterMeta"/> | data |
| <DocLink id="kibDataPluginApi" section="def-public.PhrasesFilter" text="PhrasesFilter"/> | | <DocLink id="kibDataPluginApi" section="def-public.PhrasesFilter" text="PhrasesFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-public.CustomFilter" text="CustomFilter"/> | | <DocLink id="kibDataPluginApi" section="def-public.CustomFilter" text="CustomFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-public.MatchAllFilter" text="MatchAllFilter"/> | | <DocLink id="kibDataPluginApi" section="def-public.MatchAllFilter" text="MatchAllFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldSubType" text="IFieldSubType"/> | | <DocLink id="kibDataPluginApi" section="def-public.IFieldSubType" text="IFieldSubType"/> | data |
| <DocLink id="kibDataPluginApi" section="def-public.isFilter" text="isFilter"/> | | <DocLink id="kibDataPluginApi" section="def-public.isFilter" text="isFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.RangeFilterMeta" text="RangeFilterMeta"/> | | <DocLink id="kibDataPluginApi" section="def-common.RangeFilterMeta" text="RangeFilterMeta"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.PhrasesFilter" text="PhrasesFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.PhrasesFilter" text="PhrasesFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.MatchAllFilter" text="MatchAllFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.MatchAllFilter" text="MatchAllFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.CustomFilter" text="CustomFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.CustomFilter" text="CustomFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.FilterMeta" text="FilterMeta"/> | | <DocLink id="kibDataPluginApi" section="def-common.FilterMeta" text="FilterMeta"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldSubType" text="IFieldSubType"/> | | <DocLink id="kibDataPluginApi" section="def-common.IFieldSubType" text="IFieldSubType"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.COMPARE_ALL_OPTIONS" text="COMPARE_ALL_OPTIONS"/> | | <DocLink id="kibDataPluginApi" section="def-common.COMPARE_ALL_OPTIONS" text="COMPARE_ALL_OPTIONS"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.compareFilters" text="compareFilters"/> | | <DocLink id="kibDataPluginApi" section="def-common.compareFilters" text="compareFilters"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.enableFilter" text="enableFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.enableFilter" text="enableFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.pinFilter" text="pinFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.pinFilter" text="pinFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.toggleFilterDisabled" text="toggleFilterDisabled"/> | | <DocLink id="kibDataPluginApi" section="def-common.toggleFilterDisabled" text="toggleFilterDisabled"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.disableFilter" text="disableFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.disableFilter" text="disableFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.fromKueryExpression" text="fromKueryExpression"/> | | <DocLink id="kibDataPluginApi" section="def-common.fromKueryExpression" text="fromKueryExpression"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.toElasticsearchQuery" text="toElasticsearchQuery"/> | | <DocLink id="kibDataPluginApi" section="def-common.toElasticsearchQuery" text="toElasticsearchQuery"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.nodeTypes" text="nodeTypes"/> | | <DocLink id="kibDataPluginApi" section="def-common.nodeTypes" text="nodeTypes"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildEsQuery" text="buildEsQuery"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildEsQuery" text="buildEsQuery"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildQueryFromFilters" text="buildQueryFromFilters"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildQueryFromFilters" text="buildQueryFromFilters"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.luceneStringToDsl" text="luceneStringToDsl"/> | | <DocLink id="kibDataPluginApi" section="def-common.luceneStringToDsl" text="luceneStringToDsl"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.decorateQuery" text="decorateQuery"/> | | <DocLink id="kibDataPluginApi" section="def-common.decorateQuery" text="decorateQuery"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.getPhraseFilterField" text="getPhraseFilterField"/> | | <DocLink id="kibDataPluginApi" section="def-common.getPhraseFilterField" text="getPhraseFilterField"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.getPhraseFilterValue" text="getPhraseFilterValue"/> | | <DocLink id="kibDataPluginApi" section="def-common.getPhraseFilterValue" text="getPhraseFilterValue"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.isExistsFilter" text="isExistsFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.isExistsFilter" text="isExistsFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.isMatchAllFilter" text="isMatchAllFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.isMatchAllFilter" text="isMatchAllFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.isPhraseFilter" text="isPhraseFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.isPhraseFilter" text="isPhraseFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.isPhrasesFilter" text="isPhrasesFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.isPhrasesFilter" text="isPhrasesFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.isRangeFilter" text="isRangeFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.isRangeFilter" text="isRangeFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.isQueryStringFilter" text="isQueryStringFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.isQueryStringFilter" text="isQueryStringFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildQueryFilter" text="buildQueryFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildQueryFilter" text="buildQueryFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildPhrasesFilter" text="buildPhrasesFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildPhrasesFilter" text="buildPhrasesFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildPhraseFilter" text="buildPhraseFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildPhraseFilter" text="buildPhraseFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildRangeFilter" text="buildRangeFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildRangeFilter" text="buildRangeFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildCustomFilter" text="buildCustomFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildCustomFilter" text="buildCustomFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildFilter" text="buildFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildFilter" text="buildFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildEmptyFilter" text="buildEmptyFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildEmptyFilter" text="buildEmptyFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.buildExistsFilter" text="buildExistsFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.buildExistsFilter" text="buildExistsFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.toggleFilterNegated" text="toggleFilterNegated"/> | | <DocLink id="kibDataPluginApi" section="def-common.toggleFilterNegated" text="toggleFilterNegated"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.FILTERS" text="FILTERS"/> | | <DocLink id="kibDataPluginApi" section="def-common.FILTERS" text="FILTERS"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.isFilter" text="isFilter"/> | | <DocLink id="kibDataPluginApi" section="def-common.isFilter" text="isFilter"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.isFilterDisabled" text="isFilterDisabled"/> | | <DocLink id="kibDataPluginApi" section="def-common.isFilterDisabled" text="isFilterDisabled"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.dedupFilters" text="dedupFilters"/> | | <DocLink id="kibDataPluginApi" section="def-common.dedupFilters" text="dedupFilters"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.onlyDisabledFiltersChanged" text="onlyDisabledFiltersChanged"/> | | <DocLink id="kibDataPluginApi" section="def-common.onlyDisabledFiltersChanged" text="onlyDisabledFiltersChanged"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.uniqFilters" text="uniqFilters"/> | | <DocLink id="kibDataPluginApi" section="def-common.uniqFilters" text="uniqFilters"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.getKbnFieldType" text="getKbnFieldType"/> | | <DocLink id="kibDataPluginApi" section="def-common.getKbnFieldType" text="getKbnFieldType"/> | data |
| <DocLink id="kibDataPluginApi" section="def-common.getFilterableKbnTypeNames" text="getFilterableKbnTypeNames"/> | | <DocLink id="kibDataPluginApi" section="def-common.getFilterableKbnTypeNames" text="getFilterableKbnTypeNames"/> | data |
| <DocLink id="kibDataPluginApi" section="def-server.DataPluginSetup.fieldFormats" text="fieldFormats"/> | | <DocLink id="kibDataPluginApi" section="def-server.DataPluginSetup.fieldFormats" text="fieldFormats"/> | data |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldSubType" text="IFieldSubType"/> | | <DocLink id="kibDataPluginApi" section="def-server.IFieldSubType" text="IFieldSubType"/> | data |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.intervalName" text="intervalName"/> | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.intervalName" text="intervalName"/> | dataViews |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.addScriptedField" text="addScriptedField"/> | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.addScriptedField" text="addScriptedField"/> | dataViews |
| <DocLink id="kibDataViewsPluginApi" section="def-common.DataViewSpec.intervalName" text="intervalName"/> | | <DocLink id="kibDataViewsPluginApi" section="def-common.DataViewSpec.intervalName" text="intervalName"/> | dataViews |
| <DocLink id="kibDataViewsPluginApi" section="def-common.DataView.intervalName" text="intervalName"/> | | <DocLink id="kibDataViewsPluginApi" section="def-common.DataView.intervalName" text="intervalName"/> | dataViews |
| <DocLink id="kibDataViewsPluginApi" section="def-common.DataView.addScriptedField" text="addScriptedField"/> | | <DocLink id="kibDataViewsPluginApi" section="def-common.DataView.addScriptedField" text="addScriptedField"/> | dataViews |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionExecutor" text="ExpressionExecutor"/> | | <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionExecutor" text="ExpressionExecutor"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-public.Executor.functions" text="functions"/> | | <DocLink id="kibExpressionsPluginApi" section="def-public.Executor.functions" text="functions"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-public.Executor.types" text="types"/> | | <DocLink id="kibExpressionsPluginApi" section="def-public.Executor.types" text="types"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-public.InterpreterErrorType" text="InterpreterErrorType"/> | | <DocLink id="kibExpressionsPluginApi" section="def-public.InterpreterErrorType" text="InterpreterErrorType"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-common.InterpreterErrorType" text="InterpreterErrorType"/> | | <DocLink id="kibExpressionsPluginApi" section="def-common.InterpreterErrorType" text="InterpreterErrorType"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Executor.functions" text="functions"/> | | <DocLink id="kibExpressionsPluginApi" section="def-common.Executor.functions" text="functions"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Executor.types" text="types"/> | | <DocLink id="kibExpressionsPluginApi" section="def-common.Executor.types" text="types"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-server.InterpreterErrorType" text="InterpreterErrorType"/> | | <DocLink id="kibExpressionsPluginApi" section="def-server.InterpreterErrorType" text="InterpreterErrorType"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-server.Executor.functions" text="functions"/> | | <DocLink id="kibExpressionsPluginApi" section="def-server.Executor.functions" text="functions"/> | expressions |
| <DocLink id="kibExpressionsPluginApi" section="def-server.Executor.types" text="types"/> | | <DocLink id="kibExpressionsPluginApi" section="def-server.Executor.types" text="types"/> | expressions |
| <DocLink id="kibScreenshotModePluginApi" section="def-common.KBN_SCREENSHOT_MODE_LAYOUT_KEY" text="KBN_SCREENSHOT_MODE_LAYOUT_KEY"/> | | <DocLink id="kibScreenshotModePluginApi" section="def-common.KBN_SCREENSHOT_MODE_LAYOUT_KEY" text="KBN_SCREENSHOT_MODE_LAYOUT_KEY"/> | screenshotMode |
| <DocLink id="kibScreenshotModePluginApi" section="def-common.setScreenshotLayout" text="setScreenshotLayout"/> | | <DocLink id="kibScreenshotModePluginApi" section="def-common.setScreenshotLayout" text="setScreenshotLayout"/> | screenshotMode |
| <DocLink id="kibScreenshotModePluginApi" section="def-common.getScreenshotLayout" text="getScreenshotLayout"/> | | <DocLink id="kibScreenshotModePluginApi" section="def-common.getScreenshotLayout" text="getScreenshotLayout"/> | screenshotMode |
| <DocLink id="kibLicensingPluginApi" section="def-public.ILicense.mode" text="mode"/> | | <DocLink id="kibLicensingPluginApi" section="def-public.ILicense.mode" text="mode"/> | licensing |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.refresh" text="refresh"/> | | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.refresh" text="refresh"/> | licensing |
| <DocLink id="kibLicensingPluginApi" section="def-server.ILicense.mode" text="mode"/> | | <DocLink id="kibLicensingPluginApi" section="def-server.ILicense.mode" text="mode"/> | licensing |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | licensing |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportFailure.title" text="title"/> | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportFailure.title" text="title"/> | core |
| <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.res" text="res"/> | | <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.res" text="res"/> | core |
| <DocLink id="kibCorePluginApi" section="def-public.AsyncPlugin" text="AsyncPlugin"/> | | <DocLink id="kibCorePluginApi" section="def-public.AsyncPlugin" text="AsyncPlugin"/> | core |
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceStart.legacy" text="legacy"/> | | <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceStart.legacy" text="legacy"/> | core |
| <DocLink id="kibCorePluginApi" section="def-server.HttpServiceSetup.auth" text="auth"/> | | <DocLink id="kibCorePluginApi" section="def-server.HttpServiceSetup.auth" text="auth"/> | core |
| <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | | <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | core |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportFailure.title" text="title"/> | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportFailure.title" text="title"/> | core |
| <DocLink id="kibKbnEsQueryPluginApi" section="def-common.IndexPatternBase" text="IndexPatternBase"/> | | <DocLink id="kibKbnEsQueryPluginApi" section="def-common.IndexPatternBase" text="IndexPatternBase"/> | @kbn/es-query |
| <DocLink id="kibKbnEsQueryPluginApi" section="def-common.IndexPatternFieldBase" text="IndexPatternFieldBase"/> | | <DocLink id="kibKbnEsQueryPluginApi" section="def-common.IndexPatternFieldBase" text="IndexPatternFieldBase"/> | @kbn/es-query |

6
api_docs/event_log.json
View file

@ -892,7 +892,7 @@
"label": "data", "label": "data",
"description": [], "description": [],
"signature": [ "signature": [
"(Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" "(Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
], ],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false "deprecated": false
@ -911,7 +911,7 @@
"label": "IEvent", "label": "IEvent",
"description": [], "description": [],
"signature": [ "signature": [
"DeepPartial<DeepWriteable<Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" "DeepPartial<DeepWriteable<Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
], ],
"path": "x-pack/plugins/event_log/generated/schemas.ts", "path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false, "deprecated": false,
@ -925,7 +925,7 @@
"label": "IValidatedEvent", "label": "IValidatedEvent",
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined" "Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; url?: string | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; original?: string | undefined; severity?: number | undefined; hash?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; ingested?: string | undefined; module?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined"
], ],
"path": "x-pack/plugins/event_log/generated/schemas.ts", "path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false, "deprecated": false,

2
api_docs/expression_shape.json
View file

@ -636,7 +636,7 @@
"label": "strokeLinecap", "label": "strokeLinecap",
"description": [], "description": [],
"signature": [ "signature": [
"\"inherit\" | \"butt\" | \"round\" | \"square\" | undefined" "\"square\" | \"inherit\" | \"butt\" | \"round\" | undefined"
], ],
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx", "path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"deprecated": false "deprecated": false

2
api_docs/expressions.json
View file

@ -39819,7 +39819,7 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"(\"min\" | \"max\" | \"sum\" | \"average\")[]" "(\"sum\" | \"max\" | \"min\" | \"average\")[]"
], ],
"path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts",
"deprecated": false "deprecated": false

4
api_docs/fleet.json
View file

@ -15576,7 +15576,7 @@
"label": "[RegistryVarsEntryKeys.type]", "label": "[RegistryVarsEntryKeys.type]",
"description": [], "description": [],
"signature": [ "signature": [
"\"string\" | \"text\" | \"yaml\" | \"integer\" | \"bool\" | \"password\"" "\"string\" | \"text\" | \"integer\" | \"yaml\" | \"bool\" | \"password\""
], ],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts", "path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false "deprecated": false
@ -18813,7 +18813,7 @@
"label": "RegistryVarType", "label": "RegistryVarType",
"description": [], "description": [],
"signature": [ "signature": [
"\"string\" | \"text\" | \"yaml\" | \"integer\" | \"bool\" | \"password\"" "\"string\" | \"text\" | \"integer\" | \"yaml\" | \"bool\" | \"password\""
], ],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts", "path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false, "deprecated": false,

2
api_docs/kbn_es_query.json
View file

@ -3392,7 +3392,7 @@
"label": "function", "label": "function",
"description": [], "description": [],
"signature": [ "signature": [
"\"nested\" | \"is\" | \"exists\" | \"range\" | \"and\" | \"or\" | \"not\"" "\"nested\" | \"is\" | \"exists\" | \"and\" | \"or\" | \"range\" | \"not\""
], ],
"path": "packages/kbn-es-query/src/kuery/node_types/types.ts", "path": "packages/kbn-es-query/src/kuery/node_types/types.ts",
"deprecated": false "deprecated": false

510
api_docs/kbn_interpreter.json Normal file
View file

@ -0,0 +1,510 @@
{
"id": "@kbn/interpreter",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry",
"type": "Class",
"tags": [],
"label": "Registry",
"description": [],
"signature": [
{
"pluginId": "@kbn/interpreter",
"scope": "server",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-server.Registry",
"text": "Registry"
},
"<ItemSpec, Item>"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.Unnamed.$1",
"type": "string",
"tags": [],
"label": "prop",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.wrapper",
"type": "Function",
"tags": [],
"label": "wrapper",
"description": [],
"signature": [
"(obj: ItemSpec) => Item"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.wrapper.$1",
"type": "Uncategorized",
"tags": [],
"label": "obj",
"description": [],
"signature": [
"ItemSpec"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.register",
"type": "Function",
"tags": [],
"label": "register",
"description": [],
"signature": [
"(fn: () => ItemSpec) => void"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.register.$1",
"type": "Function",
"tags": [],
"label": "fn",
"description": [],
"signature": [
"() => ItemSpec"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.toJS",
"type": "Function",
"tags": [],
"label": "toJS",
"description": [],
"signature": [
"() => { [key: string]: any; }"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.toArray",
"type": "Function",
"tags": [],
"label": "toArray",
"description": [],
"signature": [
"() => Item[]"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(name: string) => Item"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.get.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.getProp",
"type": "Function",
"tags": [],
"label": "getProp",
"description": [],
"signature": [
"() => string"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Registry.reset",
"type": "Function",
"tags": [],
"label": "reset",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-interpreter/src/common/lib/registry.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.fromExpression",
"type": "Function",
"tags": [],
"label": "fromExpression",
"description": [],
"signature": [
"(expression: string, type: string) => ",
{
"pluginId": "@kbn/interpreter",
"scope": "server",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-server.Ast",
"text": "Ast"
}
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.fromExpression.$1",
"type": "string",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.fromExpression.$2",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.getType",
"type": "Function",
"tags": [],
"label": "getType",
"description": [],
"signature": [
"(node: any) => string"
],
"path": "packages/kbn-interpreter/src/common/lib/get_type.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.getType.$1",
"type": "Any",
"tags": [],
"label": "node",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-interpreter/src/common/lib/get_type.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.safeElementFromExpression",
"type": "Function",
"tags": [],
"label": "safeElementFromExpression",
"description": [],
"signature": [
"(expression: string) => ",
{
"pluginId": "@kbn/interpreter",
"scope": "server",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-server.Ast",
"text": "Ast"
}
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.safeElementFromExpression.$1",
"type": "string",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.toExpression",
"type": "Function",
"tags": [],
"label": "toExpression",
"description": [],
"signature": [
"(astObj: ",
{
"pluginId": "@kbn/interpreter",
"scope": "server",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-server.Ast",
"text": "Ast"
},
", type: string) => string"
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.toExpression.$1",
"type": "Object",
"tags": [],
"label": "astObj",
"description": [],
"signature": [
{
"pluginId": "@kbn/interpreter",
"scope": "server",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-server.Ast",
"text": "Ast"
}
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.toExpression.$2",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Ast",
"type": "Interface",
"tags": [],
"label": "Ast",
"description": [],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Ast.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"expression\""
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.Ast.chain",
"type": "Array",
"tags": [],
"label": "chain",
"description": [],
"signature": [
{
"pluginId": "@kbn/interpreter",
"scope": "server",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-server.ExpressionFunctionAST",
"text": "ExpressionFunctionAST"
},
"[]"
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.ExpressionFunctionAST",
"type": "Interface",
"tags": [],
"label": "ExpressionFunctionAST",
"description": [],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.ExpressionFunctionAST.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"function\""
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.ExpressionFunctionAST.function",
"type": "string",
"tags": [],
"label": "function",
"description": [],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/interpreter",
"id": "def-server.ExpressionFunctionAST.arguments",
"type": "Object",
"tags": [],
"label": "arguments",
"description": [],
"signature": [
"{ [key: string]: ",
"ExpressionArgAST",
"[]; }"
],
"path": "packages/kbn-interpreter/src/common/lib/ast.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

33
api_docs/kbn_interpreter.mdx Normal file
View file

@ -0,0 +1,33 @@
---
id: kibKbnInterpreterPluginApi
slug: /kibana-dev-docs/api/kbn-interpreter
title: "@kbn/interpreter"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the @kbn/interpreter plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import kbnInterpreterObj from './kbn_interpreter.json';
Contact [Owner missing] for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 30 | 1 | 30 | 1 |
## Server
### Functions
<DocDefinitionList data={kbnInterpreterObj.server.functions}/>
### Classes
<DocDefinitionList data={kbnInterpreterObj.server.classes}/>
### Interfaces
<DocDefinitionList data={kbnInterpreterObj.server.interfaces}/>

14
api_docs/kbn_securitysolution_autocomplete.json
View file

@ -262,9 +262,9 @@
"\nGiven an array of lists and optionally a field this will return all\nthe lists that match against the field based on the types from the field\n\nNOTE: That we support one additional property from \"FieldSpec\" located here:\nsrc/plugins/data/common/index_patterns/fields/types.ts\nThis type property is esTypes. If it exists and is on there we will read off the esTypes." "\nGiven an array of lists and optionally a field this will return all\nthe lists that match against the field based on the types from the field\n\nNOTE: That we support one additional property from \"FieldSpec\" located here:\nsrc/plugins/data/common/index_patterns/fields/types.ts\nThis type property is esTypes. If it exists and is on there we will read off the esTypes."
], ],
"signature": [ "signature": [
"(lists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[], field?: (", "(lists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[], field?: (",
"DataViewFieldBase", "DataViewFieldBase",
" & { esTypes?: string[] | undefined; }) | undefined) => { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" " & { esTypes?: string[] | undefined; }) | undefined) => { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]"
], ],
"path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts", "path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts",
"deprecated": false, "deprecated": false,
@ -279,7 +279,7 @@
"The lists to match against the field" "The lists to match against the field"
], ],
"signature": [ "signature": [
"{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]"
], ],
"path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts", "path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts",
"deprecated": false, "deprecated": false,
@ -734,13 +734,7 @@
"label": "operatorType", "label": "operatorType",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
}
], ],
"path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts", "path": "packages/kbn-securitysolution-autocomplete/src/hooks/use_field_value_autocomplete/index.ts",
"deprecated": false "deprecated": false

110
api_docs/kbn_securitysolution_hook_utils.json
View file

@ -30,7 +30,13 @@
], ],
"signature": [ "signature": [
"<Args extends unknown[], Result>(fn: (...args: Args) => Promise<Result>) => ", "<Args extends unknown[], Result>(fn: (...args: Args) => Promise<Result>) => ",
"Task", {
"pluginId": "@kbn/securitysolution-hook-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionHookUtilsPluginApi",
"section": "def-common.Task",
"text": "Task"
},
"<Args, Result>" "<Args, Result>"
], ],
"path": "packages/kbn-securitysolution-hook-utils/src/use_async/index.ts", "path": "packages/kbn-securitysolution-hook-utils/src/use_async/index.ts",
@ -91,7 +97,13 @@
"<Args extends unknown[], Result>(fn: (...args: Args) => ", "<Args extends unknown[], Result>(fn: (...args: Args) => ",
"Observable", "Observable",
"<Result>) => ", "<Result>) => ",
"Task", {
"pluginId": "@kbn/securitysolution-hook-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionHookUtilsPluginApi",
"section": "def-common.Task",
"text": "Task"
},
"<Args, Result>" "<Args, Result>"
], ],
"path": "packages/kbn-securitysolution-hook-utils/src/use_observable/index.ts", "path": "packages/kbn-securitysolution-hook-utils/src/use_observable/index.ts",
@ -167,7 +179,99 @@
"initialIsOpen": false "initialIsOpen": false
} }
], ],
"interfaces": [], "interfaces": [
{
"parentPluginId": "@kbn/securitysolution-hook-utils",
"id": "def-common.Task",
"type": "Interface",
"tags": [],
"label": "Task",
"description": [
"\nRepresents the state of an asynchronous task, along with an initiator\nfunction to kick off the work."
],
"signature": [
{
"pluginId": "@kbn/securitysolution-hook-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionHookUtilsPluginApi",
"section": "def-common.Task",
"text": "Task"
},
"<Args, Result>"
],
"path": "packages/kbn-securitysolution-hook-utils/src/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-hook-utils",
"id": "def-common.Task.loading",
"type": "boolean",
"tags": [],
"label": "loading",
"description": [],
"path": "packages/kbn-securitysolution-hook-utils/src/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-hook-utils",
"id": "def-common.Task.error",
"type": "Unknown",
"tags": [],
"label": "error",
"description": [],
"signature": [
"unknown"
],
"path": "packages/kbn-securitysolution-hook-utils/src/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-hook-utils",
"id": "def-common.Task.result",
"type": "Uncategorized",
"tags": [],
"label": "result",
"description": [],
"signature": [
"Result | undefined"
],
"path": "packages/kbn-securitysolution-hook-utils/src/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-hook-utils",
"id": "def-common.Task.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(...args: Args) => void"
],
"path": "packages/kbn-securitysolution-hook-utils/src/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-hook-utils",
"id": "def-common.Task.start.$1",
"type": "Uncategorized",
"tags": [],
"label": "args",
"description": [],
"signature": [
"Args"
],
"path": "packages/kbn-securitysolution-hook-utils/src/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [], "enums": [],
"misc": [ "misc": [
{ {

5
api_docs/kbn_securitysolution_hook_utils.mdx
View file

@ -18,13 +18,16 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 8 | 0 | 1 | 1 | | 14 | 0 | 6 | 0 |
## Common ## Common
### Functions ### Functions
<DocDefinitionList data={kbnSecuritysolutionHookUtilsObj.common.functions}/> <DocDefinitionList data={kbnSecuritysolutionHookUtilsObj.common.functions}/>
### Interfaces
<DocDefinitionList data={kbnSecuritysolutionHookUtilsObj.common.interfaces}/>
### Consts, variables and types ### Consts, variables and types
<DocDefinitionList data={kbnSecuritysolutionHookUtilsObj.common.misc}/> <DocDefinitionList data={kbnSecuritysolutionHookUtilsObj.common.misc}/>

166
api_docs/kbn_securitysolution_io_ts_list_types.json
View file

@ -27,7 +27,7 @@
"label": "updateExceptionListItemValidate", "label": "updateExceptionListItemValidate",
"description": [], "description": [],
"signature": [ "signature": [
"(schema: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" "(schema: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts",
"deprecated": false, "deprecated": false,
@ -40,7 +40,7 @@
"label": "schema", "label": "schema",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts",
"deprecated": false, "deprecated": false,
@ -58,7 +58,7 @@
"label": "validateComments", "label": "validateComments",
"description": [], "description": [],
"signature": [ "signature": [
"(item: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" "(item: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts",
"deprecated": false, "deprecated": false,
@ -71,7 +71,7 @@
"label": "item", "label": "item",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts",
"deprecated": false, "deprecated": false,
@ -153,7 +153,7 @@
"label": "listItem", "label": "listItem",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts",
"deprecated": false "deprecated": false
@ -1216,7 +1216,7 @@
"label": "listItem", "label": "listItem",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts",
"deprecated": false "deprecated": false
@ -1307,7 +1307,7 @@
"label": "exceptions", "label": "exceptions",
"description": [], "description": [],
"signature": [ "signature": [
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts",
"deprecated": false "deprecated": false
@ -1914,7 +1914,7 @@
"label": "CreateEndpointListItemSchemaDecoded", "label": "CreateEndpointListItemSchemaDecoded",
"description": [], "description": [],
"signature": [ "signature": [
"Omit<{ description: string; entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\" | \"item_id\" | \"os_types\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" "Omit<{ description: string; entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\" | \"item_id\" | \"os_types\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_endpoint_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_endpoint_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -1942,7 +1942,7 @@
"label": "CreateExceptionListItemSchema", "label": "CreateExceptionListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_exception_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_exception_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -1956,7 +1956,7 @@
"label": "CreateExceptionListItemSchemaDecoded", "label": "CreateExceptionListItemSchemaDecoded",
"description": [], "description": [],
"signature": [ "signature": [
"Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\" | \"item_id\" | \"namespace_type\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\" | \"item_id\" | \"namespace_type\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_exception_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_exception_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2026,7 +2026,7 @@
"label": "CreateListSchema", "label": "CreateListSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; name: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; } & { deserializer?: string | undefined; id?: string | undefined; meta?: object | undefined; serializer?: string | undefined; version?: number | undefined; }" "{ description: string; name: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; } & { deserializer?: string | undefined; id?: string | undefined; meta?: object | undefined; serializer?: string | undefined; version?: number | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_list_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_list_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2040,7 +2040,7 @@
"label": "CreateListSchemaDecoded", "label": "CreateListSchemaDecoded",
"description": [], "description": [],
"signature": [ "signature": [
"{ type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; id: string | undefined; description: string; name: string; meta: object | undefined; serializer: string | undefined; deserializer: string | undefined; } & { version: number; }" "{ type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; id: string | undefined; description: string; name: string; meta: object | undefined; serializer: string | undefined; deserializer: string | undefined; } & { version: number; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_list_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_list_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2334,7 +2334,7 @@
"label": "EntriesArray", "label": "EntriesArray",
"description": [], "description": [],
"signature": [ "signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts",
"deprecated": false, "deprecated": false,
@ -2348,7 +2348,7 @@
"label": "EntriesArrayOrUndefined", "label": "EntriesArrayOrUndefined",
"description": [], "description": [],
"signature": [ "signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[] | undefined" "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[] | undefined"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts",
"deprecated": false, "deprecated": false,
@ -2362,7 +2362,7 @@
"label": "Entry", "label": "Entry",
"description": [], "description": [],
"signature": [ "signature": [
"{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }" "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts",
"deprecated": false, "deprecated": false,
@ -2390,7 +2390,7 @@
"label": "EntryList", "label": "EntryList",
"description": [], "description": [],
"signature": [ "signature": [
"{ field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" "{ field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries_list/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries_list/index.ts",
"deprecated": false, "deprecated": false,
@ -2460,7 +2460,7 @@
"label": "ExceptionListItemSchema", "label": "ExceptionListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }" "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/exception_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/exception_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2782,7 +2782,7 @@
"label": "FoundExceptionListItemSchema", "label": "FoundExceptionListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; }" "{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_exception_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_exception_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2810,7 +2810,7 @@
"label": "FoundListItemSchema", "label": "FoundListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; }" "{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2824,7 +2824,7 @@
"label": "FoundListSchema", "label": "FoundListSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }" "{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2894,7 +2894,7 @@
"label": "ImportExceptionListItemSchema", "label": "ImportExceptionListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: { comment: string; }[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: { comment: string; }[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_exception_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_exception_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2908,7 +2908,7 @@
"label": "ImportExceptionListItemSchemaDecoded", "label": "ImportExceptionListItemSchemaDecoded",
"description": [], "description": [],
"signature": [ "signature": [
"Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: { comment: string; }[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\" | \"item_id\" | \"namespace_type\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: { comment: string; }[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\" | \"item_id\" | \"namespace_type\"> & { comments: { comment: string; }[]; tags: string[]; item_id: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_exception_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_exception_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2964,7 +2964,7 @@
"label": "ImportListItemQuerySchema", "label": "ImportListItemQuerySchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ deserializer: string | undefined; list_id: string | undefined; serializer: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\" | undefined; }" "{ deserializer: string | undefined; list_id: string | undefined; serializer: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_list_item_query_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_list_item_query_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -2978,7 +2978,7 @@
"label": "ImportListItemQuerySchemaEncoded", "label": "ImportListItemQuerySchemaEncoded",
"description": [], "description": [],
"signature": [ "signature": [
"{ deserializer?: string | undefined; list_id?: string | undefined; serializer?: string | undefined; type?: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\" | undefined; }" "{ deserializer?: string | undefined; list_id?: string | undefined; serializer?: string | undefined; type?: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_list_item_query_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_list_item_query_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3090,7 +3090,7 @@
"label": "ListArraySchema", "label": "ListArraySchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3132,7 +3132,7 @@
"label": "ListItemArraySchema", "label": "ListItemArraySchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]" "{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3160,7 +3160,7 @@
"label": "ListItemSchema", "label": "ListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }" "{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3188,7 +3188,7 @@
"label": "ListSchema", "label": "ListSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }" "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3370,7 +3370,7 @@
"label": "NonEmptyEntriesArray", "label": "NonEmptyEntriesArray",
"description": [], "description": [],
"signature": [ "signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts",
"deprecated": false, "deprecated": false,
@ -3384,7 +3384,7 @@
"label": "NonEmptyEntriesArrayDecoded", "label": "NonEmptyEntriesArrayDecoded",
"description": [], "description": [],
"signature": [ "signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]" "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts",
"deprecated": false, "deprecated": false,
@ -3706,7 +3706,7 @@
"label": "SearchListItemArraySchema", "label": "SearchListItemArraySchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]" "{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/search_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/search_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3720,7 +3720,7 @@
"label": "SearchListItemSchema", "label": "SearchListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }" "{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/response/search_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/search_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3860,7 +3860,7 @@
"label": "Type", "label": "Type",
"description": [], "description": [],
"signature": [ "signature": [
"\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"" "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\""
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/type/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/type/index.ts",
"deprecated": false, "deprecated": false,
@ -3874,7 +3874,7 @@
"label": "TypeOrUndefined", "label": "TypeOrUndefined",
"description": [], "description": [],
"signature": [ "signature": [
"\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\" | undefined" "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/type/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/type/index.ts",
"deprecated": false, "deprecated": false,
@ -3930,7 +3930,7 @@
"label": "UpdateEndpointListItemSchema", "label": "UpdateEndpointListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_endpoint_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_endpoint_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3944,7 +3944,7 @@
"label": "UpdateEndpointListItemSchemaDecoded", "label": "UpdateEndpointListItemSchemaDecoded",
"description": [], "description": [],
"signature": [ "signature": [
"Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: string[]; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: string[]; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_endpoint_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_endpoint_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3958,7 +3958,7 @@
"label": "UpdateExceptionListItemSchema", "label": "UpdateExceptionListItemSchema",
"description": [], "description": [],
"signature": [ "signature": [
"{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -3972,7 +3972,7 @@
"label": "UpdateExceptionListItemSchemaDecoded", "label": "UpdateExceptionListItemSchemaDecoded",
"description": [], "description": [],
"signature": [ "signature": [
"Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\" | \"namespace_type\" | \"os_types\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: string[]; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"comments\" | \"entries\" | \"namespace_type\" | \"os_types\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: string[]; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_schema/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_schema/index.ts",
"deprecated": false, "deprecated": false,
@ -4505,7 +4505,7 @@
"StringC", "StringC",
"; entries: ", "; entries: ",
"Type", "Type",
"<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; list_id: ", "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; list_id: ",
"Type", "Type",
"<string, string, unknown>; name: ", "<string, string, unknown>; name: ",
"StringC", "StringC",
@ -5998,21 +5998,9 @@
"<{ filter: ", "<{ filter: ",
"StringC", "StringC",
"; page: ", "; page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; per_page: ", "; per_page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; sort_field: ", "; sort_field: ",
"StringC", "StringC",
"; sort_order: ", "; sort_order: ",
@ -6047,21 +6035,9 @@
"<string[], string | null | undefined, unknown>; namespace_type: ", "<string[], string | null | undefined, unknown>; namespace_type: ",
"Type", "Type",
"<(\"single\" | \"agnostic\")[], string | null | undefined, unknown>; page: ", "<(\"single\" | \"agnostic\")[], string | null | undefined, unknown>; page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; per_page: ", "; per_page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; sort_field: ", "; sort_field: ",
"StringC", "StringC",
"; sort_order: ", "; sort_order: ",
@ -6088,21 +6064,9 @@
"; namespace_type: ", "; namespace_type: ",
"Type", "Type",
"<(\"single\" | \"agnostic\")[], string | null | undefined, unknown>; page: ", "<(\"single\" | \"agnostic\")[], string | null | undefined, unknown>; page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; per_page: ", "; per_page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; sort_field: ", "; sort_field: ",
"StringC", "StringC",
"; sort_order: ", "; sort_order: ",
@ -6137,21 +6101,9 @@
"; filter: ", "; filter: ",
"StringC", "StringC",
"; page: ", "; page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; per_page: ", "; per_page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; sort_field: ", "; sort_field: ",
"StringC", "StringC",
"; sort_order: ", "; sort_order: ",
@ -6178,21 +6130,9 @@
"; filter: ", "; filter: ",
"StringC", "StringC",
"; page: ", "; page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; per_page: ", "; per_page: ",
{ "StringToPositiveNumberC",
"pluginId": "@kbn/securitysolution-io-ts-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsTypesPluginApi",
"section": "def-common.StringToPositiveNumberC",
"text": "StringToPositiveNumberC"
},
"; sort_field: ", "; sort_field: ",
"StringC", "StringC",
"; sort_order: ", "; sort_order: ",
@ -6681,7 +6621,7 @@
"StringC", "StringC",
"; entries: ", "; entries: ",
"Type", "Type",
"<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; item_id: ", "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; item_id: ",
"Type", "Type",
"<string, string, unknown>; list_id: ", "<string, string, unknown>; list_id: ",
"Type", "Type",
@ -7580,7 +7520,7 @@
], ],
"signature": [ "signature": [
"Type", "Type",
"<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>" "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>"
], ],
"path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts",
"deprecated": false, "deprecated": false,
@ -8405,7 +8345,7 @@
"StringC", "StringC",
"; entries: ", "; entries: ",
"Type", "Type",
"<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; name: ", "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; name: ",
"StringC", "StringC",
"; type: ", "; type: ",
"KeyofC", "KeyofC",
@ -8458,7 +8398,7 @@
"StringC", "StringC",
"; entries: ", "; entries: ",
"Type", "Type",
"<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; name: ", "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; name: ",
"StringC", "StringC",
"; type: ", "; type: ",
"KeyofC", "KeyofC",

606
api_docs/kbn_securitysolution_list_api.json
View file

@ -28,13 +28,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, signal, }: ", "({ http, signal, }: ",
{ "AddEndpointExceptionListProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.AddEndpointExceptionListProps",
"text": "AddEndpointExceptionListProps"
},
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; } | {}>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; } | {}>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
@ -48,13 +42,7 @@
"label": "{\n http,\n signal,\n}", "label": "{\n http,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "AddEndpointExceptionListProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.AddEndpointExceptionListProps",
"text": "AddEndpointExceptionListProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -73,14 +61,8 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, listItem, signal, }: ", "({ http, listItem, signal, }: ",
{ "AddExceptionListItemProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types", ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.AddExceptionListItemProps",
"text": "AddExceptionListItemProps"
},
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -93,13 +75,7 @@
"label": "{\n http,\n listItem,\n signal,\n}", "label": "{\n http,\n listItem,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "AddExceptionListItemProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.AddExceptionListItemProps",
"text": "AddExceptionListItemProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -118,13 +94,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, list, signal, }: ", "({ http, list, signal, }: ",
{ "AddExceptionListProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.AddExceptionListProps",
"text": "AddExceptionListProps"
},
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
@ -138,13 +108,7 @@
"label": "{\n http,\n list,\n signal,\n}", "label": "{\n http,\n list,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "AddExceptionListProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.AddExceptionListProps",
"text": "AddExceptionListProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -163,7 +127,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, signal, }: ", "({ http, signal, }: ",
"ApiParams", {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
},
") => Promise<{ acknowledged: boolean; }>" ") => Promise<{ acknowledged: boolean; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
@ -177,7 +147,13 @@
"label": "{\n http,\n signal,\n}", "label": "{\n http,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
"ApiParams" {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -196,13 +172,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, id, namespaceType, signal, }: ", "({ http, id, namespaceType, signal, }: ",
{ "ApiCallByIdProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByIdProps",
"text": "ApiCallByIdProps"
},
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
@ -216,13 +186,7 @@
"label": "{\n http,\n id,\n namespaceType,\n signal,\n}", "label": "{\n http,\n id,\n namespaceType,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "ApiCallByIdProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByIdProps",
"text": "ApiCallByIdProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -241,14 +205,8 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, id, namespaceType, signal, }: ", "({ http, id, namespaceType, signal, }: ",
{ "ApiCallByIdProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types", ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByIdProps",
"text": "ApiCallByIdProps"
},
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -261,13 +219,7 @@
"label": "{\n http,\n id,\n namespaceType,\n signal,\n}", "label": "{\n http,\n id,\n namespaceType,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "ApiCallByIdProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByIdProps",
"text": "ApiCallByIdProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -286,8 +238,14 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ deleteReferences, http, id, ignoreReferences, signal, }: ", "({ deleteReferences, http, id, ignoreReferences, signal, }: ",
"DeleteListParams", {
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" "pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.DeleteListParams",
"text": "DeleteListParams"
},
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -300,7 +258,13 @@
"label": "{\n deleteReferences,\n http,\n id,\n ignoreReferences,\n signal,\n}", "label": "{\n deleteReferences,\n http,\n id,\n ignoreReferences,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
"DeleteListParams" {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.DeleteListParams",
"text": "DeleteListParams"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -323,13 +287,7 @@
], ],
"signature": [ "signature": [
"({ http, id, listId, namespaceType, signal, }: ", "({ http, id, listId, namespaceType, signal, }: ",
{ "ExportExceptionListProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExportExceptionListProps",
"text": "ExportExceptionListProps"
},
") => Promise<Blob>" ") => Promise<Blob>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
@ -343,13 +301,7 @@
"label": "{\n http,\n id,\n listId,\n namespaceType,\n signal,\n}", "label": "{\n http,\n id,\n listId,\n namespaceType,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "ExportExceptionListProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExportExceptionListProps",
"text": "ExportExceptionListProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -368,7 +320,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, listId, signal, }: ", "({ http, listId, signal, }: ",
"ExportListParams", {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ExportListParams",
"text": "ExportListParams"
},
") => Promise<Blob>" ") => Promise<Blob>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
@ -382,7 +340,13 @@
"label": "{\n http,\n listId,\n signal,\n}", "label": "{\n http,\n listId,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
"ExportListParams" {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ExportListParams",
"text": "ExportListParams"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -401,13 +365,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, id, namespaceType, signal, }: ", "({ http, id, namespaceType, signal, }: ",
{ "ApiCallByIdProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByIdProps",
"text": "ApiCallByIdProps"
},
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
@ -421,13 +379,7 @@
"label": "{\n http,\n id,\n namespaceType,\n signal,\n}", "label": "{\n http,\n id,\n namespaceType,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "ApiCallByIdProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByIdProps",
"text": "ApiCallByIdProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -446,14 +398,8 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, id, namespaceType, signal, }: ", "({ http, id, namespaceType, signal, }: ",
{ "ApiCallByIdProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types", ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByIdProps",
"text": "ApiCallByIdProps"
},
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -466,13 +412,7 @@
"label": "{\n http,\n id,\n namespaceType,\n signal,\n}", "label": "{\n http,\n id,\n namespaceType,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "ApiCallByIdProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByIdProps",
"text": "ApiCallByIdProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -491,14 +431,8 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ filterOptions, http, listIds, namespaceTypes, pagination, signal, }: ", "({ filterOptions, http, listIds, namespaceTypes, pagination, signal, }: ",
{ "ApiCallByListIdProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types", ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; }>"
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByListIdProps",
"text": "ApiCallByListIdProps"
},
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -511,13 +445,7 @@
"label": "{\n filterOptions,\n http,\n listIds,\n namespaceTypes,\n pagination,\n signal,\n}", "label": "{\n filterOptions,\n http,\n listIds,\n namespaceTypes,\n pagination,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "ApiCallByListIdProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallByListIdProps",
"text": "ApiCallByListIdProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -536,13 +464,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ filters, http, namespaceTypes, pagination, signal, }: ", "({ filters, http, namespaceTypes, pagination, signal, }: ",
{ "ApiCallFetchExceptionListsProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallFetchExceptionListsProps",
"text": "ApiCallFetchExceptionListsProps"
},
") => Promise<{ data: { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ") => Promise<{ data: { _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
@ -556,13 +478,7 @@
"label": "{\n filters,\n http,\n namespaceTypes,\n pagination,\n signal,\n}", "label": "{\n filters,\n http,\n namespaceTypes,\n pagination,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "ApiCallFetchExceptionListsProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ApiCallFetchExceptionListsProps",
"text": "ApiCallFetchExceptionListsProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -581,8 +497,14 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ cursor, http, pageIndex, pageSize, signal, }: ", "({ cursor, http, pageIndex, pageSize, signal, }: ",
"FindListsParams", {
") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" "pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.FindListsParams",
"text": "FindListsParams"
},
") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -595,7 +517,13 @@
"label": "{\n cursor,\n http,\n pageIndex,\n pageSize,\n signal,\n}", "label": "{\n cursor,\n http,\n pageIndex,\n pageSize,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
"FindListsParams" {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.FindListsParams",
"text": "FindListsParams"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -614,8 +542,14 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ file, http, listId, type, signal, }: ", "({ file, http, listId, type, signal, }: ",
"ImportListParams", {
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" "pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ImportListParams",
"text": "ImportListParams"
},
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -628,7 +562,13 @@
"label": "{\n file,\n http,\n listId,\n type,\n signal,\n}", "label": "{\n file,\n http,\n listId,\n type,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
"ImportListParams" {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ImportListParams",
"text": "ImportListParams"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -647,7 +587,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, signal, }: ", "({ http, signal, }: ",
"ApiParams", {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
},
") => Promise<{ list_index: boolean; list_item_index: boolean; }>" ") => Promise<{ list_index: boolean; list_item_index: boolean; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
@ -661,7 +607,13 @@
"label": "{\n http,\n signal,\n}", "label": "{\n http,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
"ApiParams" {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -680,7 +632,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, signal }: ", "({ http, signal }: ",
"ApiParams", {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
},
") => Promise<unknown>" ") => Promise<unknown>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
@ -694,7 +652,13 @@
"label": "{ http, signal }", "label": "{ http, signal }",
"description": [], "description": [],
"signature": [ "signature": [
"ApiParams" {
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts",
"deprecated": false, "deprecated": false,
@ -778,14 +742,8 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, listItem, signal, }: ", "({ http, listItem, signal, }: ",
{ "UpdateExceptionListItemProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types", ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.UpdateExceptionListItemProps",
"text": "UpdateExceptionListItemProps"
},
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -798,13 +756,7 @@
"label": "{\n http,\n listItem,\n signal,\n}", "label": "{\n http,\n listItem,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "UpdateExceptionListItemProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.UpdateExceptionListItemProps",
"text": "UpdateExceptionListItemProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -823,13 +775,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ http, list, signal, }: ", "({ http, list, signal, }: ",
{ "UpdateExceptionListProps",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.UpdateExceptionListProps",
"text": "UpdateExceptionListProps"
},
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; id: string; immutable: boolean; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"endpoint\" | \"detection\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\"; updated_at: string; updated_by: string; version: number; }>"
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
@ -843,13 +789,7 @@
"label": "{\n http,\n list,\n signal,\n}", "label": "{\n http,\n list,\n signal,\n}",
"description": [], "description": [],
"signature": [ "signature": [
{ "UpdateExceptionListProps"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.UpdateExceptionListProps",
"text": "UpdateExceptionListProps"
}
], ],
"path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "path": "packages/kbn-securitysolution-list-api/src/api/index.ts",
"deprecated": false, "deprecated": false,
@ -860,7 +800,291 @@
"initialIsOpen": false "initialIsOpen": false
} }
], ],
"interfaces": [], "interfaces": [
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ApiParams",
"type": "Interface",
"tags": [],
"label": "ApiParams",
"description": [],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ApiParams.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpStart"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ApiParams.signal",
"type": "Object",
"tags": [],
"label": "signal",
"description": [],
"signature": [
"AbortSignal"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.DeleteListParams",
"type": "Interface",
"tags": [],
"label": "DeleteListParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.DeleteListParams",
"text": "DeleteListParams"
},
" extends ",
{
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
}
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.DeleteListParams.deleteReferences",
"type": "CompoundType",
"tags": [],
"label": "deleteReferences",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.DeleteListParams.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.DeleteListParams.ignoreReferences",
"type": "CompoundType",
"tags": [],
"label": "ignoreReferences",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ExportListParams",
"type": "Interface",
"tags": [],
"label": "ExportListParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ExportListParams",
"text": "ExportListParams"
},
" extends ",
{
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
}
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ExportListParams.listId",
"type": "string",
"tags": [],
"label": "listId",
"description": [],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.FindListsParams",
"type": "Interface",
"tags": [],
"label": "FindListsParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.FindListsParams",
"text": "FindListsParams"
},
" extends ",
{
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
}
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.FindListsParams.cursor",
"type": "string",
"tags": [],
"label": "cursor",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.FindListsParams.pageSize",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.FindListsParams.pageIndex",
"type": "number",
"tags": [],
"label": "pageIndex",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ImportListParams",
"type": "Interface",
"tags": [],
"label": "ImportListParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ImportListParams",
"text": "ImportListParams"
},
" extends ",
{
"pluginId": "@kbn/securitysolution-list-api",
"scope": "common",
"docId": "kibKbnSecuritysolutionListApiPluginApi",
"section": "def-common.ApiParams",
"text": "ApiParams"
}
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ImportListParams.file",
"type": "Object",
"tags": [],
"label": "file",
"description": [],
"signature": [
"File"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ImportListParams.listId",
"type": "string",
"tags": [],
"label": "listId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/securitysolution-list-api",
"id": "def-common.ImportListParams.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined"
],
"path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [], "enums": [],
"misc": [], "misc": [],
"objects": [] "objects": []

5
api_docs/kbn_securitysolution_list_api.mdx
View file

@ -18,10 +18,13 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 42 | 0 | 41 | 5 | | 59 | 0 | 58 | 0 |
## Common ## Common
### Functions ### Functions
<DocDefinitionList data={kbnSecuritysolutionListApiObj.common.functions}/> <DocDefinitionList data={kbnSecuritysolutionListApiObj.common.functions}/>
### Interfaces
<DocDefinitionList data={kbnSecuritysolutionListApiObj.common.interfaces}/>

288
api_docs/kbn_securitysolution_list_hooks.json
View file

File diff suppressed because one or more lines are too long

274
api_docs/kbn_securitysolution_list_utils.json
View file

@ -27,7 +27,7 @@
"label": "addIdToEntries", "label": "addIdToEntries",
"description": [], "description": [],
"signature": [ "signature": [
"(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" "(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false, "deprecated": false,
@ -40,7 +40,7 @@
"label": "entries", "label": "entries",
"description": [], "description": [],
"signature": [ "signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false, "deprecated": false,
@ -58,7 +58,7 @@
"label": "buildExceptionFilter", "label": "buildExceptionFilter",
"description": [], "description": [],
"signature": [ "signature": [
"({ lists, excludeExceptions, chunkSize, }: { lists: ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]; excludeExceptions: boolean; chunkSize: number; }) => ", "({ lists, excludeExceptions, chunkSize, }: { lists: ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]; excludeExceptions: boolean; chunkSize: number; }) => ",
"Filter", "Filter",
" | undefined" " | undefined"
], ],
@ -83,7 +83,7 @@
"label": "lists", "label": "lists",
"description": [], "description": [],
"signature": [ "signature": [
"({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" "({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts",
"deprecated": false "deprecated": false
@ -690,7 +690,7 @@
"section": "def-common.ExceptionsBuilderExceptionItem", "section": "def-common.ExceptionsBuilderExceptionItem",
"text": "ExceptionsBuilderExceptionItem" "text": "ExceptionsBuilderExceptionItem"
}, },
"[]) => ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" "[]) => ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false, "deprecated": false,
@ -944,7 +944,7 @@
"section": "def-common.FormattedBuilderEntry", "section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry" "text": "FormattedBuilderEntry"
}, },
") => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }" ") => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false, "deprecated": false,
@ -1086,7 +1086,7 @@
"section": "def-common.FormattedBuilderEntry", "section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry" "text": "FormattedBuilderEntry"
}, },
", newField: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }) => { index: number; updatedEntry: ", ", newField: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }) => { index: number; updatedEntry: ",
{ {
"pluginId": "@kbn/securitysolution-list-utils", "pluginId": "@kbn/securitysolution-list-utils",
"scope": "common", "scope": "common",
@ -1131,7 +1131,7 @@
"- newly selected list" "- newly selected list"
], ],
"signature": [ "signature": [
"{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }" "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false, "deprecated": false,
@ -1916,13 +1916,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"(filters: ", "(filters: ",
{ "ExceptionListFilter",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListFilter",
"text": "ExceptionListFilter"
},
", namespaceTypes: ", ", namespaceTypes: ",
{ {
"pluginId": "@kbn/securitysolution-list-utils", "pluginId": "@kbn/securitysolution-list-utils",
@ -1944,13 +1938,7 @@
"label": "filters", "label": "filters",
"description": [], "description": [],
"signature": [ "signature": [
{ "ExceptionListFilter"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListFilter",
"text": "ExceptionListFilter"
}
], ],
"path": "packages/kbn-securitysolution-list-utils/src/get_general_filters/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/get_general_filters/index.ts",
"deprecated": false, "deprecated": false,
@ -1990,13 +1978,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ lists, showDetection, showEndpoint, }: { lists: ", "({ lists, showDetection, showEndpoint, }: { lists: ",
{ "ExceptionListIdentifiers",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListIdentifiers",
"text": "ExceptionListIdentifiers"
},
"[]; showDetection: boolean; showEndpoint: boolean; }) => { ids: string[]; namespaces: (\"single\" | \"agnostic\")[]; }" "[]; showDetection: boolean; showEndpoint: boolean; }) => { ids: string[]; namespaces: (\"single\" | \"agnostic\")[]; }"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts",
@ -2020,13 +2002,7 @@
"label": "lists", "label": "lists",
"description": [], "description": [],
"signature": [ "signature": [
{ "ExceptionListIdentifiers",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListIdentifiers",
"text": "ExceptionListIdentifiers"
},
"[]" "[]"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts",
@ -2245,13 +2221,7 @@
"text": "BuilderEntry" "text": "BuilderEntry"
}, },
") => ", ") => ",
{ "ListOperatorTypeEnum"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
}
], ],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false, "deprecated": false,
@ -2533,7 +2503,7 @@
"label": "hasLargeValueList", "label": "hasLargeValueList",
"description": [], "description": [],
"signature": [ "signature": [
"(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => boolean" "(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => boolean"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts",
"deprecated": false, "deprecated": false,
@ -2546,7 +2516,7 @@
"label": "entries", "label": "entries",
"description": [], "description": [],
"signature": [ "signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts",
"deprecated": false, "deprecated": false,
@ -2721,13 +2691,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
}
], ],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false "deprecated": false
@ -2740,29 +2704,11 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH | ", ".MATCH | ",
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH_ANY | ", ".MATCH_ANY | ",
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".WILDCARD" ".WILDCARD"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
@ -2825,13 +2771,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
}
], ],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false "deprecated": false
@ -2844,13 +2784,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".LIST" ".LIST"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
@ -2913,13 +2847,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".NESTED" ".NESTED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
@ -3086,13 +3014,7 @@
"label": "filters", "label": "filters",
"description": [], "description": [],
"signature": [ "signature": [
{ "ExceptionListFilter"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListFilter",
"text": "ExceptionListFilter"
}
], ],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false "deprecated": false
@ -3207,13 +3129,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
}
], ],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false "deprecated": false
@ -3226,13 +3142,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum"
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
}
], ],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false "deprecated": false
@ -3251,7 +3161,7 @@
"label": "BuilderEntry", "label": "BuilderEntry",
"description": [], "description": [],
"signature": [ "signature": [
"(({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }) | ", "(({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }) | ",
{ {
"pluginId": "@kbn/securitysolution-list-utils", "pluginId": "@kbn/securitysolution-list-utils",
"scope": "common", "scope": "common",
@ -3310,7 +3220,7 @@
"label": "CreateExceptionListItemBuilderSchema", "label": "CreateExceptionListItemBuilderSchema",
"description": [], "description": [],
"signature": [ "signature": [
"Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"meta\" | \"entries\"> & { meta: { temporaryUuid: string; }; entries: ", "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"meta\" | \"entries\"> & { meta: { temporaryUuid: string; }; entries: ",
{ {
"pluginId": "@kbn/securitysolution-list-utils", "pluginId": "@kbn/securitysolution-list-utils",
"scope": "common", "scope": "common",
@ -3444,7 +3354,7 @@
"label": "ExceptionListItemBuilderSchema", "label": "ExceptionListItemBuilderSchema",
"description": [], "description": [],
"signature": [ "signature": [
"Omit<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }, \"entries\"> & { entries: ", "Omit<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }, \"entries\"> & { entries: ",
{ {
"pluginId": "@kbn/securitysolution-list-utils", "pluginId": "@kbn/securitysolution-list-utils",
"scope": "common", "scope": "common",
@ -3544,13 +3454,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED" ".EXCLUDED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3564,13 +3468,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".EXISTS" ".EXISTS"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3617,13 +3515,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED" ".INCLUDED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3637,13 +3529,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".EXISTS" ".EXISTS"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3690,13 +3576,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED" ".INCLUDED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3710,13 +3590,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".LIST" ".LIST"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3763,13 +3637,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED" ".EXCLUDED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3783,13 +3651,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".LIST" ".LIST"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3836,13 +3698,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED" ".EXCLUDED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3856,13 +3712,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH_ANY" ".MATCH_ANY"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3909,13 +3759,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED" ".EXCLUDED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3929,13 +3773,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH" ".MATCH"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -3982,13 +3820,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED" ".INCLUDED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -4002,13 +3834,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH_ANY" ".MATCH_ANY"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -4055,13 +3881,7 @@
"label": "operator", "label": "operator",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED" ".INCLUDED"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
@ -4075,13 +3895,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
{ "ListOperatorTypeEnum",
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH" ".MATCH"
], ],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts", "path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",

8
api_docs/kbn_test.json
View file

@ -2166,7 +2166,7 @@
"\nDetermine if a service is avaliable" "\nDetermine if a service is avaliable"
], ],
"signature": [ "signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }" "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }"
], ],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts", "path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false, "deprecated": false,
@ -2179,7 +2179,7 @@
"label": "serviceName", "label": "serviceName",
"description": [], "description": [],
"signature": [ "signature": [
"\"config\" | \"log\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"" "\"log\" | \"config\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\""
], ],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts", "path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false, "deprecated": false,
@ -2196,7 +2196,7 @@
"label": "hasService", "label": "hasService",
"description": [], "description": [],
"signature": [ "signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }" "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }"
], ],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts", "path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false, "deprecated": false,
@ -2226,7 +2226,7 @@
"label": "hasService", "label": "hasService",
"description": [], "description": [],
"signature": [ "signature": [
"{ (serviceName: \"config\" | \"log\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }" "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"failureMetadata\" | \"dockerServers\"): true; <K extends keyof ServiceMap>(serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract<keyof ServiceMap, string>; }"
], ],
"path": "packages/kbn-test/src/functional_test_runner/public_types.ts", "path": "packages/kbn-test/src/functional_test_runner/public_types.ts",
"deprecated": false, "deprecated": false,

4
api_docs/lens.json
View file

@ -3268,7 +3268,7 @@
"label": "OperationTypePost712", "label": "OperationTypePost712",
"description": [], "description": [],
"signature": [ "signature": [
"\"filters\" | \"max\" | \"min\" | \"count\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"range\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"unique_count\" | \"last_value\" | \"counter_rate\" | \"differences\"" "\"filters\" | \"max\" | \"min\" | \"count\" | \"sum\" | \"median\" | \"date_histogram\" | \"average\" | \"percentile\" | \"range\" | \"terms\" | \"cumulative_sum\" | \"moving_average\" | \"unique_count\" | \"last_value\" | \"counter_rate\" | \"differences\""
], ],
"path": "x-pack/plugins/lens/server/migrations/types.ts", "path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false, "deprecated": false,
@ -3282,7 +3282,7 @@
"label": "OperationTypePre712", "label": "OperationTypePre712",
"description": [], "description": [],
"signature": [ "signature": [
"\"filters\" | \"max\" | \"min\" | \"count\" | \"date_histogram\" | \"sum\" | \"percentile\" | \"range\" | \"terms\" | \"avg\" | \"median\" | \"cumulative_sum\" | \"derivative\" | \"moving_average\" | \"cardinality\" | \"last_value\" | \"counter_rate\"" "\"filters\" | \"max\" | \"min\" | \"count\" | \"sum\" | \"avg\" | \"median\" | \"date_histogram\" | \"percentile\" | \"range\" | \"terms\" | \"cumulative_sum\" | \"derivative\" | \"moving_average\" | \"cardinality\" | \"last_value\" | \"counter_rate\""
], ],
"path": "x-pack/plugins/lens/server/migrations/types.ts", "path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false, "deprecated": false,

64
api_docs/lists.json
View file

@ -311,7 +311,7 @@
"label": "exceptionItems", "label": "exceptionItems",
"description": [], "description": [],
"signature": [ "signature": [
"({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" "({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]"
], ],
"path": "x-pack/plugins/lists/public/exceptions/components/builder/exception_items_renderer.tsx", "path": "x-pack/plugins/lists/public/exceptions/components/builder/exception_items_renderer.tsx",
"deprecated": false "deprecated": false
@ -324,7 +324,7 @@
"label": "exceptionsToDelete", "label": "exceptionsToDelete",
"description": [], "description": [],
"signature": [ "signature": [
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]" "{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]"
], ],
"path": "x-pack/plugins/lists/public/exceptions/components/builder/exception_items_renderer.tsx", "path": "x-pack/plugins/lists/public/exceptions/components/builder/exception_items_renderer.tsx",
"deprecated": false "deprecated": false
@ -504,7 +504,7 @@
"signature": [ "signature": [
"({ itemId, id, namespaceType, }: ", "({ itemId, id, namespaceType, }: ",
"GetExceptionListItemOptions", "GetExceptionListItemOptions",
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -576,7 +576,7 @@
"signature": [ "signature": [
"({ comments, description, entries, itemId, meta, name, osTypes, tags, type, }: ", "({ comments, description, entries, itemId, meta, name, osTypes, tags, type, }: ",
"CreateEndpointListItemOptions", "CreateEndpointListItemOptions",
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -610,7 +610,7 @@
"signature": [ "signature": [
"({ _version, comments, description, entries, id, itemId, meta, name, osTypes, tags, type, }: ", "({ _version, comments, description, entries, id, itemId, meta, name, osTypes, tags, type, }: ",
"UpdateEndpointListItemOptions", "UpdateEndpointListItemOptions",
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -644,7 +644,7 @@
"signature": [ "signature": [
"({ itemId, id, }: ", "({ itemId, id, }: ",
"GetEndpointListItemOptions", "GetEndpointListItemOptions",
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -832,7 +832,7 @@
"section": "def-server.CreateExceptionListItemOptions", "section": "def-server.CreateExceptionListItemOptions",
"text": "CreateExceptionListItemOptions" "text": "CreateExceptionListItemOptions"
}, },
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>" ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -894,7 +894,7 @@
"section": "def-server.UpdateExceptionListItemOptions", "section": "def-server.UpdateExceptionListItemOptions",
"text": "UpdateExceptionListItemOptions" "text": "UpdateExceptionListItemOptions"
}, },
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -941,7 +941,7 @@
"signature": [ "signature": [
"({ id, itemId, namespaceType, }: ", "({ id, itemId, namespaceType, }: ",
"DeleteExceptionListItemOptions", "DeleteExceptionListItemOptions",
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -1015,7 +1015,7 @@
"signature": [ "signature": [
"({ id, itemId, }: ", "({ id, itemId, }: ",
"DeleteEndpointListItemOptions", "DeleteEndpointListItemOptions",
") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>" ") => Promise<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -1047,7 +1047,7 @@
"signature": [ "signature": [
"({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: ", "({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: ",
"FindExceptionListItemOptions", "FindExceptionListItemOptions",
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -1079,7 +1079,7 @@
"signature": [ "signature": [
"({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: ", "({ listId, filter, perPage, page, sortField, sortOrder, namespaceType, }: ",
"FindExceptionListsItemOptions", "FindExceptionListsItemOptions",
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -1111,7 +1111,7 @@
"signature": [ "signature": [
"({ perPage, page, sortField, sortOrder, valueListId, }: ", "({ perPage, page, sortField, sortOrder, valueListId, }: ",
"FindValueListExceptionListsItems", "FindValueListExceptionListsItems",
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -1177,7 +1177,7 @@
"signature": [ "signature": [
"({ filter, perPage, page, sortField, sortOrder, }: ", "({ filter, perPage, page, sortField, sortOrder, }: ",
"FindEndpointListItemOptions", "FindEndpointListItemOptions",
") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>" ") => Promise<{ data: { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }[]; page: number; per_page: number; total: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts",
"deprecated": false, "deprecated": false,
@ -1413,7 +1413,7 @@
"signature": [ "signature": [
"({ id }: ", "({ id }: ",
"GetListOptions", "GetListOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -1445,7 +1445,7 @@
"signature": [ "signature": [
"({ id, deserializer, immutable, serializer, name, description, type, meta, version, }: ", "({ id, deserializer, immutable, serializer, name, description, type, meta, version, }: ",
"CreateListOptions", "CreateListOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -1477,7 +1477,7 @@
"signature": [ "signature": [
"({ id, deserializer, serializer, name, description, immutable, type, meta, version, }: ", "({ id, deserializer, serializer, name, description, immutable, type, meta, version, }: ",
"CreateListIfItDoesNotExistOptions", "CreateListIfItDoesNotExistOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -1809,7 +1809,7 @@
"signature": [ "signature": [
"({ id }: ", "({ id }: ",
"DeleteListItemOptions", "DeleteListItemOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -1841,7 +1841,7 @@
"signature": [ "signature": [
"({ listId, value, type, }: ", "({ listId, value, type, }: ",
"DeleteListItemByValueOptions", "DeleteListItemByValueOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -1873,7 +1873,7 @@
"signature": [ "signature": [
"({ id }: ", "({ id }: ",
"DeleteListOptions", "DeleteListOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -1937,7 +1937,7 @@
"signature": [ "signature": [
"({ deserializer, serializer, type, listId, stream, meta, version, }: ", "({ deserializer, serializer, type, listId, stream, meta, version, }: ",
"ImportListItemsToStreamOptions", "ImportListItemsToStreamOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -1969,7 +1969,7 @@
"signature": [ "signature": [
"({ listId, value, type, }: ", "({ listId, value, type, }: ",
"GetListItemByValueOptions", "GetListItemByValueOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2001,7 +2001,7 @@
"signature": [ "signature": [
"({ id, deserializer, serializer, listId, value, type, meta, }: ", "({ id, deserializer, serializer, listId, value, type, meta, }: ",
"CreateListItemOptions", "CreateListItemOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2033,7 +2033,7 @@
"signature": [ "signature": [
"({ _version, id, value, meta, }: ", "({ _version, id, value, meta, }: ",
"UpdateListItemOptions", "UpdateListItemOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2065,7 +2065,7 @@
"signature": [ "signature": [
"({ _version, id, name, description, meta, version, }: ", "({ _version, id, name, description, meta, version, }: ",
"UpdateListOptions", "UpdateListOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; } | null>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2097,7 +2097,7 @@
"signature": [ "signature": [
"({ id }: ", "({ id }: ",
"GetListItemOptions", "GetListItemOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; } | null>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2129,7 +2129,7 @@
"signature": [ "signature": [
"({ type, listId, value, }: ", "({ type, listId, value, }: ",
"GetListItemsByValueOptions", "GetListItemsByValueOptions",
") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]>" ") => Promise<{ _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2161,7 +2161,7 @@
"signature": [ "signature": [
"({ type, listId, value, }: ", "({ type, listId, value, }: ",
"SearchListItemByValuesOptions", "SearchListItemByValuesOptions",
") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" ") => Promise<{ items: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2193,7 +2193,7 @@
"signature": [ "signature": [
"({ filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", "({ filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ",
"FindListOptions", "FindListOptions",
") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2225,7 +2225,7 @@
"signature": [ "signature": [
"({ listId, filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", "({ listId, filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ",
"FindListItemOptions", "FindListItemOptions",
") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" ") => Promise<{ cursor: string; data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>"
], ],
"path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "path": "x-pack/plugins/lists/server/services/lists/list_client.ts",
"deprecated": false, "deprecated": false,
@ -2284,7 +2284,7 @@
"label": "entries", "label": "entries",
"description": [], "description": [],
"signature": [ "signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts",
"deprecated": false "deprecated": false
@ -2534,7 +2534,7 @@
"label": "entries", "label": "entries",
"description": [], "description": [],
"signature": [ "signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"date_nanos\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]" "({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"long\" | \"double\" | \"text\" | \"binary\" | \"date_nanos\" | \"integer\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
], ],
"path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts",
"deprecated": false "deprecated": false

11
api_docs/maps.json
View file

@ -3216,6 +3216,17 @@
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
}, },
{
"parentPluginId": "maps",
"id": "def-common.SCALING_TYPES",
"type": "Enum",
"tags": [],
"label": "SCALING_TYPES",
"description": [],
"path": "x-pack/plugins/maps/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{ {
"parentPluginId": "maps", "parentPluginId": "maps",
"id": "def-common.SOURCE_TYPES", "id": "def-common.SOURCE_TYPES",

2
api_docs/maps.mdx
View file

@ -18,7 +18,7 @@ Contact [GIS](https://github.com/orgs/elastic/teams/kibana-gis) for questions re
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 206 | 0 | 205 | 30 | | 207 | 0 | 206 | 30 |
## Client ## Client

17
api_docs/plugin_directory.mdx
View file

@ -12,13 +12,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| Count | Plugins or Packages with a <br /> public API | Number of teams | | Count | Plugins or Packages with a <br /> public API | Number of teams |
|--------------|----------|------------------------| |--------------|----------|------------------------|
| 206 | 162 | 30 | | 206 | 163 | 30 |
### Public API health stats ### Public API health stats
| API Count | Any Count | Missing comments | Missing exports | | API Count | Any Count | Missing comments | Missing exports |
|--------------|----------|-----------------|--------| |--------------|----------|-----------------|--------|
| 23139 | 166 | 18496 | 1693 | | 23158 | 167 | 18516 | 1716 |
## Plugin Directory ## Plugin Directory
@ -40,12 +40,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibCustomIntegrationsPluginApi" text="customIntegrations"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 96 | 0 | 80 | 1 | | <DocLink id="kibCustomIntegrationsPluginApi" text="customIntegrations"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 96 | 0 | 80 | 1 |
| <DocLink id="kibDashboardPluginApi" text="dashboard"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 154 | 0 | 141 | 13 | | <DocLink id="kibDashboardPluginApi" text="dashboard"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 154 | 0 | 141 | 13 |
| <DocLink id="kibDashboardEnhancedPluginApi" text="dashboardEnhanced"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 51 | 0 | 50 | 0 | | <DocLink id="kibDashboardEnhancedPluginApi" text="dashboardEnhanced"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 51 | 0 | 50 | 0 |
| <DocLink id="kibDataPluginApi" text="data"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3334 | 39 | 2933 | 26 | | <DocLink id="kibDataPluginApi" text="data"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3337 | 39 | 2936 | 26 |
| <DocLink id="kibDataEnhancedPluginApi" text="dataEnhanced"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Enhanced data plugin. (See src/plugins/data.) Enhances the main data plugin with a search session management UI. Includes a reusable search session indicator component to use in other applications. Exposes routes for managing search sessions. Includes a service that monitors, updates, and cleans up search session saved objects. | 16 | 0 | 16 | 2 | | <DocLink id="kibDataEnhancedPluginApi" text="dataEnhanced"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Enhanced data plugin. (See src/plugins/data.) Enhances the main data plugin with a search session management UI. Includes a reusable search session indicator component to use in other applications. Exposes routes for managing search sessions. Includes a service that monitors, updates, and cleans up search session saved objects. | 16 | 0 | 16 | 2 |
| <DocLink id="kibDataViewEditorPluginApi" text="dataViewEditor"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 13 | 0 | 9 | 0 | | <DocLink id="kibDataViewEditorPluginApi" text="dataViewEditor"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 13 | 0 | 9 | 0 |
| <DocLink id="kibDataViewFieldEditorPluginApi" text="dataViewFieldEditor"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 42 | 0 | 39 | 3 | | <DocLink id="kibDataViewFieldEditorPluginApi" text="dataViewFieldEditor"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 42 | 0 | 39 | 3 |
| <DocLink id="kibDataViewManagementPluginApi" text="dataViewManagement"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data view management app | 2 | 0 | 2 | 0 | | <DocLink id="kibDataViewManagementPluginApi" text="dataViewManagement"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data view management app | 2 | 0 | 2 | 0 |
| <DocLink id="kibDataViewsPluginApi" text="dataViews"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 712 | 3 | 564 | 6 | | <DocLink id="kibDataViewsPluginApi" text="dataViews"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 714 | 3 | 566 | 6 |
| <DocLink id="kibDataVisualizerPluginApi" text="dataVisualizer"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 84 | 2 | 84 | 0 | | <DocLink id="kibDataVisualizerPluginApi" text="dataVisualizer"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 84 | 2 | 84 | 0 |
| <DocLink id="kibDevToolsPluginApi" text="devTools"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 10 | 0 | 8 | 2 | | <DocLink id="kibDevToolsPluginApi" text="devTools"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 10 | 0 | 8 | 2 |
| <DocLink id="kibDiscoverPluginApi" text="discover"/> | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 89 | 0 | 61 | 7 | | <DocLink id="kibDiscoverPluginApi" text="discover"/> | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 89 | 0 | 61 | 7 |
@ -95,7 +95,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibListsPluginApi" text="lists"/> | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 164 | 0 | 144 | 41 | | <DocLink id="kibListsPluginApi" text="lists"/> | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 164 | 0 | 144 | 41 |
| logstash | [Logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | | logstash | [Logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibManagementPluginApi" text="management"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 41 | 0 | 41 | 6 | | <DocLink id="kibManagementPluginApi" text="management"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 41 | 0 | 41 | 6 |
| <DocLink id="kibMapsPluginApi" text="maps"/> | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 206 | 0 | 205 | 30 | | <DocLink id="kibMapsPluginApi" text="maps"/> | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 207 | 0 | 206 | 30 |
| <DocLink id="kibMapsEmsPluginApi" text="mapsEms"/> | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 64 | 0 | 64 | 0 | | <DocLink id="kibMapsEmsPluginApi" text="mapsEms"/> | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 64 | 0 | 64 | 0 |
| <DocLink id="kibMetricsEntitiesPluginApi" text="metricsEntities"/> | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 4 | 0 | 4 | 1 | | <DocLink id="kibMetricsEntitiesPluginApi" text="metricsEntities"/> | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 4 | 0 | 4 | 1 |
| <DocLink id="kibMlPluginApi" text="ml"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 291 | 8 | 287 | 35 | | <DocLink id="kibMlPluginApi" text="ml"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 291 | 8 | 287 | 35 |
@ -107,7 +107,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibPresentationUtilPluginApi" text="presentationUtil"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 318 | 2 | 278 | 14 | | <DocLink id="kibPresentationUtilPluginApi" text="presentationUtil"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 318 | 2 | 278 | 14 |
| <DocLink id="kibRemoteClustersPluginApi" text="remoteClusters"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 4 | 0 | 4 | 0 | | <DocLink id="kibRemoteClustersPluginApi" text="remoteClusters"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 4 | 0 | 4 | 0 |
| <DocLink id="kibReportingPluginApi" text="reporting"/> | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Reporting Services enables applications to feature reports that the user can automate with Watcher and download later. | 166 | 0 | 163 | 15 | | <DocLink id="kibReportingPluginApi" text="reporting"/> | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Reporting Services enables applications to feature reports that the user can automate with Watcher and download later. | 126 | 0 | 125 | 13 |
| <DocLink id="kibRollupPluginApi" text="rollup"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 21 | 0 | 21 | 0 | | <DocLink id="kibRollupPluginApi" text="rollup"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 21 | 0 | 21 | 0 |
| <DocLink id="kibRuleRegistryPluginApi" text="ruleRegistry"/> | [RAC](https://github.com/orgs/elastic/teams/rac) | - | 175 | 0 | 148 | 7 | | <DocLink id="kibRuleRegistryPluginApi" text="ruleRegistry"/> | [RAC](https://github.com/orgs/elastic/teams/rac) | - | 175 | 0 | 148 | 7 |
| <DocLink id="kibRuntimeFieldsPluginApi" text="runtimeFields"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 24 | 0 | 19 | 2 | | <DocLink id="kibRuntimeFieldsPluginApi" text="runtimeFields"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 24 | 0 | 19 | 2 |
@ -177,6 +177,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibKbnEsQueryPluginApi" text="@kbn/es-query"/> | [Owner missing] | - | 212 | 1 | 160 | 11 | | <DocLink id="kibKbnEsQueryPluginApi" text="@kbn/es-query"/> | [Owner missing] | - | 212 | 1 | 160 | 11 |
| <DocLink id="kibKbnFieldTypesPluginApi" text="@kbn/field-types"/> | [Owner missing] | - | 20 | 0 | 16 | 0 | | <DocLink id="kibKbnFieldTypesPluginApi" text="@kbn/field-types"/> | [Owner missing] | - | 20 | 0 | 16 | 0 |
| <DocLink id="kibKbnI18nPluginApi" text="@kbn/i18n"/> | [Owner missing] | - | 51 | 0 | 48 | 0 | | <DocLink id="kibKbnI18nPluginApi" text="@kbn/i18n"/> | [Owner missing] | - | 51 | 0 | 48 | 0 |
| <DocLink id="kibKbnInterpreterPluginApi" text="@kbn/interpreter"/> | [Owner missing] | - | 30 | 1 | 30 | 1 |
| <DocLink id="kibKbnIoTsUtilsPluginApi" text="@kbn/io-ts-utils"/> | [Owner missing] | - | 18 | 0 | 18 | 3 | | <DocLink id="kibKbnIoTsUtilsPluginApi" text="@kbn/io-ts-utils"/> | [Owner missing] | - | 18 | 0 | 18 | 3 |
| <DocLink id="kibKbnLoggingPluginApi" text="@kbn/logging"/> | [Owner missing] | - | 30 | 0 | 5 | 36 | | <DocLink id="kibKbnLoggingPluginApi" text="@kbn/logging"/> | [Owner missing] | - | 30 | 0 | 5 | 36 |
| <DocLink id="kibKbnMapboxGlPluginApi" text="@kbn/mapbox-gl"/> | [Owner missing] | - | 466 | 1 | 377 | 0 | | <DocLink id="kibKbnMapboxGlPluginApi" text="@kbn/mapbox-gl"/> | [Owner missing] | - | 466 | 1 | 377 | 0 |
@ -189,12 +190,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibKbnRuleDataUtilsPluginApi" text="@kbn/rule-data-utils"/> | [Owner missing] | - | 71 | 0 | 68 | 0 | | <DocLink id="kibKbnRuleDataUtilsPluginApi" text="@kbn/rule-data-utils"/> | [Owner missing] | - | 71 | 0 | 68 | 0 |
| <DocLink id="kibKbnSecuritysolutionAutocompletePluginApi" text="@kbn/securitysolution-autocomplete"/> | [Owner missing] | Security Solution auto complete | 47 | 1 | 34 | 0 | | <DocLink id="kibKbnSecuritysolutionAutocompletePluginApi" text="@kbn/securitysolution-autocomplete"/> | [Owner missing] | Security Solution auto complete | 47 | 1 | 34 | 0 |
| <DocLink id="kibKbnSecuritysolutionEsUtilsPluginApi" text="@kbn/securitysolution-es-utils"/> | [Owner missing] | security solution elastic search utilities to use across plugins such lists, security_solution, cases, etc... | 57 | 0 | 51 | 1 | | <DocLink id="kibKbnSecuritysolutionEsUtilsPluginApi" text="@kbn/securitysolution-es-utils"/> | [Owner missing] | security solution elastic search utilities to use across plugins such lists, security_solution, cases, etc... | 57 | 0 | 51 | 1 |
| <DocLink id="kibKbnSecuritysolutionHookUtilsPluginApi" text="@kbn/securitysolution-hook-utils"/> | [Owner missing] | Security Solution utilities for React hooks | 8 | 0 | 1 | 1 | | <DocLink id="kibKbnSecuritysolutionHookUtilsPluginApi" text="@kbn/securitysolution-hook-utils"/> | [Owner missing] | Security Solution utilities for React hooks | 14 | 0 | 6 | 0 |
| <DocLink id="kibKbnSecuritysolutionIoTsAlertingTypesPluginApi" text="@kbn/securitysolution-io-ts-alerting-types"/> | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 147 | 0 | 128 | 0 | | <DocLink id="kibKbnSecuritysolutionIoTsAlertingTypesPluginApi" text="@kbn/securitysolution-io-ts-alerting-types"/> | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 147 | 0 | 128 | 0 |
| <DocLink id="kibKbnSecuritysolutionIoTsListTypesPluginApi" text="@kbn/securitysolution-io-ts-list-types"/> | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 439 | 1 | 428 | 0 | | <DocLink id="kibKbnSecuritysolutionIoTsListTypesPluginApi" text="@kbn/securitysolution-io-ts-list-types"/> | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 439 | 1 | 428 | 0 |
| <DocLink id="kibKbnSecuritysolutionIoTsTypesPluginApi" text="@kbn/securitysolution-io-ts-types"/> | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 48 | 0 | 26 | 0 | | <DocLink id="kibKbnSecuritysolutionIoTsTypesPluginApi" text="@kbn/securitysolution-io-ts-types"/> | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 48 | 0 | 26 | 0 |
| <DocLink id="kibKbnSecuritysolutionIoTsUtilsPluginApi" text="@kbn/securitysolution-io-ts-utils"/> | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 28 | 0 | 22 | 0 | | <DocLink id="kibKbnSecuritysolutionIoTsUtilsPluginApi" text="@kbn/securitysolution-io-ts-utils"/> | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 28 | 0 | 22 | 0 |
| <DocLink id="kibKbnSecuritysolutionListApiPluginApi" text="@kbn/securitysolution-list-api"/> | [Owner missing] | security solution list REST API | 42 | 0 | 41 | 5 | | <DocLink id="kibKbnSecuritysolutionListApiPluginApi" text="@kbn/securitysolution-list-api"/> | [Owner missing] | security solution list REST API | 59 | 0 | 58 | 0 |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" text="@kbn/securitysolution-list-constants"/> | [Owner missing] | security solution list constants to use across plugins such lists, security_solution, cases, etc... | 23 | 0 | 9 | 0 | | <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" text="@kbn/securitysolution-list-constants"/> | [Owner missing] | security solution list constants to use across plugins such lists, security_solution, cases, etc... | 23 | 0 | 9 | 0 |
| <DocLink id="kibKbnSecuritysolutionListHooksPluginApi" text="@kbn/securitysolution-list-hooks"/> | [Owner missing] | Security solution list ReactJS hooks | 56 | 0 | 44 | 0 | | <DocLink id="kibKbnSecuritysolutionListHooksPluginApi" text="@kbn/securitysolution-list-hooks"/> | [Owner missing] | Security solution list ReactJS hooks | 56 | 0 | 44 | 0 |
| <DocLink id="kibKbnSecuritysolutionListUtilsPluginApi" text="@kbn/securitysolution-list-utils"/> | [Owner missing] | security solution list utilities | 223 | 0 | 178 | 0 | | <DocLink id="kibKbnSecuritysolutionListUtilsPluginApi" text="@kbn/securitysolution-list-utils"/> | [Owner missing] | security solution list utilities | 223 | 0 | 178 | 0 |

734
api_docs/reporting.json
View file

@ -873,290 +873,9 @@
} }
], ],
"functions": [], "functions": [],
"interfaces": [ "interfaces": [],
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsDownloadCSV",
"type": "Interface",
"tags": [],
"label": "JobParamsDownloadCSV",
"description": [],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsDownloadCSV.browserTimezone",
"type": "string",
"tags": [],
"label": "browserTimezone",
"description": [],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsDownloadCSV.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsDownloadCSV.searchSource",
"type": "Object",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
"{ type?: string | undefined; query?: ",
"Query",
" | undefined; filter?: ",
"Filter",
"[] | undefined; sort?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.EsQuerySortValue",
"text": "EsQuerySortValue"
},
"[] | undefined; highlight?: ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; highlightAll?: boolean | undefined; trackTotalHits?: number | boolean | undefined; aggs?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; schema?: string | undefined; }[] | undefined; from?: number | undefined; size?: number | undefined; source?: boolean | ",
"Fields",
" | undefined; version?: boolean | undefined; fields?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchFieldValue",
"text": "SearchFieldValue"
},
"[] | undefined; fieldsFromSource?: ",
"Fields",
" | undefined; index?: string | undefined; searchAfter?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.EsQuerySearchAfter",
"text": "EsQuerySearchAfter"
},
" | undefined; timeout?: string | undefined; terminate_after?: number | undefined; parent?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SerializedSearchSourceFields",
"text": "SerializedSearchSourceFields"
},
" | undefined; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsDownloadCSV.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsPNGV2",
"type": "Interface",
"tags": [],
"label": "JobParamsPNGV2",
"description": [],
"signature": [
"JobParamsPNGV2",
" extends { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/png_v2.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsPNGV2.layout",
"type": "Object",
"tags": [],
"label": "layout",
"description": [],
"signature": [
"{ id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/png_v2.ts",
"deprecated": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsPNGV2.locatorParams",
"type": "Object",
"tags": [],
"label": "locatorParams",
"description": [
"\nThis value is used to re-create the same visual state as when the report was requested as well as navigate to the correct page."
],
"signature": [
"LocatorParams",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "x-pack/plugins/reporting/common/types/export_types/png_v2.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [], "enums": [],
"misc": [ "misc": [],
{
"parentPluginId": "reporting",
"id": "def-public.JobAppParamsPDF",
"type": "Type",
"tags": [],
"label": "JobAppParamsPDF",
"description": [],
"signature": [
"{ title: string; layout: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; }; objectType: string; relativeUrls: string[]; isDeprecated?: boolean | undefined; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/printable_pdf.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobAppParamsPDFV2",
"type": "Type",
"tags": [],
"label": "JobAppParamsPDFV2",
"description": [],
"signature": [
"{ title: string; layout: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; }; objectType: string; locatorParams: ",
"LocatorParams",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">[]; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/printable_pdf_v2.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsCSV",
"type": "Type",
"tags": [],
"label": "JobParamsCSV",
"description": [],
"signature": [
"BaseParamsCSV & { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsPDF",
"type": "Type",
"tags": [],
"label": "JobParamsPDF",
"description": [],
"signature": [
"BaseParamsPDF & { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/printable_pdf.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsPDFV2",
"type": "Type",
"tags": [],
"label": "JobParamsPDFV2",
"description": [],
"signature": [
"BaseParamsPDFV2 & { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/printable_pdf_v2.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-public.JobParamsPNG",
"type": "Type",
"tags": [],
"label": "JobParamsPNG",
"description": [],
"signature": [
"BaseParamsPNG & { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/png.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [], "objects": [],
"start": { "start": {
"parentPluginId": "reporting", "parentPluginId": "reporting",
@ -2351,179 +2070,6 @@
], ],
"functions": [], "functions": [],
"interfaces": [ "interfaces": [
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsDownloadCSV",
"type": "Interface",
"tags": [],
"label": "JobParamsDownloadCSV",
"description": [],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsDownloadCSV.browserTimezone",
"type": "string",
"tags": [],
"label": "browserTimezone",
"description": [],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false
},
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsDownloadCSV.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false
},
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsDownloadCSV.searchSource",
"type": "Object",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
"{ type?: string | undefined; query?: ",
"Query",
" | undefined; filter?: ",
"Filter",
"[] | undefined; sort?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.EsQuerySortValue",
"text": "EsQuerySortValue"
},
"[] | undefined; highlight?: ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; highlightAll?: boolean | undefined; trackTotalHits?: number | boolean | undefined; aggs?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; schema?: string | undefined; }[] | undefined; from?: number | undefined; size?: number | undefined; source?: boolean | ",
"Fields",
" | undefined; version?: boolean | undefined; fields?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchFieldValue",
"text": "SearchFieldValue"
},
"[] | undefined; fieldsFromSource?: ",
"Fields",
" | undefined; index?: string | undefined; searchAfter?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.EsQuerySearchAfter",
"text": "EsQuerySearchAfter"
},
" | undefined; timeout?: string | undefined; terminate_after?: number | undefined; parent?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SerializedSearchSourceFields",
"text": "SerializedSearchSourceFields"
},
" | undefined; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false
},
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsDownloadCSV.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource_immediate.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsPNGV2",
"type": "Interface",
"tags": [],
"label": "JobParamsPNGV2",
"description": [],
"signature": [
"JobParamsPNGV2",
" extends { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/png_v2.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsPNGV2.layout",
"type": "Object",
"tags": [],
"label": "layout",
"description": [],
"signature": [
"{ id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/png_v2.ts",
"deprecated": false
},
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsPNGV2.locatorParams",
"type": "Object",
"tags": [],
"label": "locatorParams",
"description": [
"\nThis value is used to re-create the same visual state as when the report was requested as well as navigate to the correct page."
],
"signature": [
"LocatorParams",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "x-pack/plugins/reporting/common/types/export_types/png_v2.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{ {
"parentPluginId": "reporting", "parentPluginId": "reporting",
"id": "def-server.ReportingConfig", "id": "def-server.ReportingConfig",
@ -2781,72 +2327,7 @@
} }
], ],
"enums": [], "enums": [],
"misc": [ "misc": [],
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsCSV",
"type": "Type",
"tags": [],
"label": "JobParamsCSV",
"description": [],
"signature": [
"BaseParamsCSV & { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/csv_searchsource.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsPDF",
"type": "Type",
"tags": [],
"label": "JobParamsPDF",
"description": [],
"signature": [
"BaseParamsPDF & { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/printable_pdf.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsPDFV2",
"type": "Type",
"tags": [],
"label": "JobParamsPDFV2",
"description": [],
"signature": [
"BaseParamsPDFV2 & { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/printable_pdf_v2.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-server.JobParamsPNG",
"type": "Type",
"tags": [],
"label": "JobParamsPNG",
"description": [],
"signature": [
"BaseParamsPNG & { layout?: { id?: string | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<",
"LayoutSelectorDictionary",
"> | undefined; zoom?: number | undefined; } | undefined; objectType: string; title: string; browserTimezone: string; version: string; }"
],
"path": "x-pack/plugins/reporting/common/types/export_types/png.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [], "objects": [],
"start": { "start": {
"parentPluginId": "reporting", "parentPluginId": "reporting",
@ -2879,214 +2360,7 @@
} }
}, },
"common": { "common": {
"classes": [ "classes": [],
{
"parentPluginId": "reporting",
"id": "def-common.CancellationToken",
"type": "Class",
"tags": [],
"label": "CancellationToken",
"description": [],
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-common.CancellationToken.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-common.CancellationToken.on",
"type": "Function",
"tags": [],
"label": "on",
"description": [],
"signature": [
"(callback: Function) => void"
],
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-common.CancellationToken.on.$1",
"type": "Object",
"tags": [],
"label": "callback",
"description": [],
"signature": [
"Function"
],
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-common.CancellationToken.cancel",
"type": "Function",
"tags": [],
"label": "cancel",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-common.CancellationToken.isCancelled",
"type": "Function",
"tags": [],
"label": "isCancelled",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/reporting/common/cancellation_token.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "reporting",
"id": "def-common.Poller",
"type": "Class",
"tags": [],
"label": "Poller",
"description": [],
"path": "x-pack/plugins/reporting/common/poller.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-common.Poller.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/reporting/common/poller.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "reporting",
"id": "def-common.Poller.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"PollerOptions"
],
"path": "x-pack/plugins/reporting/common/poller.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-common.Poller.getPollFrequency",
"type": "Function",
"tags": [],
"label": "getPollFrequency",
"description": [],
"signature": [
"() => number"
],
"path": "x-pack/plugins/reporting/common/poller.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-common.Poller._poll",
"type": "Function",
"tags": [],
"label": "_poll",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "x-pack/plugins/reporting/common/poller.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-common.Poller.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/reporting/common/poller.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-common.Poller.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/reporting/common/poller.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "reporting",
"id": "def-common.Poller.isRunning",
"type": "Function",
"tags": [],
"label": "isRunning",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/reporting/common/poller.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [], "functions": [],
"interfaces": [], "interfaces": [],
"enums": [], "enums": [],

16
api_docs/reporting.mdx
View file

@ -18,7 +18,7 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 166 | 0 | 163 | 15 | | 126 | 0 | 125 | 13 |
## Client ## Client
@ -28,12 +28,6 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana
### Classes ### Classes
<DocDefinitionList data={reportingObj.client.classes}/> <DocDefinitionList data={reportingObj.client.classes}/>
### Interfaces
<DocDefinitionList data={reportingObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={reportingObj.client.misc}/>
## Server ## Server
### Start ### Start
@ -45,11 +39,3 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana
### Interfaces ### Interfaces
<DocDefinitionList data={reportingObj.server.interfaces}/> <DocDefinitionList data={reportingObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={reportingObj.server.misc}/>
## Common
### Classes
<DocDefinitionList data={reportingObj.common.classes}/>

32
api_docs/rule_registry.json
View file

@ -864,13 +864,7 @@
"description": [], "description": [],
"signature": [ "signature": [
"(featureId: ", "(featureId: ",
{ "AlertConsumers",
"pluginId": "@kbn/rule-data-utils",
"scope": "server",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-server.AlertConsumers",
"text": "AlertConsumers"
},
", dataset?: ", ", dataset?: ",
{ {
"pluginId": "ruleRegistry", "pluginId": "ruleRegistry",
@ -894,13 +888,7 @@
"label": "featureId", "label": "featureId",
"description": [], "description": [],
"signature": [ "signature": [
{ "AlertConsumers"
"pluginId": "@kbn/rule-data-utils",
"scope": "server",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-server.AlertConsumers",
"text": "AlertConsumers"
}
], ],
"path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false, "deprecated": false,
@ -2385,13 +2373,7 @@
], ],
"signature": [ "signature": [
"(featureId: ", "(featureId: ",
{ "AlertConsumers",
"pluginId": "@kbn/rule-data-utils",
"scope": "server",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-server.AlertConsumers",
"text": "AlertConsumers"
},
", dataset?: ", ", dataset?: ",
{ {
"pluginId": "ruleRegistry", "pluginId": "ruleRegistry",
@ -2415,13 +2397,7 @@
"label": "featureId", "label": "featureId",
"description": [], "description": [],
"signature": [ "signature": [
{ "AlertConsumers"
"pluginId": "@kbn/rule-data-utils",
"scope": "server",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-server.AlertConsumers",
"text": "AlertConsumers"
}
], ],
"path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts",
"deprecated": false, "deprecated": false,

4
api_docs/security_solution.json
View file

@ -62,7 +62,7 @@
"label": "experimentalFeatures", "label": "experimentalFeatures",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly metricsEntitiesEnabled: boolean; readonly ruleRegistryEnabled: boolean; readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly trustedAppsByPolicyEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly uebaEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; }" "{ readonly metricsEntitiesEnabled: boolean; readonly ruleRegistryEnabled: boolean; readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly trustedAppsByPolicyEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly uebaEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly securityRulesCancelEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; }"
], ],
"path": "x-pack/plugins/security_solution/public/plugin.tsx", "path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false "deprecated": false
@ -889,7 +889,7 @@
"signature": [ "signature": [
"Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; ruleExecutionLog: Readonly<{} & { underlyingClient: ", "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; ruleExecutionLog: Readonly<{} & { underlyingClient: ",
"UnderlyingLogClient", "UnderlyingLogClient",
"; }>; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ metricsEntitiesEnabled: boolean; ruleRegistryEnabled: boolean; tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; trustedAppsByPolicyEnabled: boolean; excludePoliciesInFilterEnabled: boolean; uebaEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; pendingActionResponsesWithAck: boolean; }>; }" "; }>; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ metricsEntitiesEnabled: boolean; ruleRegistryEnabled: boolean; tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; trustedAppsByPolicyEnabled: boolean; excludePoliciesInFilterEnabled: boolean; uebaEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; securityRulesCancelEnabled: boolean; pendingActionResponsesWithAck: boolean; }>; }"
], ],
"path": "x-pack/plugins/security_solution/server/config.ts", "path": "x-pack/plugins/security_solution/server/config.ts",
"deprecated": false, "deprecated": false,

2
api_docs/usage_collection.json
View file

@ -679,7 +679,7 @@
"\nPossible type values in the schema" "\nPossible type values in the schema"
], ],
"signature": [ "signature": [
"\"boolean\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"text\" | \"short\" | \"float\" | \"integer\" | \"byte\"" "\"boolean\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"text\" | \"integer\" | \"short\" | \"byte\" | \"float\""
], ],
"path": "src/plugins/usage_collection/server/collector/types.ts", "path": "src/plugins/usage_collection/server/collector/types.ts",
"deprecated": false, "deprecated": false,

14
packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts
View file

@ -14,7 +14,7 @@ import { REPO_ROOT } from '@kbn/utils';
import { Project } from 'ts-morph'; import { Project } from 'ts-morph';
import { writePluginDocs } from './mdx/write_plugin_mdx_docs'; import { writePluginDocs } from './mdx/write_plugin_mdx_docs';
import { ApiDeclaration, PluginMetaInfo } from './types'; import { ApiDeclaration, ApiStats, PluginMetaInfo } from './types';
import { findPlugins } from './find_plugins'; import { findPlugins } from './find_plugins';
import { pathsOutsideScopes } from './build_api_declarations/utils'; import { pathsOutsideScopes } from './build_api_declarations/utils';
import { getPluginApiMap } from './get_plugin_api_map'; import { getPluginApiMap } from './get_plugin_api_map';
@ -70,7 +70,7 @@ export function runBuildApiDocsCli() {
} }
const collectReferences = flags.references as boolean; const collectReferences = flags.references as boolean;
const { pluginApiMap, missingApiItems, unReferencedDeprecations, referencedDeprecations } = const { pluginApiMap, missingApiItems, unreferencedDeprecations, referencedDeprecations } =
getPluginApiMap(project, plugins, log, { getPluginApiMap(project, plugins, log, {
collectReferences, collectReferences,
pluginFilter: pluginFilter as string[], pluginFilter: pluginFilter as string[],
@ -88,7 +88,7 @@ export function runBuildApiDocsCli() {
isPlugin: plugin.isPlugin, isPlugin: plugin.isPlugin,
}; };
return acc; return acc;
}, {} as { [key: string]: PluginMetaInfo }); }, {} as { [key: string]: PluginMetaInfo & ApiStats });
writePluginDirectoryDoc(outputFolder, pluginApiMap, allPluginStats, log); writePluginDirectoryDoc(outputFolder, pluginApiMap, allPluginStats, log);
@ -106,6 +106,12 @@ export function runBuildApiDocsCli() {
const pluginTeam = plugin.manifest.owner.name; const pluginTeam = plugin.manifest.owner.name;
reporter.metrics([ reporter.metrics([
{
id,
meta: { pluginTeam },
group: 'Unreferenced deprecated APIs',
value: unreferencedDeprecations[id] ? unreferencedDeprecations[id].length : 0,
},
{ {
id, id,
meta: { pluginTeam }, meta: { pluginTeam },
@ -224,7 +230,7 @@ export function runBuildApiDocsCli() {
writeDeprecationDocByApi( writeDeprecationDocByApi(
outputFolder, outputFolder,
referencedDeprecations, referencedDeprecations,
unReferencedDeprecations, unreferencedDeprecations,
log log
); );
}); });

20
packages/kbn-docs-utils/src/api_docs/get_plugin_api_map.ts
View file

@ -15,6 +15,7 @@ import {
PluginApi, PluginApi,
PluginOrPackage, PluginOrPackage,
ReferencedDeprecationsByPlugin, ReferencedDeprecationsByPlugin,
UnreferencedDeprecationsByPlugin,
} from './types'; } from './types';
import { removeBrokenLinks } from './utils'; import { removeBrokenLinks } from './utils';
@ -27,7 +28,7 @@ export function getPluginApiMap(
pluginApiMap: { [key: string]: PluginApi }; pluginApiMap: { [key: string]: PluginApi };
missingApiItems: MissingApiItemMap; missingApiItems: MissingApiItemMap;
referencedDeprecations: ReferencedDeprecationsByPlugin; referencedDeprecations: ReferencedDeprecationsByPlugin;
unReferencedDeprecations: ApiDeclaration[]; unreferencedDeprecations: UnreferencedDeprecationsByPlugin;
} { } {
log.debug('Building plugin API map, getting missing comments, and collecting deprecations...'); log.debug('Building plugin API map, getting missing comments, and collecting deprecations...');
const pluginApiMap: { [key: string]: PluginApi } = {}; const pluginApiMap: { [key: string]: PluginApi } = {};
@ -47,21 +48,21 @@ export function getPluginApiMap(
const missingApiItems: { [key: string]: { [key: string]: string[] } } = {}; const missingApiItems: { [key: string]: { [key: string]: string[] } } = {};
const referencedDeprecations: ReferencedDeprecationsByPlugin = {}; const referencedDeprecations: ReferencedDeprecationsByPlugin = {};
const unReferencedDeprecations: ApiDeclaration[] = []; const unreferencedDeprecations: UnreferencedDeprecationsByPlugin = {};
plugins.forEach((plugin) => { plugins.forEach((plugin) => {
const id = plugin.manifest.id; const id = plugin.manifest.id;
const pluginApi = pluginApiMap[id]; const pluginApi = pluginApiMap[id];
removeBrokenLinks(pluginApi, missingApiItems, pluginApiMap, log); removeBrokenLinks(pluginApi, missingApiItems, pluginApiMap, log);
collectDeprecations(pluginApi, referencedDeprecations, unReferencedDeprecations); collectDeprecations(pluginApi, referencedDeprecations, unreferencedDeprecations);
}); });
return { pluginApiMap, missingApiItems, referencedDeprecations, unReferencedDeprecations }; return { pluginApiMap, missingApiItems, referencedDeprecations, unreferencedDeprecations };
} }
function collectDeprecations( function collectDeprecations(
pluginApi: PluginApi, pluginApi: PluginApi,
referencedDeprecations: ReferencedDeprecationsByPlugin, referencedDeprecations: ReferencedDeprecationsByPlugin,
unReferencedDeprecations: ApiDeclaration[] unReferencedDeprecations: UnreferencedDeprecationsByPlugin
) { ) {
(['client', 'common', 'server'] as Array<'client' | 'server' | 'common'>).forEach((scope) => { (['client', 'common', 'server'] as Array<'client' | 'server' | 'common'>).forEach((scope) => {
pluginApi[scope].forEach((api) => { pluginApi[scope].forEach((api) => {
@ -73,7 +74,7 @@ function collectDeprecations(
function collectDeprecationsForApi( function collectDeprecationsForApi(
api: ApiDeclaration, api: ApiDeclaration,
referencedDeprecations: ReferencedDeprecationsByPlugin, referencedDeprecations: ReferencedDeprecationsByPlugin,
unReferencedDeprecations: ApiDeclaration[] unreferencedDeprecations: UnreferencedDeprecationsByPlugin
) { ) {
if ((api.tags || []).find((tag) => tag === 'deprecated')) { if ((api.tags || []).find((tag) => tag === 'deprecated')) {
if (api.references && api.references.length > 0) { if (api.references && api.references.length > 0) {
@ -87,12 +88,15 @@ function collectDeprecationsForApi(
}); });
}); });
} else { } else {
unReferencedDeprecations.push(api); if (unreferencedDeprecations[api.parentPluginId] === undefined) {
unreferencedDeprecations[api.parentPluginId] = [];
}
unreferencedDeprecations[api.parentPluginId].push(api);
} }
} }
if (api.children) { if (api.children) {
api.children.forEach((child) => api.children.forEach((child) =>
collectDeprecationsForApi(child, referencedDeprecations, unReferencedDeprecations) collectDeprecationsForApi(child, referencedDeprecations, unreferencedDeprecations)
); );
} }
} }

16
packages/kbn-docs-utils/src/api_docs/mdx/write_deprecations_doc_by_api.ts
View file

@ -11,17 +11,17 @@ import dedent from 'dedent';
import fs from 'fs'; import fs from 'fs';
import Path from 'path'; import Path from 'path';
import { import {
ApiDeclaration,
ApiReference, ApiReference,
ReferencedDeprecationsByAPI, ReferencedDeprecationsByAPI,
ReferencedDeprecationsByPlugin, ReferencedDeprecationsByPlugin,
UnreferencedDeprecationsByPlugin,
} from '../types'; } from '../types';
import { getPluginApiDocId } from '../utils'; import { getPluginApiDocId } from '../utils';
export function writeDeprecationDocByApi( export function writeDeprecationDocByApi(
folder: string, folder: string,
deprecationsByPlugin: ReferencedDeprecationsByPlugin, deprecationsByPlugin: ReferencedDeprecationsByPlugin,
unReferencedDeprecations: ApiDeclaration[], unReferencedDeprecations: UnreferencedDeprecationsByPlugin,
log: ToolingLog log: ToolingLog
): void { ): void {
const deprecationReferencesByApi = Object.values(deprecationsByPlugin).reduce( const deprecationReferencesByApi = Object.values(deprecationsByPlugin).reduce(
@ -92,14 +92,18 @@ ${tableMdx}
Safe to remove. Safe to remove.
| Deprecated API | | Deprecated API | Plugin Id |
| ---------------| | ---------------|------------|
${unReferencedDeprecations ${Object.values(unReferencedDeprecations)
.map((apis) =>
apis
.map( .map(
(api) => (api) =>
`| <DocLink id="${getPluginApiDocId(api.parentPluginId)}" section="${api.id}" text="${ `| <DocLink id="${getPluginApiDocId(api.parentPluginId)}" section="${api.id}" text="${
api.label api.label
}"/> |` }"/> | ${api.parentPluginId} | `
)
.join('\n')
) )
.join('\n')} .join('\n')}

1
packages/kbn-docs-utils/src/api_docs/stats.ts
View file

@ -25,6 +25,7 @@ export function collectApiStatsForPlugin(
isAnyType: [], isAnyType: [],
noReferences: [], noReferences: [],
deprecatedAPIsReferencedCount: 0, deprecatedAPIsReferencedCount: 0,
unreferencedDeprecatedApisCount: 0,
apiCount: countApiForPlugin(doc), apiCount: countApiForPlugin(doc),
missingExports: Object.values(missingApiItems[doc.id] ?? {}).length, missingExports: Object.values(missingApiItems[doc.id] ?? {}).length,
}; };

6
packages/kbn-docs-utils/src/api_docs/types.ts
View file

@ -234,6 +234,11 @@ export interface ReferencedDeprecationsByPlugin {
[key: string]: Array<{ deprecatedApi: ApiDeclaration; ref: ApiReference }>; [key: string]: Array<{ deprecatedApi: ApiDeclaration; ref: ApiReference }>;
} }
export interface UnreferencedDeprecationsByPlugin {
// Key is the plugin id.
[key: string]: ApiDeclaration[];
}
// A mapping of deprecated API id to the places that are still referencing it. // A mapping of deprecated API id to the places that are still referencing it.
export interface ReferencedDeprecationsByAPI { export interface ReferencedDeprecationsByAPI {
[key: string]: { deprecatedApi: ApiDeclaration; references: ApiReference[] }; [key: string]: { deprecatedApi: ApiDeclaration; references: ApiReference[] };
@ -246,6 +251,7 @@ export interface ApiStats {
apiCount: number; apiCount: number;
missingExports: number; missingExports: number;
deprecatedAPIsReferencedCount: number; deprecatedAPIsReferencedCount: number;
unreferencedDeprecatedApisCount: number;
} }
export type PluginMetaInfo = ApiStats & { export type PluginMetaInfo = ApiStats & {